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

Add support for latest Twisted and Python 3.9

Browse source
This commit is contained in:
Griatch 2021-05-15 23:46:34 +02:00
parent 63009a2a65
commit a4f5ae2c96
12 changed files with 85 additions and 82 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/source/Setup/Setup-Quickstart.md
View file

@ -1,15 +1,15 @@
# Setup quickstart
The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the
The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the
server doesn't make anything visible online. Once you download everything you can in fact develop your game
in complete isolation if you want, without needing any access to the internet.
in complete isolation if you want, without needing any access to the internet.
## Installation
Evennia requires Python3.7+. As with most Python packages, using a
Evennia supports Python 3.7 to 3.9. As with most Python packages, using a
[virtualenv](../Glossary#virtualenv) is recommended in order to keep your
installation independent from the system libraries. It's _not_ recommended
to install Evennia as superuser.
installation independent from the system libraries. It's _not_ recommended
to install Evennia as superuser.
```warning::
@ -20,16 +20,17 @@ to install Evennia as superuser.
Make sure the `evennia` command works. Use `evennia -h` for usage help (or read on).
If you are having trouble, want to install in some other way (like with Docker) or want to contribute to
Evennia itself, check out the [Extended Installation instructions](./Extended-Installation).
It also has a [troubleshooting section](./Extended-Installation#Troubleshooting) for different operating
If you are having trouble, want to install in some other way (like with Docker)
or want to contribute to Evennia itself, check out the [Extended Installation
instructions](./Extended-Installation). It also has a [troubleshooting
section](./Extended-Installation#Troubleshooting) for different operating
systems.
## Initialize a new game
Use `cd` to enter a folder where you want to do your game development. Here (and in
the rest of the Evennia documentation) we call this folder `mygame`, but you should of course
Use `cd` to enter a folder where you want to do your game development. Here (and in
the rest of the Evennia documentation) we call this folder `mygame`, but you should of course
name your game whatever you like:
evennia --init mygame
@ -40,14 +41,14 @@ contains empty templates and all the default settings needed to start the server
## Start the new game
`cd` into your game folder (`mygame` in our case). Next, run
`cd` into your game folder (`mygame` in our case). Next, run
evennia migrate
This will create the default database (Sqlite3). The database file ends up as `mygame/server/evennia.db3`. If you
ever want to start from a fresh database, just delete this file and re-run `evennia migrate` again.
evennia start
evennia start
Set your user-name and password when prompted. This will be the "god user" or "superuser" in-game. The email is optional.
@ -57,36 +58,36 @@ a web browser at [http://localhost:4001](http://localhost:4001) to play your new
> If `localhost` doesn't work on your computer, use `127.0.0.1`, which is the same thing.
## See server logs
## See server logs
This will echol the server logs to the terminal as they come in:
evennia --log
or
or
evennia -l
evennia -l
You can also start logging immediately when running `evennia` commands, such as
evennia start -l
evennia start -l
To exit the log view, enter `Ctrl-C` (`Cmd-C` for Mac). This will not affect the server.
## Restarting and stopping
## Restarting and stopping
You can restart the server without disconnecting any connected players:
evennia restart
evennia restart
To do a full stop and restart (will disconnect everyone):
evennia reboot
evennia reboot
Full stop of the server (will need to use `start` to activate it again):