https://github.com/marviuz/gacha-js
A small simple library for simulating(?) Gacha games
https://github.com/marviuz/gacha-js
gacha gacha-game gacha-simulator javascript
Last synced: about 1 month ago
JSON representation
A small simple library for simulating(?) Gacha games
- Host: GitHub
- URL: https://github.com/marviuz/gacha-js
- Owner: Marviuz
- License: mit
- Created: 2022-09-07T11:16:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-07T12:23:18.000Z (almost 3 years ago)
- Last Synced: 2025-05-05T23:16:10.956Z (about 1 month ago)
- Topics: gacha, gacha-game, gacha-simulator, javascript
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GachaJS
A small simple library for simulating(?) Gacha games
_to get things straight... I only made this for personal use for my projects but you can also use it as you see fit._
## Getting Started
### Installation
Install directly from my github (Since it's a simple library, it doesn't need to be in the npm registry.)
```shell
$ npm i marviuz/gacha-js
```
### Usage
```js
const GachaJS = require('gacha-js'); // Hopefully it's actually like this >.<
const rates = {
ssr: 5.9,
sr: 12.8,
r: 18.8,
c: 62.5,
}; // Should total to 100%
const gacha = new GachaJS(rates);
// Set new rates
gacha.setRates({
ssr: 1.9,
sr: 16.8,
r: 18.8,
c: 62.5,
});
console.log(gacha.getRates());
// output: { ssr: 1.9, sr: 16.8, r: 18.8, c: 62.5 }
console.log(gacha.getPullByRarity());
// output: c <- Random
console.log(gacha.getPullByRarity(10)); // 10 pulls
// output is random array
// [
// 'r', 'sr', 'sr',
// 'r', 'c', 'r',
// 'c', 'c', 'c',
// 'c'
// ]
```
```js
const gacha = new GachaJS(
{
ssr: 5.9,
sr: 12.8,
r: 18.8,
c: 62.5,
},
{
collection: [
{ name: 'ssr1', rarity: 'ssr' },
{ name: 'ssr2', rarity: 'ssr' },
{ name: 'sr1', rarity: 'sr' },
{ name: 'sr2', rarity: 'sr' },
{ name: 'sr3', rarity: 'sr' },
{ name: 'r1', rarity: 'r' },
{ name: 'r2', rarity: 'r' },
{ name: 'r3', rarity: 'r' },
{ name: 'r4', rarity: 'r' },
{ name: 'c1', rarity: 'c' },
{ name: 'c2', rarity: 'c' },
{ name: 'c3', rarity: 'c' },
{ name: 'c4', rarity: 'c' },
{ name: 'c5', rarity: 'c' },
],
findKey: 'rarity',
}
);
// If collection is something like `{ name: 'c5', rarity: { r: 'c' } }` (Notice `the rarity: { r: 'c' }`)
// `findKey` can be `rarity.r`
console.log(gacha.getPullByCollection());
// output: { name: 'c1', rarity: 'c' } <- Random
console.log(gacha.getPullByCollection(10)); // 10 pulls
// output is random array
// [
// { name: 'r3', rarity: 'r' },
// { name: 'c1', rarity: 'c' },
// { name: 'r2', rarity: 'r' },
// { name: 'ssr2', rarity: 'ssr' },
// { name: 'c2', rarity: 'c' },
// { name: 'c2', rarity: 'c' },
// { name: 'c3', rarity: 'c' },
// { name: 'c4', rarity: 'c' },
// { name: 'c3', rarity: 'c' },
// { name: 'c2', rarity: 'c' }
// ]
```
## Contribute
If you wanna contribute (add features and stuff) you all know the github thingies... (I don't.. yeah not much.) I'll probably just accept every PR's `>.<`