Move scipy requirement to requirements_extra.txt

This commit is contained in:
Griatch 2021-10-05 22:04:55 +02:00
parent a290ec67fc
commit c3df322a70
4 changed files with 23 additions and 10 deletions

View file

@ -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 <option>` on the
command line. It will also make the `xyz_room` and `xyz_exit` prototypes
available for use as prototype-parents when spawning the grid.
3. Run `evennia xyzgrid help` for available options.
4. (Optional): By default, the xyzgrid will only spawn module-based
4. Run `evennia xyzgrid help` for available options.
5. (Optional): By default, the xyzgrid will only spawn module-based
[prototypes](../Components/Prototypes). This is an optimization and usually makes sense
since the grid is entirely defined outside the game anyway. If you want to
also make use of in-game (db-) created prototypes, add

View file

@ -25,15 +25,19 @@ in the docs.
## Installation
1. Import and add the `evennia.contrib.xyzgrid.commands.XYZGridCmdSet` to the
1. If you haven't before, install the extra contrib requirements.
You can do so by doing `pip install -r requirements_extra.txt` from the
`evennia/` folder.
2. Import and add the `evennia.contrib.xyzgrid.commands.XYZGridCmdSet` to the
`CharacterCmdset` cmdset in `mygame/commands.default_cmds.py`. Reload
the server. This makes the `map`, `goto/path` and modified `teleport` and
`open` commands available in-game.
2. Edit `mygame/server/conf/settings.py` and set
3. Edit `mygame/server/conf/settings.py` and set
EXTRA_LAUNCHER_COMMANDS['xyzgrid'] = 'evennia.contrib.xyzgrid.launchcmd.xyzcommand'
3. Run the new `evennia xyzgrid help` for instructions on how to spawn the grid.
4. Run the new `evennia xyzgrid help` for instructions on how to spawn the grid.
## Example usage

View file

@ -26,6 +26,3 @@ parameterized==0.8.1
# windows-specific
pypiwin32;platform_system=="Windows"
# xyzroom contrib
scipy==1.7.1

View file

@ -19,3 +19,6 @@ botocore >= 1.15
jupyter >= 1.0.0
ipython >= 7.19.0
django-extensions >= 3.1.0
# xyzroom contrib
scipy==1.7.1