diff --git a/evennia/game_template/README.md b/evennia/game_template/README.md new file mode 100644 index 0000000000..87fa9fb061 --- /dev/null +++ b/evennia/game_template/README.md @@ -0,0 +1,35 @@ +# Welcome to Evennia! + +This directory is your game directory, set up to let you start with +your new game right away. + +You can delete this readme file when you've read it and with the +exception of the `server/` directory you can, if you want, re-arrange +things in this game-directory pretty to suit your own sense of +organisation. See the readme's in each sub directory for more +information. + +Your game's main configuration file is found in +`server/conf/settings.py` (but you don't need to change it to get +started). If you just created this directory, `cd` to this directory +then initialize a new database using + + evennia migrate + +To start the server, `cd` to this directory and run + + evennia -i start + +This will start the server so that it logs output to the console. Make +sure to create a superuser when asked. By default you can now connect +to your new game using a MUD client on localhost:4000. You can also +log into the web client by pointing a browser to +http://localhost:8000. + +# Getting started + +It's highly recommended that you look up Evennia's extensive +documentation found here: https://github.com/evennia/evennia/wiki. + +Plenty of beginner's tutorials can be found here: +http://github.com/evennia/evennia/wiki/Tutorials.