Getting Started =============== This will help you download, install and start Evennia for the first time. *Note: You don't need to make anything visible to the 'net in order to run and test out Evennia. Apart from installing and updating you don't even need to have an internet connection. Of course you'll probably want to put your game online once it matures enough, but until then it works fine to develop and play around completely in the sanctity and isolation of your local machine.* Quick start ----------- For you who are extremely impatient, here's the gist of getting a vanilla Evennia install running. #. *Get the pre-requisites (Python, Django, Twisted, South and Mercurial)*. #. *Start a command terminal/dos prompt and change directory to where you want to have your 'evennia' folder appear*. #. ``hg clone https://code.google.com/p/evennia/ evennia`` #. *Change directory to evennia/game*. #. ``python manage.py`` #. ``python manage.py syncdb`` #. ``python manage.py migrate`` #. ``python evennia.py -i start`` Evennia should now be running and you can connect to it by pointing a web browser to ``http://localhost:8000`` or a MUD telnet client to ``localhost:4000``. Read on for more detailed instructions and configurations. Prerequisites ------------- As far as operating systems go, any system with Python support should work. - Linux/Unix - Windows (2000, XP, Vista, Win7, Win8) - Mac OSX (>=10.5 recommended) If you run into problems, or have success running Evennia on another platform, please let us know. You'll need the following packages and minimum versions in order to run Evennia: - **`Python `_** (v2.6+, not supporting v3.x). - Windows users are recommended to use `ActivePython `_ instead. - **`Twisted `_** (v11.0+) - `ZopeInterface `_ (v3.0+) - usually included in Twisted packages - Windows users might also need `pywin32 `_. - **`Django `_** (v1.5+) - `PIL `_ (Python Image Library) - often distributed with Django. - **`South `_** (v0.8+) - South is used to track and apply changes to the database's structure. To download/update Evennia: - **`Mercurial `_** Optional: - **`PyPy `_** (v1.7+) - Optional faster implementation of Python. See [`GettingStarted `_\ #Optional:\ *Running\_under\_PyPy here] for how to run Evennia under PyPy.* Installing pre-requisites ------------------------- **All platforms** can set up an \_virtual Python environment and install Evennia to that. All you need pre-installed is Python. Setup is described in detail [`GettingStarted `_\ #Optional:\ *A\_separate\_installation\_environment\_with\_virtualenv here]. Windows users will probably want to go the ActivePython route instead (see below) since there are issues with installing certain extensions under Windows.* **Linux** package managers should usually handle all this for you. Python itself is definitely available through all distributions. On Debian-derived systems (such as Ubuntu) you can do something like this (as root) to get all you need: :: apt-get install python python-django python-twisted mercurial python-django-south (Gentoo note: Gentoo (and maybe other distros?) seems to distribute Twisted in multiple packages. Beyond the main twisted package you will also need to get at least twisted-conch and twisted-web too).\ ** Distributions can usually not keep fully up-to-date with the latest security fixes. So for an online server it is highly recommended to use Python's `easy\_install `_ or the newer `pip `_ to get some or all of the dependencies instead: :: easy_install django twisted pil mercurial south :: pip install django twisted pil mercurial south If you already have Python and have downloaded Evennia, the package comes with a ``requirements.txt`` file. This can be used with ``pip`` to install the remaining dependencies. This is useful for automated build systems: :: pip install -r requirements.txt **Mac** users should be able to get most dependencies through ``easy_install`` or ``pip`` like Linux users do. All interaction is done from a terminal window. There are some reports that you might need to get the `Xcode `_ development system to install the packages that requires extension compiling. You can also retrieve the dependencies directly and install them through their native installers or python setups. Some users have reported problems compiling the ``PIL`` library on Mac, it's however not strictly required in order to use Django (it's used for images). **Windows** users should first and foremost recognize that the Evennia server is run from the command line, something which some might not be familiar with (based on the questions we have received). In the Windows launch menu, just start \_All Programs -> Accessories -> command prompt and you will get the Windows command line interface. There are plenty of online tutorials on using the Windows command line, one example is found `here `_. Windows users may want to install `ActivePython `_ instead of the usual Python. Get the 32-bit version (it seems the 64-bit one won't let you download any packages without paying for a "Business" license). If ActivePython is installed, you can use `pypm `_ in the same manner as ``easy_install``/``pip`` above. This *greatly* simplifies getting started on Windows - this platform defaults to lacking sane developer tools and package management. After installing ActivePython you may need to restart the terminal/DOS window to make the pypm command available on the command line. Then write: :: pypm install Django Twisted PIL Mercurial South This installs everything you need in one go. Windows users not using ActivePython or virtual environments will have to manually download and install the packages in turn (including their own dependencies in the list above). Most have normal Windows installers, but in some cases you'll need to know how to use the Windows command prompt to execute python install scripts (it's usually not harder than running ``python setup.py install`` from the downloaded package's folder). Step 1: Obtaining the Server ---------------------------- To download Evennia you need the Mercurial client to grab a copy of the source. For command-line Mercurial client users, something like this will do the trick (first place yourself in a directory where you want a new folder ``evennia`` to be created): :: hg clone https://code.google.com/p/evennia/ evennia (Mercurial is abbreviated ``hg`` since this is the chemical symbol for mercury). In the future, you just do :: hg pull hg update from your ``evennia/`` directory to obtain the latest updates. If you use a graphical Mercurial client, use the equivalent buttons to perform the above operations. See `here `_ for more advanced suggestions to set up a development environment with Mercurial. Step 2: Setting up the Server ----------------------------- From within the Evennia ``game`` directory (``evennia/game/``, if you followed the Mercurial instructions above) type the following to trigger the automatic creation of an empty ``settings.py`` file. :: python manage.py Your new ``settings.py`` file will just be an empty template initially. In ``evennia/src/settings_default.py`` you will find the settings that may be copied/pasted into your ``settings.py`` to override the defaults. This will be the case if you want to adjust paths or use something other than the default SQLite3 database engine. You *never* want to modify ``settings_default.py`` directly - as the server is developed, this file might be overwritten with new versions and features. If you would like to use something other than the default SQLite setup (which works "out of the box"), you'll need to copy the ``DATABASE_*`` variables from ``settings_defaults.py`` and paste them to ``settings.py``, making your modifications there. *Note that the settings.py file is in fact a normal python module which imports the default settings. This means that all variables have been set to default values by the time you get to change things. So to customize a particular variable you have to copy&paste it to your settings file - and you have to do so also for variables that depend on that variable (if any), or the dependent variables will remain at the default values.* Finally, enter the following command in a terminal or shell to create the database file (in the case of SQLite3) and populate the database with the standard tables and values: :: python manage.py syncdb You will see a lot of spammy install messages. If all goes well, you're ready to continue to the next step. If not, look at the error messages and double-check your ``settings.py`` file. Next you migrate the database to the current revision: :: python manage.py migrate This can take a while. When we make changes to the database schema in the future (we announce this on the homepage) you just need to re-run this command to have your existing database converted for you. Step 3: Starting and Stopping the Server ---------------------------------------- To start the server, make sure you're in the ``evennia/game`` directory and execute ``evennia.py`` like this: :: python evennia.py -i start (The ``-i`` flag means that the server starts in *interactive mode*, as a foreground process. You will see debug/log messages directly in the terminal window instead of logging them to a file.) You should be asked to create a superuser. Make **sure** you create a superuser here when asked, this becomes your login name for the superuser (owner) account in game. It will ask for email address and password. The email address does not have to be an existing one. After entering the superuser information, the server and portal will start for the first time. Evennia will quickly run some first-time configurations, restart once and then be running. To stop Evennia, do: :: python evennia.py stop See `Running Evennia `_ for more advanced options on controlling Evennia's processes. Step 4: Connecting to the server -------------------------------- The Evennia server is now up and running. You should be able to login with any mud client or telnet client using the email address and password you specified when syncing the database. If you are just testing the server out on your local machine, the server name will most likely be ``localhost`` whereas the port used by default is ``4000``. If the defaults are not changed, Evennia will also start its own Twisted-based web server on port 8000. Point your web browser to ``http://localhost:8000/``. The *admin interface* allows you to edit the game database online and you can connect directly to the game by use of the ajax web client. Welcome to Evennia! Why not try `building something `_ next? Optional: A separate installation environment with virtualenv ============================================================= Apart from installing the packages and versions as above, you can also set up a very easy self-contained Evennia install using the `virtualenv `_ program. If you are unsure how to get it, just grab the `virtualenv.py `_ file and run it directly in the terminal with ``python virtualenv.py``. Virtualenv sets aside a folder on your harddrive as a stand-alone Python environment. It should work both on Linux/Unix and Windows. First, install Python as normal, then get virtualenv and install it so you can run it from the command line. This is an example for setting up Evennia in an isolated new folder *mudenv*: :: virtualenv mudenv Or, if you grabbed ``virtualenv.py`` and is running it directly: :: python virtualenv.py mudenv Followed by :: cd mudenv Now we should be in our new directory *mudenv*. Next we activate the virtual environment in here. :: # for Linux/Unix: source bin/activate # for Windows: \Scripts\activate.bat The virtual environment within our *mudenv* folder is now active. Things will not seem to have changed very much, and indeed they haven't - the only difference is that python programs will now look to the python installation in this folder instead of the system-centric ones. Next we get all the requirements with *pip*, which is included with virtualenv: :: pip install django twisted pil mercurial south These newly installed packages are *only* localized to the virtual environment, they do not affect the normal versions of programs you run in the rest of your system. So you could for example experiment with bleeding-edge, unstable libraries or go back to older versions without having to worry about messing up other things. It's also very easy to uninstall the whole thing in one go - just delete your ``mudenv`` folder. You can now refer to **Step 1** above and continue on from there to install Evennia into *mudenv*. In the future, just go into the folder and activate it before starting or working with Evennia. Optional: Running under !PyPy ============================= Evennia can also be run under `PyPy `_, a fast alternative implementation of standard Python. Evennia under PyPy generally takes longer to start but may run faster (just how much is currently untested so feel free to report your findings). You first need to download and install PyPy. See the `PyPy `_ homepage for instructions. This may be the most tricky step depending on your operating system. The easiest way to set up Evennia for running under pypy is to do so in a separate *virtualenv*. First get the virtualenv program as described in the previous section and create your virtual environment like this: :: virtualenv mudenv --python=/usr/bin/pypy Replace ``/usr/bin/pypy`` with the full path to your PyPy binary on your system. Next you activate and set up the virtual environment as normal. Make sure to install all dependencies to the virtual environment. If ``pip`` aborts with a message about "dependence is already satisfied", use the --upgrade option. This way PyPy-enhanced versions of the dependencies will be installed wherever applicable. Download and configure Evennia as usual. Then just start it like this: :: pypy evennia.py -i start Inside the game you can do the following (as superuser) to test that PyPy is working: :: @py import __pypy__ If this works Evennia is running under pypy. If you get an ImportError there was some problem and normal Python is still being used.