––> HOME <––

rpg-cli
a wonderful little role playing game in your shell

Table of Contents

1 What is rpg-cli?

rpg-cli is a really neat idea. You can find it on Github. It's a commandline client that changes the directories on your computer into dungeons in a rpg. Where you play the hero and as you walk through your directories to find monsters, enemies, potions or hidden chests, you can level up, do things like taking a potion or buy something in a shop. It is really minimalistic and you can even use it as a cd "replacement", so that whenever you use cd you explore the dungeons with your hero.

There are three different hero types:

  • warrior
  • mage
  • thief

from which you can choose.

I love it :>

1.1 Installation

Following the instructions, you can either use something like cargo to install it or downlaod the binary release from Github. If you take a closer look there are already repositories for the popular linux distributions like:

  • on Gentoo you can:

    emerge -av games-rpg/rpg-cli
    
  • or on an arch based system you could:

    pacman -Suy rpg-cli
    
  • there's even a homebrew binary:

    brew install rpg-cli
    

So as you can see there are many ways to install rpg-cli on your computer :)

1.2 Usage

There are different options how to use rpg-cli in the first place. You can use it as a standalone programm or you can use it as a cd "replacement" or rather add it to cd by changing the way you call cd. For example with a little function like this:

cd ()
{
  /home/youruser/.cargo/bin/rpg-cli cd "$@";
  builtin cd "$(rpg-cli pwd)"
}

The function replaces the execution of the built in cd (builtin cd) with running rpg-cli cd "$@" then runs the built in cd afterwards. Not the best way to do it but it kinda works :)

While playing rpg-cli you can easily see your todo list by running rpg-cli todo

$ rpg-cli todo
✔ win a battle
✔ buy a sword
✔ use a potion
✔ reach level 2
✔ Find a chest
✔ reach level 5
✔ beat all common creatures 5/5
□ visit the tomb of a fallen hero
□ equip a ring
□ reach level 10
□ beat all rare creatures 3/8
□ defeat an enemy 10 steps away from home
✔ raise 5 levels with class warrior 5/5

Or your stats:

$ rpg-cli stat
warrior[6]@home
  hp:[xxxxxxxxxx] 101/101
  mp:[----------] 0/0
  xp:[xxxx------] 141/440
  att:36   mag:0   def:12   spd:21
  equip:{sword[5],shield[5]}
  item:{}
5945g

or inspect something from your bag:

$ rpg-cli stat shield
shield[6]: increases defense by 14

very minimalistic and beautiful <3

1.3 Examples

Playing the game might look something like this:

$ cd /tmp/
snake[4][xxxx][----]@/
snake[4][xx--] -26hp
warrior[4][xxxx] dodged!
snake[4][----] -31hp
warrior[5][xxxx] +46xp +level +57g
warrior[5][xxxx][----][x---]@/
+500g quest completed!

You won a battle agains a snake and earned 46 experience points, 57 gold and leveled one level up…

$ rpg-cli ls
+potionx1
+200g quest completed!

By using rpg-cli ls you searched the dungeons and found a potion. By doing this you completed one thing of your todo list :)

$ cd /
snake[3][xxxx][----]@/
snake[3][x---] -35hp
warrior[5][xxxx] -15hp
snake[3][----] -35hp
warrior[5][xxxx] +13xp +65g
warrior[5][xxxx][----][x---]@/

…another snake and some more xp and gold :)

$ cd
slime[1][xxxx][----]@/home
slime[1][xxx-] -35hp
slime[1][x---] -32hp
slime[1][----] -28hp
warrior[5][xxxx] +15xp +62g
warrior[5][xxxx][----][x---]@/home
$ rpg-cli ls
+49g
$ rpg-cli stat
warrior[5]@/home
  hp:[xxxxxxxxx-] 79/94
  mp:[----------] 0/0
  xp:[x---------] 29/335
  att:29   mag:0   def:0   spd:20
  equip:{sword[1]}
  item:{potionx2}
  2850g
$ rpg-cli todo
✔ win a battle
□ buy a sword
□ use a potion
✔ reach level 2
✔ find a chest
✔ reach level 5
✔ beat all common creatures 5/5
□ visit the tomb of a fallen hero
□ equip a ring
□ reach level 10
□ beat all rare creatures 1/8
□ defeat an enemy 10 steps away from home

When checking your todo list you see that there is a todo named "buy a sword"…

$ rpg-cli buy
  sword[5]    2500g
  shield[5]   2500g
  potion[5]   1000g
  ether[5]    1250g
  remedy      400g
  escape      1000g

…you check if there is one available.

$ rpg-cli buy sword
  +100g quest completed!
  -2500g +swordx1

And buy that sword.

$ rpg-cli todo
✔ win a battle
✔ buy a sword
□ use a potion
✔ reach level 2
✔ find a chest
✔ reach level 5
✔ beat all common creatures 5/5
□ visit the tomb of a fallen hero
□ equip a ring
□ reach level 10
□ beat all rare creatures 1/8
□ defeat an enemy 10 steps away from home

And another todo completed. I guess you'll got a hint of what that game is about or how you can use it. I really like it and use it as a cd "replacement" :D

That's all folks!

Date: 2021-09-18 Fr 1:37