diff --git a/docs/source/Contribs/Contrib-AWSStorage.md b/docs/source/Contribs/Contrib-AWSStorage.md index b5b97b8878..cca8246f37 100644 --- a/docs/source/Contribs/Contrib-AWSStorage.md +++ b/docs/source/Contribs/Contrib-AWSStorage.md @@ -117,10 +117,12 @@ This package requires the dependency "boto3 >= 1.4.4", the official AWS python package. To install, it's easiest to just install Evennia's extra requirements; -- Activate your `virtualenv` -- `cd` to the root of the Evennia repository. There should be an `requirements_extra.txt` -file here. -- `pip install -r requirements_extra.txt` + pip install evennia[extra] + +If you installed Evennia with `git`, you can also + +- `cd` to the root of the Evennia repository. +- `pip install --upgrade -e .[extra]` ## Configure Evennia diff --git a/docs/source/Contribs/Contrib-Git-Integration.md b/docs/source/Contribs/Contrib-Git-Integration.md index eb679df31f..c2d75b48b1 100644 --- a/docs/source/Contribs/Contrib-Git-Integration.md +++ b/docs/source/Contribs/Contrib-Git-Integration.md @@ -2,7 +2,7 @@ Contribution by helpme (2022) -A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. +A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. Once the contrib is set up, integrating remote changes is as simple as entering the following into your game: @@ -14,11 +14,16 @@ The repositories you want to work with, be it only your local mygame repo, only ## Dependencies -This package requires the dependency "gitpython", a python library used to interact with git repositories. To install, it's easiest to install Evennia's extra requirements: +This package requires the dependency "gitpython", a python library used to +interact with git repositories. To install, it's easiest to install Evennia's +extra requirements: -- Activate your `virtualenv` -- `cd` to the root of the Evennia repository. There should be an `requirements_extra.txt` file here. -- `pip install -r requirements_extra.txt` + pip install evennia[extra] + +If you installed with `git` you can also do + +- `cd` to the root of the Evennia repository. +- `pip install --upgrade -e .[extra]` ## Installation @@ -67,6 +72,7 @@ The supported commands are: The utility uses the existing GAME_DIR and EVENNIA_DIR settings from settings.py. You should not need to alter these if you have a standard directory setup, they ought to exist without any setup required from you. + ---- This document page is generated from `evennia/contrib/utils/git_integration/README.md`. Changes to this diff --git a/docs/source/Contribs/Contrib-XYZGrid.md b/docs/source/Contribs/Contrib-XYZGrid.md index 879b146336..f10cab5258 100644 --- a/docs/source/Contribs/Contrib-XYZGrid.md +++ b/docs/source/Contribs/Contrib-XYZGrid.md @@ -44,13 +44,15 @@ Exits: northeast and east ## Installation -1. XYZGrid requires the `scipy` library. Easiest is to just install the - optional/contrib requirements in `evennia/requirements_extra.txt` by - doing +1. XYZGrid requires the `scipy` library. Easiest is to get the 'extra' + dependencies of Evennia with - (cd to evennia/ folder) - pip install -r requirements_extra.txt - (then go back to your mygame/ folder) + pip install evennia[extra] + + If you use the `git` install, you can also + + (cd to evennia/ folder) + pip install --upgrade -e .[extra] This will install all optional requirements of Evennia. 2. Import and [add] the `evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet` to the @@ -1352,8 +1354,9 @@ rooms without editing the map files outside of the game. ## Installation 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. + You can do so by doing `pip install evennia[extra]`, or if you used `git` to + install, do `pip install --upgrade -e .[extra]` from the `evennia/` repo + folder. 2. Import and add the `evennia.contrib.grid.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 diff --git a/docs/source/Contribs/Contribs-Overview.md b/docs/source/Contribs/Contribs-Overview.md index 51383d322f..f7d1442406 100644 --- a/docs/source/Contribs/Contribs-Overview.md +++ b/docs/source/Contribs/Contribs-Overview.md @@ -791,7 +791,7 @@ to any callable of your choice. _Contribution by helpme (2022)_ -A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. +A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. [Read the documentation](./Contrib-Git-Integration.md) - [Browse the Code](evennia.contrib.utils.git_integration) diff --git a/docs/source/Setup/Installation-Upgrade.md b/docs/source/Setup/Installation-Upgrade.md index 6f343aa3d8..6805ee04cd 100644 --- a/docs/source/Setup/Installation-Upgrade.md +++ b/docs/source/Setup/Installation-Upgrade.md @@ -18,7 +18,7 @@ Prior to 1.0, all Evennia installs were [Git-installs](./Installation-Git.md). T - `git pull` - `git checkout main` (instead of `master` which was used for `0.9.5`) - `pip install --upgrade -e .` -- If you want the optional extra libs (needed by some contribs), do `pip install -e --upgrade .[extra]` +- If you want the optional extra libs (needed by some contribs), do `pip install --upgrade -e .[extra]` - Test that you can run the `evennia` command. ### Upgrading your game dir diff --git a/evennia/contrib/base_systems/awsstorage/README.md b/evennia/contrib/base_systems/awsstorage/README.md index b88dc585e9..fceff49d12 100644 --- a/evennia/contrib/base_systems/awsstorage/README.md +++ b/evennia/contrib/base_systems/awsstorage/README.md @@ -117,10 +117,12 @@ This package requires the dependency "boto3 >= 1.4.4", the official AWS python package. To install, it's easiest to just install Evennia's extra requirements; -- Activate your `virtualenv` -- `cd` to the root of the Evennia repository. There should be an `requirements_extra.txt` -file here. -- `pip install -r requirements_extra.txt` + pip install evennia[extra] + +If you installed Evennia with `git`, you can also + +- `cd` to the root of the Evennia repository. +- `pip install --upgrade -e .[extra]` ## Configure Evennia diff --git a/evennia/contrib/grid/xyzgrid/README.md b/evennia/contrib/grid/xyzgrid/README.md index 3a2ab909f2..2fb4f0002d 100644 --- a/evennia/contrib/grid/xyzgrid/README.md +++ b/evennia/contrib/grid/xyzgrid/README.md @@ -44,13 +44,15 @@ Exits: northeast and east ## Installation -1. XYZGrid requires the `scipy` library. Easiest is to just install the - optional/contrib requirements in `evennia/requirements_extra.txt` by - doing +1. XYZGrid requires the `scipy` library. Easiest is to get the 'extra' + dependencies of Evennia with - (cd to evennia/ folder) - pip install -r requirements_extra.txt - (then go back to your mygame/ folder) + pip install evennia[extra] + + If you use the `git` install, you can also + + (cd to evennia/ folder) + pip install --upgrade -e .[extra] This will install all optional requirements of Evennia. 2. Import and [add] the `evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet` to the @@ -1352,8 +1354,9 @@ rooms without editing the map files outside of the game. ## Installation 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. + You can do so by doing `pip install evennia[extra]`, or if you used `git` to + install, do `pip install --upgrade -e .[extra]` from the `evennia/` repo + folder. 2. Import and add the `evennia.contrib.grid.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 diff --git a/evennia/contrib/utils/git_integration/README.md b/evennia/contrib/utils/git_integration/README.md index 861b2c0503..8d88320f55 100644 --- a/evennia/contrib/utils/git_integration/README.md +++ b/evennia/contrib/utils/git_integration/README.md @@ -2,7 +2,7 @@ Contribution by helpme (2022) -A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. +A module to integrate a stripped-down version of git within the game, allowing developers to view their git status, change branches, and pull updated code of both their local mygame repo and Evennia core. After a successful pull or checkout, the git command will reload the game: Manual restarts may be required to to apply certain changes that would impact persistent scripts etc. Once the contrib is set up, integrating remote changes is as simple as entering the following into your game: @@ -14,11 +14,16 @@ The repositories you want to work with, be it only your local mygame repo, only ## Dependencies -This package requires the dependency "gitpython", a python library used to interact with git repositories. To install, it's easiest to install Evennia's extra requirements: +This package requires the dependency "gitpython", a python library used to +interact with git repositories. To install, it's easiest to install Evennia's +extra requirements: -- Activate your `virtualenv` -- `cd` to the root of the Evennia repository. There should be an `requirements_extra.txt` file here. -- `pip install -r requirements_extra.txt` + pip install evennia[extra] + +If you installed with `git` you can also do + +- `cd` to the root of the Evennia repository. +- `pip install --upgrade -e .[extra]` ## Installation @@ -65,4 +70,4 @@ The supported commands are: ## Settings Used -The utility uses the existing GAME_DIR and EVENNIA_DIR settings from settings.py. You should not need to alter these if you have a standard directory setup, they ought to exist without any setup required from you. \ No newline at end of file +The utility uses the existing GAME_DIR and EVENNIA_DIR settings from settings.py. You should not need to alter these if you have a standard directory setup, they ought to exist without any setup required from you.