You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-12Lines changed: 28 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,38 +10,39 @@ Features:
10
10
* Automatic turn-based combat.
11
11
* Item and equipment support.
12
12
* 15+ enemy classes.
13
+
* Quests to-do list.
13
14
* Chests hidden in directories.
14
15
* Permadeath with item recovering.
15
16
* Run and bribe to escape battles.
16
17
17
-
## Setup
18
+
## Installation
18
19
19
-
### Installing from binary
20
+
### From binary
20
21
21
22
Just download the binary for your platform (linux/macOS/windows) from the [GitHub releases page](https://github.com/facundoolano/rpg-cli/releases/latest).
22
23
23
-
### Installing with Cargo
24
+
### Using Cargo
24
25
Assuming you have [Rust and Cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo):
25
26
26
-
$ cargo install --git https://github.com/facundoolano/rpg-cli --force --branch main
The binary should be available as `rpg-cli` (assuming you have `~/.cargo/bin` in your `$PATH`).
29
30
30
-
### Installing with homebrew
31
+
### Using homebrew (macOS)
31
32
You can use homebrew to install the binary on macOS::
32
33
33
34
$ brew install rpg-cli
34
35
35
-
### Installing with nixpkgs
36
+
### Using nixpkgs
36
37
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`.
37
38
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.
38
39
39
-
### Installing with portage (Gentoo)
40
+
### Using portage (Gentoo)
40
41
If you use Gentoo, you can get rpg-cli from portage:
41
42
42
43
# emerge -av games-rpg/rpg-cli
43
44
44
-
###Shell integration (recommended)
45
+
## Shell integration (recommended)
45
46
46
47
The game is designed to integrate with common file system operations, such as changing directories or deleting files.
47
48
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 () {
64
65
65
66
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.
66
67
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
-
71
68
## Usage
72
69
73
70
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:
138
135
139
136
The shortcut `rpg b p` would also work above. The item can then be used as `rpg use potion`.
140
137
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
+
141
153
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.
142
154
143
155
~ $ rpg cd ~/dev/facundoolano/rpg-cli/target/debug/examples/
@@ -157,3 +169,7 @@ you can recover gold, items and equipment:
157
169
158
170
159
171
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.
0 commit comments