From 8fed68334d0913facc78f44b6d11518829a0c510 Mon Sep 17 00:00:00 2001 From: Griatch Date: Fri, 19 Jun 2020 18:45:02 +0200 Subject: [PATCH] Add setup-overview --- docs/source/Setup/Setup-Overview.md | 50 +++++++++++++++++++++++++++++ docs/source/index.md | 2 +- docs/source/toc.md | 1 + 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/source/Setup/Setup-Overview.md diff --git a/docs/source/Setup/Setup-Overview.md b/docs/source/Setup/Setup-Overview.md new file mode 100644 index 0000000000..7e4de7e217 --- /dev/null +++ b/docs/source/Setup/Setup-Overview.md @@ -0,0 +1,50 @@ +# 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. diff --git a/docs/source/index.md b/docs/source/index.md index 91aae880f3..e935b8cd92 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -22,7 +22,7 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python ## Main sections -- [Setting up and running](Setup) - How to get, start and maintain the server +- [Setting up and running](Setup/Setup-Overview) - How to get, start and maintain the server - [Tutorials and Howto's](Howto) - Explains how to reach particular goals - [Core components](Components) - The building blocks of Evennia - [Concepts](Concepts) - Larger-scale concepts and features diff --git a/docs/source/toc.md b/docs/source/toc.md index 37a051a21c..35bae0684a 100644 --- a/docs/source/toc.md +++ b/docs/source/toc.md @@ -131,6 +131,7 @@ - [Setup/RSS](Setup/RSS) - [Setup/Running Evennia in Docker](Setup/Running-Evennia-in-Docker) - [Setup/Security](Setup/Security) +- [Setup/Setup Overview](Setup/Setup-Overview) - [Setup/Start Stop Reload](Setup/Start-Stop-Reload) - [index](index)