Skip to content

Commit

Permalink
docs: add features section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kleinfreund committed Jan 18, 2025
1 parent eea4c1c commit 0b6823a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@
> [!TIP]
> [Example score](https://balatrolator.com/?state=---1-1--5-___________-11*_*_*_*_*_*_*_*_*_*_*_*-50*******_122*******_126*****0*3*_69****12.25***_132*******_119****5.5***-0*3***2**1_0*3**4*2**1_0*3**4*2**1_0*3**4*2**1_0*3**4*2**1_0*3**2***_0*3**5*2**_0*3**5*2**_0*3***2**) showcasing a hand played by [haelian](https://twitch.tv/haelian) on 2024-02-26 18:13 (UTC).
## Features

- Game features: Supports all score-influencing game features (and has tests for a lot of them)
- Luck: Calculates worst case, average, and best case scores when odds are in play (read more below: [Tell me the odds: how probabilistic effects are handled](#tell-me-the-odds-how-probabilistic-effects-are-handled))
- Saves: Save hands in the browser and load them later to compare different hand variations. You can also export saves as JSON files and import them again.
- Share URLs: Share your score! The current hand is persisted in the URL and the saves.
- Quality of life: Duplicate jokers/playing cards or set their play count to input high-scoring endless game hands.

## Non-features

- No hand optimizations: the goal of this calculator is to predict/verify scores (i.e doing the math). I leave being clever to you. 🤡 (Also: I might change my mind on this. 🃏)

## Contributing

[Contribution guidelines for this project](CONTRIBUTING.md)
Expand Down

0 comments on commit 0b6823a

Please sign in to comment.