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

Updated install/readme instructions.

Browse source
This commit is contained in:
Griatch 2011-11-14 13:23:57 +01:00
parent 71dddf008a
commit 3431891b6b
2 changed files with 55 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

120
INSTALL
View file

@ -1,103 +1,57 @@
-------------------- -------------
Evennia Installation Evennia Setup
-------------------- -------------
You can find the updated and more detailed version of this page on
http://code.google.com/p/evennia/wiki/GettingStarted
Pre-Requesites Installation
-------------- ------------
As far as operating systems go, any system with Python support should work. * Make sure you have/install the prerequsites with minimum versions
listed on http://code.google.com/p/evennia/wiki/GettingStarted:
- python
- django
- twisted + PIL
- mercurial
- django-south (optional)
* Linux/Unix * Go to a directory on your harddrive where you want the "evennia"
* Windows (2000, XP, Vista, Win7) directory to be created.
* Mac OSX (>=10.5 recommended)
$ cd mud/
Of these, Linux/Unix, Windows XP, and Windows 7 have been tested. If you use something else, let us know. * Get a copy of the Evennia source:
You'll need the following packages and minimum versions in order to run Evennia:
* Python (http://www.python.org)
o Version 2.5+ strongly recommended, although 2.3 or 2.4 may work. Obs- Python3.x is not supported yet.
o Default database system SQLite3 only comes as part of Python 2.5 and later.
o Windows only: 2.7+ required for full server restart functionality.
o Windows only: Optionally use ActivePython instad (http://www.activestate.com/activepython)
* Twisted (http://twistedmatrix.com)
o Version 10.0+
o Twisted also requires:
+ ZopeInterface 3.0+ (http://www.zope.org/Products/ZopeInterface)
+ Windows only: pywin32 (http://sourceforge.net/projects/pywin32)
* Django (http://www.djangoproject.com)
o Version 1.2.1+ or latest subversion trunk highly recommended.
o PIL library (http://www.pythonware.com/products/pil)
To download/update Evennia:
* Mercurial (http://mercurial.selenic.com/)
o This is needed to download and update Evennia itself.
Optional packages:
* South (http://south.aeracode.org/)
o Version 0.7+
o Optional. Used for database migrations.
* Apache2 (http://httpd.apache.org)
o Optional. Most likely you'll not need to bother with this since Evennia
runs its own threaded web server based on Twisted. Other equivalent web servers
with a Python interpreter module can also be used.
Installation and Quickstart
---------------------------
* Make sure you have/install the prerequsites listed above.
* Get a copy of the Evennia source through mercurial (hg):
> hg clone https://code.google.com/p/evennia/ evennia $ hg clone https://code.google.com/p/evennia/ evennia
Once you have downloaded, this is as much internet connectivity you need * Change to the evennia/game directory and run the setup scripts.
for trying out Evennia; you don't need to run any web server or to make
anything visible online (that's for when you have a game created and
want people to join it). For now it runs just fine locally on your machine.
(Use "hg pull" in the future to keep your code updated with latest Evennia
development)
* Change to the evennia/game directory and run $ cd evennia/game
> python manage.py $ python manage.py
This will create a settings.py file. You may override any of the default * Edit the new game/settings.py if needed, then run
values in src/config_defaults.py by pasting them into settings.py and (make sure to create an admin account when asked):
changing the values. Never edit src/config_defaults.py directly!
* If you want to use anything other than the default SQLite setup, copy and $ python manage.py syncdb
modify the database-related variables from src/config_defaults.py.
* Run * If you use django-south you need to also run
> python manage.py syncdb
This sets up the database. Answer 'yes' to create an admin account. Supply $ python manage.py migrate
a name, e-mail and password when prompted. Remember what you enter since
they are used when you log into the server as admin. The name given will
be the name of your admin character.
* Run
> python evennia.py Starting Evennia
----------------
This will launch a menu with options. You normally want option 1 for production $ python evennia.py -i start
servers, whereas options 2-4 offers more or less debug output to the screen. or
$ python evennia.py
You can also start the server directly from the command line, e.g. with
for a menu of launch options.
> python evennia.py -i start See http://code.google.com/p/evennia/wiki/StartStopReload for more info.
Note: Using -i starts the server and portal in 'interactive mode' - it will print
messages to standard output. To start the server as a background process (suitable for production
environments), just skip the -i flag. The server can be stopped with 'python evennia.py stop'. If
you don't give any argument to evennia.py, you will get a menu with all possibilities.
* 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'.

27
README
View file

@ -42,12 +42,13 @@ Current Status
-------------- --------------
Nov 2011: Nov 2011:
After creating several different proof-of-concept game systems (in contrib After creating several different proof-of-concept game systems (in
and privately) as well testing lots of things to make sure the implementation contrib and privately) as well testing lots of things to make sure the
is basically sound, we are declaring Evennia out of Alpha. This can mean implementation is basically sound, we are declaring Evennia out of
as much or as little as you want, admittedly - development is Alpha. This can mean as much or as little as you want, admittedly -
still heavy but the issue list is at an all-time low and the server is slowly development is still heavy but the issue list is at an all-time low
stabilizing as people try different things with it. and the server is slowly stabilizing as people try different things
with it. So Beta it is!
Aug 2011: Aug 2011:
Split Evennia into two processes: Portal and Server. After a lot of Split Evennia into two processes: Portal and Server. After a lot of
@ -80,7 +81,11 @@ will not be backwards compatabile. Changes touch almost all
parts of Evennia's innards, from the way Objects are handled parts of Evennia's innards, from the way Objects are handled
to Events, Commands and Permissions. to Events, Commands and Permissions.
(Earlier revisions, with other maintainer, go back to 2005) April 2010:
Griatch takes over Maintainership of the Evennia project from
the original creator Greg Taylor.
(Earlier revisions, with previous maintainer, go back to 2005)
Contact, Support and Development Contact, Support and Development
@ -121,6 +126,8 @@ evennia
|_______contrib |_______contrib
| |
|_______docs |_______docs
|
|_______locales
The two main directories you will spend most of your time in The two main directories you will spend most of your time in
are src/ and game/ (probably mostly game/). are src/ and game/ (probably mostly game/).
@ -150,6 +157,8 @@ docs/ contain offline versions of the documentation, you can use
python-sphinx to convert the raw data to nice-looking output for python-sphinx to convert the raw data to nice-looking output for
printing etc. The online wiki is otherwise first to be updated. printing etc. The online wiki is otherwise first to be updated.
With this little first orientation, you should head into the online locales/ holds translations of the server strings to other languages
Evennia wiki documentation to get going with the codebase. than English.
With this little first orientation, you should head into the online
Evennia wiki documentation to get going with the codebase.