Skip to content

Fix typo in bonus mode description in quickstart.md #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JCCourt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typo in bonus mode description in quickstart.md #104

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/math_docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ In the terminal you should seethe game RTP printed out as each thread finishes
```shell
Thread 0 finished with 1.632 RTP. [baseGame: 0.043, freeGame: 1.588]
```
Flor the `bonus` mode, this is telling us that thread 0/10 finished with a total RTP of 163.2%, with 4.3% coming from the basegame (wins on the reveal of Scatter symbols), and 158.8% RTP coming from freegame wins. This is higher than our expected 97%, though we are forcing significantly more max-win simulations than will naturally be awarded, so this is okay. The optimization algorithm will adjust these weights to balance the game properly.
For the `bonus` mode, this is telling us that thread 0/10 finished with a total RTP of 163.2%, with 4.3% coming from the basegame (wins on the reveal of Scatter symbols), and 158.8% RTP coming from freegame wins. This is higher than our expected 97%, though we are forcing significantly more max-win simulations than will naturally be awarded, so this is okay. The optimization algorithm will adjust these weights to balance the game properly.


By setting `run_analysis: True` we are indicating that we would like to generate a PAR sheet, summarizing key game statistics and hit-rates. This program will use the `library/lookup_tables/lookUpTableSegmented_<mode>.csv` file to determine which game-types contributed to the final round wins, in conjunction with the pay-table and `library/forces/force_record_<mode>.json` files to generate frequency and average-win statistics for specific events or win combinations.
Expand All @@ -122,4 +122,4 @@ By setting `run_analysis: True` we are indicating that we would like to generate
## Next steps

These outputs corresponding directly with example Storybook packages within the `web-sdk`. It is recommended to take look through this pack to see how these math events are passed and displayed on the frontend.
If you have your own game in mind you can use one of the sample games provided as a template and implement your own unique rules within the `games/<game_name>/` directory. You will likely need to specify configuration values for things like multipliers, prize-value etc.. wtihin `game_config.py`. Then any unique calculations and events should be handled within the games `game_executables/game_calculation` files. Generally speaking, reusable functions, events or calculation should like with `/src/`, which one-off game functionality belongs within that games folder `/games/<game_id>/`.
If you have your own game in mind you can use one of the sample games provided as a template and implement your own unique rules within the `games/<game_name>/` directory. You will likely need to specify configuration values for things like multipliers, prize-value etc.. wtihin `game_config.py`. Then any unique calculations and events should be handled within the games `game_executables/game_calculation` files. Generally speaking, reusable functions, events or calculation should like with `/src/`, which one-off game functionality belongs within that games folder `/games/<game_id>/`.