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

Update README.md

Browse source
This commit is contained in:
Griatch 2016-03-15 12:33:24 +01:00
parent ca48bed729
commit 684393f7f0
1 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
evennia/game_template/README.md
View file

@ -1,7 +1,8 @@
# Welcome to Evennia!
This directory is your game directory, set up to let you start with
your new game right away.
This is your game directory, set up to let you start with
your new game right away. An overview of this directory is found here:
https://github.com/evennia/evennia/wiki/Directory-Overview#the-game-directory
You can delete this readme file when you've read it and you can
re-arrange things in this game-directory to suit your own sense of
@ -12,16 +13,17 @@ where to look for things.
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
started). If you just created this directory (which means you'll already
have a `virtualenv` running if you followed the default instructions),
`cd` to this directory then initialize a new database using
evennia migrate
To start the server, `cd` to this directory and run
To start the server, stand in this directory and run
evennia start
This will start the server so that it logs output to the console. Make
This will start the server, logging 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`, port `4000`. You can
also log into the web client by pointing a browser to
@ -35,3 +37,4 @@ http://github.com/evennia/evennia/wiki/Tutorials.
Evennia's documentation is here:
https://github.com/evennia/evennia/wiki.
Enjoy!