# Guess the Number: Epic Edition!

*Guess the Number: Epic Edition!* is a fresh take on the classic 'Guess the
Number' game, which all programmers have probably written at some point in
their lives.

## Installation

## From crates.io

```sh
cargo install gtn-epic
```

## From source

```sh
git clone https://codeberg.org/AeriaVelocity/gtn-epic.git
cd gtn-epic
cargo install --path .
```

## Gameplay

To start the game, run:

```sh
gtn-epic [options] # more about options down below
```

You'll be asked to guess a number between 1 and 100. If you guess the
correct number, you win. If you fail to guess the correct number, you'll be
told whether your guess is too high or too low.

Upon winning the game, you'll be told how many guesses it took you to win, and
you'll be assigned a rank based on your performance:

### Ranks

| Rank | Name | Condition |
| --- | --- | --- |
| SSS | SMOKIN SICK STYLE | 1 guess |
| SS | Soup Spoon | 2-5 guesses on reroll mode |
| S | Skilled | 2-5 guesses on normal mode, 6-10 guesses on reroll mode |
| A | Acceptable | 6-10 guesses on normal mode |
| B | Baffled | 11-40 guesses on normal mode, 41+ guesses on reroll mode |
| C | Cringe | 41+ guesses on reroll mode |
| D | Dumb | 41+ guesses on normal mode |
| ω | ωth place in a race | Cheat |

## Options

*Guess The Number: Epic Edition!* supports several options to change or
customise the game experience or parameters.

- **-h, --help**: Show a help message and exit.
- **--range=N**: Set the range of numbers to guess between 1 and N
  (default: 100).
- **--attempts=N**: Set the number of attempts to guess the number
  (default: ∞).
- **-o, --obscure**: Play the game in obscure mode. This mode will stop the game
  from telling you whether your guess is too high or too low.
- **-r, --reroll**: Play the game in reroll mode. This mode will randomise the
  number after every wrong attempt.
- **-c, --cheat**: Show the correct answer on startup. In reroll mode, this will
  show the correct answer after each wrong guess. This mode will prevent you
  from getting any ranks.

### Example

```sh
gtn-epic -r -c
Cheaterrrrr!!!!
Reroll Mode activated! Wrong guesses will randomise the number again!
Guess the number between 1 and 100!
(The correct number is 43.)
> 43
You guessed it! The number was 43.
It took you 1 guess... but that doesn't mean anything, you cheater!
Your rank is: ω (for ωth place in a race)
```

## Author

*Guess The Number: Epic Edition!* is a project by [Arsalan 'Aeri' Kazmi](https://aeriavelocity.codeberg.page).

## Licence

This project is licensed under the GNU General Public Licence v3.0 or, at your
option, any later version.

See [LICENCE.txt](https://github.com/AeriaVelocity/gtn-epic/blob/main/LICENCE.txt)
for the licence text.