Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated INSTALL.txt file to remove google code/mercurial references.

Browse source
This commit is contained in:
Griatch 2014-02-19 14:04:22 +01:00
parent e2130cd3e8
commit b0f1993dd6
1 changed files with 25 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

45
INSTALL.txt
View file

@ -4,44 +4,48 @@ Evennia Setup
------------- -------------
You can find the updated and more detailed version of this page on You can find the updated and more detailed version of this page on
http://code.google.com/p/evennia/wiki/GettingStarted https://github.com/evennia/evennia/wiki/Getting-Started. You don't
need to make your server visible online during development, you only
need an internet connection for downloading and updating.
Installation Installation
------------ ------------
* Make sure you have/install the prerequsites with minimum versions * Make sure you have the prerequsites with minimum versions
listed on http://code.google.com/p/evennia/wiki/GettingStarted: listed on https://github.com/evennia/evennia/wiki/Getting-Started:
- python - python
- django - django
- twisted + PIL - twisted + Pillow
- mercurial - GIT
- django-south (optional, but highly recommended) - django-south
* Go to a directory on your harddrive where you want the 'evennia' * Go to a directory on your harddrive where you want the 'evennia'
directory to be created, for example mud/. directory to be created, for example mud/.
$ cd mud/ cd mud/
* Get a copy of the Evennia source: * Get a copy of the Evennia source (you should have done this
already if you are reading this file):
$ hg clone https://code.google.com/p/evennia/ evennia git clone https://github.com/evennia/evennia.git
or
git clone git@github.com:evennia/evennia.git
In the future, do 'git pull' to update the server.
* Change to the evennia/game directory and run the setup scripts. * Change to the evennia/game directory and run the setup scripts.
$ cd evennia/game cd evennia/game
$ python manage.py python manage.py
* Edit the new game/settings.py if needed, then run * Edit the new game/settings.py if needed, then run
(make sure to create an admin account when asked):
$ python manage.py syncdb python manage.py syncdb
* If you use django-south you need to also run python manage.py migrate
$ python manage.py migrate
Starting Evennia Starting Evennia
@ -49,10 +53,11 @@ Starting Evennia
* Start the server with * Start the server with
$ python evennia.py -i start python evennia.py -i start
or run without arguments for a menu of launch options. or run without arguments for a menu of launch options. Make
See http://code.google.com/p/evennia/wiki/StartStopReload for more info. sure to create a superuser when asked. The email does not have
to be a real one for testing (evennia does not check it)
* Start up your MUD client of choice and point it to your server and port 4000. * Start up your MUD client of choice and point it to your server and port 4000.
If you are just running locally the server name is 'localhost'. If you are just running locally the server name is 'localhost'.
@ -60,7 +65,7 @@ Starting Evennia
* Alternatively, you can find the web interface and webclient by * Alternatively, you can find the web interface and webclient by
pointing your web browser to http://localhost:8000. pointing your web browser to http://localhost:8000.
* Login with the email address and password you provided when setting up the server. * For superuser access, login with the account and password you provided earlier.
Welcome to Evennia! Welcome to Evennia!