Skip to content

Commit 9ae3ddd

Browse files
committed
README updates
1 parent bc1060c commit 9ae3ddd

2 files changed

Lines changed: 28 additions & 12 deletions

File tree

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,39 @@ Features:
1010
* Automatic turn-based combat.
1111
* Item and equipment support.
1212
* 15+ enemy classes.
13+
* Quests to-do list.
1314
* Chests hidden in directories.
1415
* Permadeath with item recovering.
1516
* Run and bribe to escape battles.
1617

17-
## Setup
18+
## Installation
1819

19-
### Installing from binary
20+
### From binary
2021

2122
Just download the binary for your platform (linux/macOS/windows) from the [GitHub releases page](https://github.com/facundoolano/rpg-cli/releases/latest).
2223

23-
### Installing with Cargo
24+
### Using Cargo
2425
Assuming you have [Rust and Cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo):
2526

26-
$ cargo install --git https://github.com/facundoolano/rpg-cli --force --branch main
27+
$ cargo install --git https://github.com/facundoolano/rpg-cli --force --tag 0.4.1
2728

2829
The binary should be available as `rpg-cli` (assuming you have `~/.cargo/bin` in your `$PATH`).
2930

30-
### Installing with homebrew
31+
### Using homebrew (macOS)
3132
You can use homebrew to install the binary on macOS::
3233

3334
$ brew install rpg-cli
3435

35-
### Installing with nixpkgs
36+
### Using nixpkgs
3637
If you use nix/nixos you can get rpg-cli from nixpkgs, either install it by adding it to your system config, installing it with `nix-env -i rpg-cli` or try it in a ephemeral shell with `nix-shell -p rpg-cli`.
3738
Note that at the current time of writing, the package hasn't hit any of the channels yet. When you try it, check that it's in your channel.
3839

39-
### Installing with portage (Gentoo)
40+
### Using portage (Gentoo)
4041
If you use Gentoo, you can get rpg-cli from portage:
4142

4243
# emerge -av games-rpg/rpg-cli
4344

44-
### Shell integration (recommended)
45+
## Shell integration (recommended)
4546

4647
The game is designed to integrate with common file system operations, such as changing directories or deleting files.
4748
The most basic type of integration consists in wrapping rpg-cli in a shell function, such that the working directory is updated to match the hero's progress, effectively working as a `cd` alternative:
@@ -64,10 +65,6 @@ cd () {
6465

6566
Other commands like `rm`, `mkdir`, `touch`, etc. can also be aliased. Check [this example](shell/example.sh) and the [shell integration guide](shell/README.md) for more sophisticated examples, as well as their fish shell equivalents.
6667

67-
### Troubleshooting
68-
69-
* The release binary for macOS [is not signed](https://github.com/facundoolano/rpg-cli/issues/27). To open it for the first time, right click on the binary and select "Open" from the menu.
70-
7168
## Usage
7269

7370
This example session assumes a basic `rpg` function as described in the previous section.
@@ -138,6 +135,21 @@ Also at the home directory, you can buy items and equipment:
138135

139136
The shortcut `rpg b p` would also work above. The item can then be used as `rpg use potion`.
140137

138+
Some directories have hidden treasure chests that you can find with `rpg ls`:
139+
140+
~ $ rpg ls
141+
📦 +potionx2
142+
143+
The `rpg todo` command will display a list of quest for your hero:
144+
145+
~ $ rpg todo
146+
□ buy a sword
147+
□ use a potion
148+
□ reach level 2
149+
✔ win a battle
150+
151+
Each time you complete an item on the list, you will receive a reward. The quests renew as your level raises, so be sure to check often!
152+
141153
The further from home you move the hero, the tougher the enemies will get. If you go to far or too long without restoring your health, your hero is likely to die in battle, causing the game to restart at the home directory.
142154

143155
~ $ rpg cd ~/dev/facundoolano/rpg-cli/target/debug/examples/
@@ -157,3 +169,7 @@ you can recover gold, items and equipment:
157169

158170

159171
Try `rpg --help` for more options and check the [shell integration guide](shell/README.md) for ideas to adapt the game to your preferences.
172+
173+
## Troubleshooting
174+
175+
* The release binary for macOS [is not signed](https://github.com/facundoolano/rpg-cli/issues/27). To open it for the first time, right click on the binary and select "Open" from the menu.

rpg-cli.png

-294 KB
Loading

0 commit comments

Comments
 (0)