README.md

Shell integration

To get the most out of rpg-cli, it is suggested to define aliases or wrapper functions so the game can be integrated into a regular shell session, with enemies appearing along the way.

This guide describes the basic building blocks to write such functions and shows some examples. See also the recommended setup.

Basic cd alternative

The default rpg-cli command works as cd, changing the hero's location from one directory to another. Since the program itself can't affect your shell session, you need to write a function so the working directory is changed to match that of the hero:

rpg () {
    rpg-cli "$@"
    cd "$(rpg-cli pwd)"
}

This assumes rpg-cli is in your path, update with the specific location if not. You can define it directly in your current session, add it to ~/.bashrc, source it from another script, etc.

If you use fish shell, update ~/.config/fish/config.fish instead:

function rpg
    rpg-cli $argv
    cd (rpg-cli pwd)
end

Full cd override

If you like having enemies popping up while using cd, you can override that instead of using a separate function:

cd () {
    rpg-cli cd "$@"
    builtin cd "$(rpg-cli pwd)"
}

ls override

The rpg-cli ls command looks for chests at the current location. It can be integrated to the regular ls like this:

ls () {
    command ls "$@"
    if [ $# -eq 0 ] ; then
        rpg-cli cd -f .
        rpg-cli ls
    fi
}

Arbitrary dungeon levels

After some time it can become tedious to find deep enough directories to level-up your character. This function will create new dungeon directories, cd into them and ls to look for chests:

dn () {
    current=$(basename $PWD)
    number_re='^[0-9]+$'

    if [[ $current =~ $number_re ]]; then
        next=$(($current + 1))
        command mkdir -p $next && cd $next && rpg ls
    elif [[ -d 1 ]] ; then
        cd 1 && rpg ls
    else
        command mkdir -p dungeon/1 && cd dungeon/1 && rpg ls
    fi
}

Having this function setup, the game can be played very conveniently with a combination of dn (to go down), cd (to go back up, or back home) and rpg (to show stats, use items, etc.).

Other customizations

Low-level commands

To better adapt for different usage patterns, finer-grained commands are provided:

• rpg-cli cd --force <path> will set the hero's location to <path> without initiating battles.
• rpg-cli pwd will print the hero's current location.
• rpg-cli battle will initiate a battle with a probability that changes based on the distance from home. If the battle is lost the exit code of the program will be non-negative.
• rpg-cli stat --quiet will return hero stats in a succinct format.
• rpg-cli stat --plain will return hero stats as tab separated fields, to facilitate parsing (e.g. to integrate to the prompt).

Aliasing other commands

Another way to use rpg-cli is to initiate battles when attempting to execute file-modifying operations. Only when the battle is won the operation is allowed:

alias rpg-battle="rpg-cli cd -f . && rpg-cli battle"

alias rm="rpg-battle && rm"
alias rmdir="rpg-battle && rmdir"
alias mkdir="rpg-battle && mkdir"
alias touch="rpg-battle && touch"
alias mv="rpg-battle && mv"
alias cp="rpg-battle && cp"
alias chown="rpg-battle && chown"
alias chmod="rpg-battle && chmod"

Show rpg status at prompt

A simple of showing the hero status at the bash prompt is:

$ PS1='`rpg -q | xargs` '
hero[4][xxxx][x---]@home

rpg --plain can be used as a building block for more sophisticated display.

Customize the home directory

If for some reason the system's default home directory is not practical for the game, it can be overridden by setting the $HOME environment variable. More details and examples here.

Preventing intermediate battles

Note that the logic of the default rpg command is this: the hero moves one directory at a time, and enemies can appear at each step:

• If the hero dies, the game is restarted and you go back home.
• If the hero wins the battle, it will stop at the battle's location instead of keep moving to the initial destination. The rationale for this behavior is that you may need to adjust your strategy after each battle: use a potion, return home, try to escape battles, etc.

Having cd not consistently set the pwd to the intended destination may not be acceptable if the program is used casually while doing other work. A better alternative for this usage pattern is enabled by the other integration commands, for example:

cd () {
    builtin cd "$@"
    rpg-cli cd -f .
    rpg-cli battle
}