evennia/evennia/game_template
2015-03-01 11:54:22 -06:00
..
commands Renamed commands/commands.py back to commands/command.py, it is confusing Python to import from inside a package with a module named the same as the package - since Python always searches the current directory first, it will try to import from the internal module and not from the external package, leading to not finding the contents of the package. This appears to be more a limitation of the package structure than with Evennia, so solving it the simplest way. 2015-02-15 22:00:49 +01:00
server Made a better template for custom oob commands. 2015-02-14 23:47:16 +01:00
typeclasses Changed Script to DefaultScript to be consistent with other default typeclasses. 2015-01-24 19:08:54 +01:00
web Fixed comment and wording on web templates. 2015-03-01 11:54:22 -06:00
world Added README.md files to the game_template directories. 2015-01-17 00:04:05 +01:00
.gitignore Added .gitignore file to template 2015-02-02 16:15:39 +01:00
__init__.py Added better docstrings to subpackages and cleaned out some places which were unclear. 2015-02-23 17:46:42 +01:00
README.md Some minor typos in game template 2015-02-11 15:12:25 +01:00

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 you can re-arrange things in this game-directory to suit your own sense of organisation (the only exception is the directory structure of the server/ directory, which Evennia expects). If you change the structure you must however also edit/add to your settings file to tell Evennia 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

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.