mirror/evennia
3
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-08-18 03:05:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix formatting

Browse Source
This commit is contained in:
Cal
2026-04-19 16:52:45 -06:00
parent 4ce5205257
commit 9d7fefa95b
1 changed files with 24 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/source/Setup/Installation.md
View File

@ -2,29 +2,26 @@
Evennia requires having [Python](https://www.python.org/downloads/) and pip installed. The current recommended versions are 3.12 or 3.13.
Note: As this is not a Python installation guide, please consult the instructions for installing Python+pip for your operating system if it is not already installed.
```{note}
As this is not a Python installation guide, please consult the instructions for installing Python+pip for your operating system if it is not already installed.
```
## Quickstart
Make sure you have a supported Python version installed, navigate to your development directory in a terminal, and execute the following commands appropriate for your operating system, replacing `mygame` with the directory to create for your game files.
Make sure you have a supported Python version installed, navigate to your development directory in a terminal, and execute the following commands appropriate for your operating system.
#### Linux/Mac
```
$ python -m venv evenv
$ source evenv/bin/activate
$ pip install evennia
$ evennia --init mygame
```
$ python -m venv evenv
$ source evenv/bin/activate
$ pip install evennia
#### Windows
```
py -m venv evenv
.\evenv\lib\activate
pip install evennia
py -m evennia
evennia --init mygame
```
py -m venv evenv
.\evenv\lib\activate
pip install evennia
py -m evennia
## Alternative Installations
@ -41,25 +38,24 @@ If you have specific install environment needs that differ from the standard ins
You will need to install Evennia to a *python virtual environment*, so the first step is to create one. This is done using the `venv` package in python:
```
$ python -m venv evenv
```
$ python -m venv evenv
Note: the recommended way to run python from the Windows command line is the `py` launcher command, so you will most likely want to use `py` instead of `python` here and for the rest of the instructions. However, you can also directly reference the python version. Consult the official Python for Windows documentation for more information.
```{note}
**Windows Only**: The recommended way to run python from the Windows command line is the `py` launcher command, so you will most likely want to use `py` instead of `python` here and for the rest of the instructions. However, you can also directly reference the python version. Consult the official Python for Windows documentation for more information.
```
This will create a new directory named `evenv` containing the *virtual environment* - a set of python packages and executables installed locally, rather than system-wide. Doing this prevents permissions and conflict issues later.
Once it's created, you *activate* it in order to use that environment - it'll keep the python version and anything you install via `pip` contained within it.
Linux/Mac:
```
$ source evenv/bin/activate
```
$ source evenv/bin/activate
Windows:
```
.\evenv\lib\activate
```
.\evenv\lib\activate
You'll need to do this step - activating the environment - every time you open a new terminal to work on your Evennia game.
@ -75,9 +71,11 @@ This will install the latest release version of Evennia into your virtual enviro
If you use a [contrib](../Contribs/Contribs-Overview.md) that warns you that it needs additional packages, use the following to install all of the extra dependencies:
pip install evennia[extra]
pip install evennia[extra]
```{note}
**Windows only**: After installing, you will need to enter one more command - `py -m evennia` - to make sure that the `evennia` command is available in your terminal.
```
### 3. Upgrading Evennia