[![dependency status](https://deps.rs/repo/codeberg/zvavybir/hyperrogue/status.svg)](https://deps.rs/repo/codeberg/zvavybir/hyperrogue)

# hypersave

## Adding a safe feature to hyperrogue

Hyperrogue is an awesome educational game for teaching hyperbolic
geometry, but sadly due to it being roguelike it (intentionally!)
has only a crippled save feature.  This crate fixes this.  After
installing it you can call `save` after having clicked "Save" in
hyperrogue and `restore` after quitting after an game over.

## Installing
As all rust programs on crates.io this program to is installed
with
```shell
cargo install hypersave
```
This creates the two binaries `save` and `restore`, which are
pretty general name.  If you want to change these, you can use
your file manager or use commands like this:
```shell
mv ~/.cargo/bin/save ~/.cargo/bin/insert-your-name-for-the-save-binary-here
mv ~/.cargo/bin/restore ~/.cargo/bin/insert-your-name-for-the-restore-binary-here
```

## Profiles
You can start a new play through with the concept of profiles.
With `save name-of-your-old-play-through` you save your current
play through to the given name which you can restore later again
with `restore name-of-your-old-play-through`.

License: GPL-3.0-or-later