diff --git a/docs/source/Contribs/XYZGrid.md b/docs/source/Contribs/XYZGrid.md index f863a0b4fc..4fc3975619 100644 --- a/docs/source/Contribs/XYZGrid.md +++ b/docs/source/Contribs/XYZGrid.md @@ -40,11 +40,20 @@ Exits: northeast and east ## Installation -1. Import and add the `evennia.contrib.commands.XYZGridCmdSet` to the +1. XYZGrid requires the `scipy` library. Easiest is to just install the + optional/contrib requirements in `evennia/requirements_extra.txt` by + doing + + (cd to evennia/ folder) + pip install -r requirements_extra.txt + (then go back to your mygame/ folder) + + This will install all optional requirements of Evennia. +2. Import and add the `evennia.contrib.commands.XYZGridCmdSet` to the `CharacterCmdset` cmdset in `mygame/commands.default_cmds.py`. Reload the server. This makes the `map`, `goto/path` and the modified `teleport` and `open` commands available in-game. -2. Edit `mygame/server/conf/settings.py` and add +3. Edit `mygame/server/conf/settings.py` and add EXTRA_LAUNCHER_COMMANDS['xyzgrid'] = 'evennia.contrib.launchcmd.xyzcommand' @@ -55,8 +64,8 @@ Exits: northeast and east This will add the new ability to enter `evennia xyzgrid