Beginner Tutorial

Welcome to Evennia! This multi-part Beginner Tutorial will help get you off the ground and running.

You may choose topics that seem interesting but, if you follow this tutorial through to the end, you will have created your own small online game to play and share with others!

Use the menu on the right to navigate the index of each of the tutorial’s parts. Use the next and previous links at the top/bottom right of each page to jump between lessons.

Things You Need

  • A command line interface

  • A MUD client (or web browser)

  • A text-editor/IDE

  • Evennia installed and a game-dir initialized

A Command Line Interface

You need to know how to find the terminal/console in your OS. The Evennia server can be controlled from in-game, but you will realistically need to use the command-line interface to get anywhere. Here are some starters:

Note that the documentation typically uses forward-slashes (/) for file system paths. Windows users should convert these to back-slashes (\) instead.

A Fresh Game-Dir?

You should make sure that you have successfully installed Evennia. If you followed the instructions, you will have already created a game-dir. The documentation will continue to refer to this game-dir as mygame, so you may want to re-use it or make a new one specific to this tutorial only – it’s up to you.

If you already have a game-dir and want a new one specific to this tutorial, use the evennia stop command to halt the running server. Then, initialize a new game-dir somewhere else (not inside the previous game-dir!).

A MUD Client

You may already have a preferred MUD client. Check out the grid of supported clients. Or, if telnet’s not your thing, you may also simply use Evennia’s web-client in your preferred browser.

Make sure you know how to connect and log in to your locally running Evennia server.

In this documentation we often interchangeably use the terms ‘MUD’, ‘MU’, and ‘MU*’ to represent all the historically different forms of text-based multiplayer game-styles (i.e., MUD, MUX, MUSH, MUCK, MOO, etc.). Evennia can be used to create any of these game-styles… and more!

A Text Editor or IDE

You need a text editor application to edit Python source files. Most anything that can edit and output raw text should work (…so not Microsoft Word).


Use Spaces, Not Tabs< br/> Make sure to configure your text editor so that pressing the ‘Tab’ key inserts 4 spaces rather than a tab-character. Because Python is whitespace-aware, this simple practice will make your life much easier.

You should now be ready to move on to the first part of the Beginner Tutorial! (In the future, use the previous | next buttons on the top/bottom of the page to progress.)

Click here to see the full index of all parts and lessons of the Beginner-Tutorial.