Skip to content
Snippets Groups Projects
README.md 1.56 KiB
Newer Older
  • Learn to ignore specific revisions
  • These config files make the BIND RPG books look and act the way they do.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    # Usage
    
    
    To make a book, put this config folder into the same directory.
    
    > git subtree add -P config git@gitlab.com:bindrpg/config.git master
    
    Then copy main.tex into your main folder and make a symbolic link to the `.gitignore` file.
    
    > cp config/main.tex .
    
    
    > cp config/.gitignore .
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    Edit 'main.tex', and input your tex files by writing `\include{my_file.tex}.
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    ## Creatures
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    You can include pseudo-randomo creatures in your adventure by summoning the names from monsters.
    .  For example, to place a random elf in your game, just write `\elf`, and an elf will be magically summoned unto your adventure.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    ```
    \elf
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    ```
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    You can give the character a title and name by writing '\npc{symbol}{name}' as an optional argument.
    For example:
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    ```
    \humanalchemist[\npc{\M}{Rincewind}]
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    This would make a heading called **Rincewind** in bold with a male symbol, and provide pseudo-random alchemist-appropriate stats underneath.
    
    | Syntax | Symbol |
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    |:------:|:------:|
    | \\M    | Male   |
    | \\F    | Female |
    | \\T    | Team   |
    | \\D    | Undead |
    | \\N    | Nura   |
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    For a complete list of all the creatures and characters which can be used, see the 'monsters.tex' file.
    For more details on the syntax, have a look at examples in *Adventures in Fenestra*, or read the git's wiki.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    # TeXnical Details
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    
    This thing's handled as a subtree in the other documments, so changing it will change all BIND books.
    
    Malin Freeborn's avatar
    Malin Freeborn committed
    
    Personally, I keep it in a directory by the others.  This allows you to do:
    
    > git subtree -P config pull ../config master