Skip to content

Commit c3a37e7

Browse files
committed
readme fixes
1 parent f962cc7 commit c3a37e7

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ rpg-cli is a bare-bones [JRPG](https://en.wikipedia.org/wiki/JRPG)-inspired term
66

77
Features:
88

9+
* Character stats and leveling system.
910
* Automatic turn-based combat.
11+
* Item and equipment support.
1012
* 15+ enemy classes.
11-
* Character stats and leveling system.
12-
* Basic item and equipment support.
1313
* Permadeath with item recovering.
1414
* Run and bribe to escape battles.
1515

@@ -33,8 +33,7 @@ Note that at the current time of writing, the package hasn't hit any of the chan
3333
### Shell integration (recommended)
3434

3535
The game is designed to integrate with common file system operations, such as changing directories or deleting files.
36-
37-
The most basic type of integration consists in wrapping rpg-cli in a shell function, such that the working directory is updated to track to the hero's progress, effectively working as a `cd` alternative:
36+
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:
3837

3938
```sh
4039
rpg () {
@@ -43,7 +42,7 @@ rpg () {
4342
}
4443
```
4544

46-
Or, if you want to go all the way and *really* use it in place of `cd`:
45+
If you want to go all the way and *really* use it in place of `cd`:
4746

4847
```sh
4948
cd () {
@@ -73,7 +72,7 @@ The first time you run the program, a new hero is created at the user's home dir
7372
item:{}
7473
0g
7574

76-
When running without parameters, as above, the hero status is printed (health points, accumulated experience, etc.). If you pass in a path as parameter, that will instruct the hero to move:
75+
When running without parameters, as above, the hero status is printed (health points, accumulated experience, etc.). If you use the `cd` with a path as parameter, it will instruct the hero to move:
7776

7877
~ $ rpg cd dev/
7978
~/dev $ rpg
@@ -85,7 +84,7 @@ When running without parameters, as above, the hero status is printed (health po
8584
item:{}
8685
0g
8786

88-
In this case, the hero moved to `~/dev/facundoolano`. Sometimes enemies will appear as you move through the directories,
87+
In this case, the hero moved to `~/dev`. Sometimes enemies will appear as you move through the directories,
8988
and both characters will engage in battle:
9089

9190
~/dev $ rpg cd facundoolano/
@@ -124,9 +123,9 @@ Also at the home directory, you can buy items and equipment:
124123
item:{potion[1]x1}
125124
75g
126125

127-
The shortcut `rpg b p` would also work above.
126+
The shortcut `rpg b p` would also work above. The item can then be used as `rpg use potion`.
128127

129-
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.
128+
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.
130129

131130
~ $ rpg cd ~/dev/facundoolano/rpg-cli/target/debug/examples/
132131
orc[1][xxxx]@~/dev/facundoolano/rpg-cli
@@ -138,8 +137,8 @@ The further from home you move the hero, the tougher the enemies will get. If yo
138137
Death is permanent: you can't save your progress and reload after dying, but if you take your new hero to the location of the previous one's death,
139138
you can recover gold, items and equipment:
140139

141-
~ $ rpg ~/dev/facundoolano/rpg-cli/
140+
~ $ rpg cd -
142141
hero[🪦]@~/dev/facundoolano/rpg-cli/ +potionx1 +75g
143142

144143

145-
Try `rpg --help` for more options.
144+
Try `rpg --help` for more options and check the [shell integration guide](shell/README.md) for ideas to adapt the game to your preferences.

0 commit comments

Comments
 (0)