mirror of
https://github.com/evennia/evennia.git
synced 2026-03-17 21:36:30 +01:00
50 lines
2 KiB
Markdown
50 lines
2 KiB
Markdown
# Setup and maintenance
|
|
|
|
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.
|
|
|
|
## Installation
|
|
|
|
Evennia requires Python3.7+. As with most Python packages, using a
|
|
[virtualenv](../Glossary#Virtualenv) is recommended in order to keep your
|
|
installation independent from the system libraries.
|
|
|
|
pip install evennia
|
|
|
|
If things worked, the `evennia` command should now be available.
|
|
|
|
If you are having trouble or want to help develop Evennia itself, check out the
|
|
[Extended Installation instructions](Setup/Extended-Installation). It also has
|
|
a [troubleshooting section](Setup/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 this documentation we call this folder `mygame`, but you should of course
|
|
name your game whatever you like):
|
|
|
|
evennia --init mygame
|
|
|
|
This will create a new folder `mygame` (or whatever you chose) in your current location. This
|
|
contains
|
|
|
|
|
|
## Start your new game
|
|
|
|
`cd` into your game folder (`mygame` above). 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
|
|
|
|
Fill in your user-name and password. This will be the "god user" or "superuser" in-game. The email is optional.
|
|
|
|
If all went well, the server is now up and running. Point a legacy MUD/telnet client to `localhost:4000` or
|
|
a web browser at [http://localhost:4001](http://localhost:4001) to play your new (if empty) game!
|
|
|
|
> If `localhost` doesn't work on your computer, use `127.0.0.1`, which it's the same thing.
|