The game logic for the Gotchi Battler game
npm install gotchi-battler-game-logicThis npm module contains the game logic for the Gotchi Battler game developed by Galaxy Brain Studios.
It has been split out into an npm module for two reasons:
1. So that it can be used in both the frontend and backend of the Gotchi Battler game. This allows heavy simulations and training to be done on the frontend (users browser), to reduce server load, and in the backend when provable randomness is needed (e.g. for tournaments)
2. So that users can download this repository and verify the results of the game logic run in the backend to prove that the game is fair and that the results are not manipulated. See the Validate Tournament section for more details.
To install the module, run the following command:
``
npm install gotchi-battler-game-logic
To use the module in your project, import it as follows:
`javascript
const { battle } = require('gotchi-battler-game-logic')
// team1 and team2 an in-game team objects (see below)
// seed is a random seed for the game
const result = battle(team1, team2, seed)
`
The schema for the in-game team object can be found in
Examples of the in-game team object can be found in /scripts/data/team1.json and /scripts/data/team2.json
The validate tournament script does the following:
- Fetches the data of a tournament from the Gotchi Battler website
- Loops through all the battles in the tournament, bracket by bracket, round by round
- For each battle, the logs are fetched from the Gotchi Battler website
- The battle is then simulated locally using the game logic
- The result of this simulation is then compared to the logs from the Gotchi Battler website
To validate the battles from the RF8 100K Tournament, run the following command:
`bash``
node scripts/validateTournament.js 15
Get the tournament id from the URL of the tournament page on the Gotchi Battler website.
PLEASE NOTE:
- Currently, only the tournaments from Rarity Farming season 8 and 9 are supported (Tournament IDs 13-15 + 18)
- The script can take a while to run, in local testing it took around 20 minutes