Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-28 18:47:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Support install from pypi (rc1)

Browse source
This commit is contained in:
Griatch 2022-11-18 22:07:43 +01:00
parent b7a8bc8af6
commit 7d475c3001
11 changed files with 289 additions and 434 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/source/Setup/Installation.md
View file

@ -1,31 +1,33 @@
# Installation
```{warning}
pip install evennia is not yet available in develop branch. Use the [git installation](./Installation-Git.md).
```
```{important}
If you are converting an existing game from a previous version, [see here](./Installation-Upgrade.md).
If you are converting an existing game from a previous Evennia version, [see here](./Installation-Upgrade.md).
```
Installing Evennia doesn't make anything visible online. Apart from installation and updating, you can develop your game without any internet connection.
- Evennia requires [Python](https://www.python.org/downloads/) 3.9 or 3.10.
- Using a [Python virtualenv](../Glossary.md#virtualenv) is highly recommended in order to keep your
- Evennia supports [Python](https://www.python.org/downloads/) 3.9, 3.10 or 3.11.
- Using a [Python virtualenv](Installation-Git#virtualenv) is optional, but _highly recommended_ in order to keep your
Evennia installation independent from the system libraries.
- Don't install Evennia as
administrator or superuser.
- Don't install Evennia as administrator or superuser.
- If you run into trouble, see [installation troubleshooting](Installation-Troubleshooting).
Evennia is managed from the terminal (console/CMD on Windows). If you have a suitable Python installed, you can install with
Evennia is managed from the terminal (console/CMD on Windows). If you have a suitable Python installed, you can install it with
pip install evennia
Alternatively, you can [install Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md).
Optional: If you use a [contrib](Contribs) that warns you that it needs additional packages, you can
install all extra dependencies with
Installing doesn't make anything visible online. Apart from installation and updating, you can develop your game without any internet connection.
pip install evennia[extra]
To update Evennia later, do
pip install --upgrade evennia
Once installed, make sure the `evennia` command works. Use `evennia -h` for usage help. If you are using a virtualenv, make sure it's active whenever you need to use the `evennia` command.
> Check out [installation troubleshooting](./Installation-Troubleshooting.md) if you run into problems. Some
users have also experimented with [installing Evennia on Android](./Installation-Android.md).
> You can also [clone Evennia from github](./Installation-Git.md) or use [docker](./Installation-Docker.md). Some users have also experimented with [installing Evennia on Android](./Installation-Android.md).
## Initialize a new game
@ -82,13 +84,12 @@ or
evennia -l
Stop viewing the log by pressing `Ctrl-C` (`Cmd-C` for Mac).
You can start viewing the log immediately when running `evennia` commands, such as
You can start viewing the log immediately by adding `-l/--log` to `evennia` commands, such as
evennia start -l
To exit the log tailing, enter `Ctrl-C` (`Cmd-C` for Mac). This will not affect the server.
## Server configuration
@ -96,7 +97,7 @@ The server configuration file is `mygame/server/settings.py`. It's empty by defa
## Register with the Evennia Game Index (optional)
You can optionally let the world know that you are working on a new Evennia-based game by
You can let the world know that you are working on a new Evennia-based game by
registering your server with the _Evennia game index_. You don't have to be
open for players to do this - you just mark your game as closed and "pre-alpha".