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
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,10 @@ rpg-cli is a bare-bones [JRPG](https://en.wikipedia.org/wiki/JRPG)-inspired term
6
6
7
7
Features:
8
8
9
+
* Character stats and leveling system.
9
10
* Automatic turn-based combat.
11
+
* Item and equipment support.
10
12
* 15+ enemy classes.
11
-
* Character stats and leveling system.
12
-
* Basic item and equipment support.
13
13
* Permadeath with item recovering.
14
14
* Run and bribe to escape battles.
15
15
@@ -33,8 +33,7 @@ Note that at the current time of writing, the package hasn't hit any of the chan
33
33
### Shell integration (recommended)
34
34
35
35
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:
38
37
39
38
```sh
40
39
rpg () {
@@ -43,7 +42,7 @@ rpg () {
43
42
}
44
43
```
45
44
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`:
47
46
48
47
```sh
49
48
cd () {
@@ -73,7 +72,7 @@ The first time you run the program, a new hero is created at the user's home dir
73
72
item:{}
74
73
0g
75
74
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:
77
76
78
77
~ $ rpg cd dev/
79
78
~/dev $ rpg
@@ -85,7 +84,7 @@ When running without parameters, as above, the hero status is printed (health po
85
84
item:{}
86
85
0g
87
86
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,
89
88
and both characters will engage in battle:
90
89
91
90
~/dev $ rpg cd facundoolano/
@@ -124,9 +123,9 @@ Also at the home directory, you can buy items and equipment:
124
123
item:{potion[1]x1}
125
124
75g
126
125
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`.
128
127
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.
130
129
131
130
~ $ rpg cd ~/dev/facundoolano/rpg-cli/target/debug/examples/
132
131
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
138
137
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,
0 commit comments