Beginner Tutorial

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

You can pick what seems interesting, but if you follow through to the end you will have created a little online game of your own to play and share with others!

Use the menu on the right to get the index of each tutorial-part. Use the next and previous links at the top/bottom right of the page to step between lessons.

Things you need

  • A Command line

  • A MUD client (or web browser)

  • A text-editor/IDE

  • Evennia installed and a game-dir initialized

A Command line

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

Note that we usually only show forward-slashes / for file system paths. Windows users should mentally convert this to back-slashes \ instead.

A fresh game dir?

You should make sure you have successfully installed Evennia. If you followed the instructions you will already have created a game-dir. You could re-use that or make a new one only for this tutorial, it’s up to you.

If you already have a game dir and want a separate one for the tutorial, use evennia stop to halt the running server and then Initialize a new game dir somewhere else (not inside the previous game dir!). We refer to it everywhere as mygame, so you may want to use that name too.

A MUD client

You might already have a MUD-client you prefer. Check out the grid of supported clients. If telnet’s not your thing, you can also just use Evennia’s web client in your browser.

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

In this documentation we often use the terms ‘MUD’, ‘MU’ or ‘MU*’ interchangeably to represent all the historically different forms of text-based multiplayer game-styles, like MUD, MUX, MUSH, MUCK, MOO and others. Evennia can be used to create all those game-styles and more.

A text Editor or IDE

You need a text-editor to edit Python source files. Most everything that can edit and output raw text works (so not Word).

  • Here’s a blog post summing up some of the alternatives - these things don’t change much from year to year. Popular choices for Python are PyCharm, VSCode, Atom, Sublime Text and Notepad++. Evennia is to a very large degree coded in VIM, but that’s not suitable for beginners.


Use spaces, not tabs Make sure to configure your editor so that pressing TAB inserts 4 spaces rather than a Tab-character. Since Python is whitespace-aware, this will make your life a lot easier.

You should now be ready to move on to the first part of the 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.