Evennia Documentation

This is the manual of Evennia, the open source Python MU* creation system. Use the Search bar on the left to find or discover interesting articles.

• Introduction - what is this Evennia thing?

• Evennia in Pictures - a visual overview of Evennia

• Contributing and Getting help - when you get stuck or want to chip in

Setup

• Installation - getting started

• Running the Game - how to start, stop and reload Evennia

• Updating the Server - how to update Evennia

• Configuration - how to set up Evennia the way you like it

• Going Online - bringing your game online

Tutorials and Howtos

• The Beginner Tutorial - learn the basics and build a small game (in progress)

• Tutorials and Howto’s - mixed tutorials and help articles to learn Evennia

• Coding with Evennia - resources and hints for coding and development

The Evennia Library

• Core components - the core building blocks of Evennia

• Core Concepts - larger-scale concepts and features

• API - the full API-reference, generated from source

Contributions and Info

• Contribs - game-specific code and snippets to use for your game

• Documentation - how to contribute - if you want to help out with this manual

• License - Evennia licensing FAQ

• Links - useful links if you need extra reading

---

All Sections

Click here to expand the full Documentation index.

• Evennia Introduction
  • What is Evennia?
    • Bare-bones?
    • Framework?
    • Server?
    • Python?
  • Can I test it somewhere?
  • What do I need to know to work with Evennia?
    • I don’t know (or don’t want to do) any programming - I just want to run a game!
    • I know basic Python, or I am willing to learn
    • I know my Python stuff and I am willing to use it!
  • Where to from here?
• Evennia in pictures
  • The two main Evennia pieces
    • Initializing the game folder
  • The database
    • From database to Python
    • Attributes
  • Controlling the action
    • Commands
    • Command Sets
    • Merging Command Sets
  • Now go and explore!
• Start Stop Reload
  • Starting Evennia
  • Reloading
  • Stopping
  • Foreground mode
  • Resetting
  • Rebooting
  • Status and info
  • Killing (Linux/Mac only)
  • Django options
  • Advanced handling of Evennia processes
    • Syntax errors during live development
• Updating Evennia
  • If you installed with pip
  • If you installed with git
  • If you installed with docker
  • Resetting your database
    • SQLite3 (default)
    • PostgreSQL
    • MySQL/MariaDB
    • What are database migrations?
• Server Setup and Life
  • Installation and running
    • Installation
    • Installing with GIT
    • Installing with Docker
    • Installation Troubleshooting
    • Installing on Android
    • Upgrading an existing installation
    • Non-interactive setup
    • Start Stop Reload
    • Updating Evennia
  • Configuration
    • Changing Game Settings
    • Evennia Default settings file
    • Choosing a database
    • Connect Evennia channels to Discord
    • Connect Evennia channels to Grapevine
    • Connect Evennia channels to IRC
    • Connect Evennia channels to RSS
    • Connect Evennia to Twitter
  • Going Online
    • Evennia Game Index
    • Online Setup
    • Client Support Grid
    • Security Hints and Practices
    • Configuring HAProxy
    • Configuring NGINX for Evennia with SSL
    • Configuring an Apache Proxy
• Tutorials and How-To’s
  • Beginner Tutorial
    • Beginner Tutorial
    • Part 1: What We Have
    • Part 2: What we want
    • Part 3: How we get there (example game)
    • Part 4: Using what we created
    • Part 5: Showing the world
  • How-To’s
    • Adding a Command Prompt
    • Adding Command Cooldowns
    • Commands that take time to finish
    • Return custom errors on missing Exits
    • Give objects weight
    • NPCs that listen to what is said
    • NPCs reacting to your presence
    • NPC merchants
    • Building a giant mech
    • Building a train that moves
  • Systems
    • Making a Persistent object Handler
    • Changing game calendar and time speed
    • Adding Weather messages to a Room
    • Adding room coordinates to your game
    • Show a dynamic map of rooms
  • Website Tutorials
    • Changing the Game Website
    • Add a wiki on your website
    • Web Character Generation
    • Web Character View Tutorial
    • Help System Tutorial
    • Extending the REST API
    • Automatically Tweet game stats
  • Deep Dives
    • Parsing command arguments, theory and best practices
    • Understanding Color Tags
    • Evennia for roleplaying sessions
    • Evennia for Diku Users
    • Evennia for MUSH Users
    • Using the Arxcode game dir
  • Old Tutorials
    • Implementing a game rule system
    • Turn based Combat System
    • Tutorial for basic MUSH like game
• Core Components
  • Base components
    • Portal And Server
    • Sessions
    • Typeclasses
    • Accounts
    • Objects
    • Characters
    • Rooms
    • Exits
    • Scripts
    • Channels
    • Msg
    • Attributes
    • Nicks
    • Tags
    • Spawner and Prototypes
    • Help System
    • Permissions
    • Locks
  • Commands
    • Commands
    • Command Sets
    • Default Commands
    • Batch Processors
    • Inputfuncs
  • Utils and tools
    • Coding Utils
    • EvEditor
    • EvForm
    • EvMenu
    • EvMore
    • EvTable
    • FuncParser inline text parsing
    • MonitorHandler
    • TickerHandler
    • Signals
  • Web components
    • Game website
    • Web Client
    • The Web Admin
    • Webserver
    • Evennia REST API
    • Bootstrap frontend framework
• Core Concepts
  • General concepts
    • The Message path
    • Out-of-Band messaging
    • Async Process
  • Text processing
    • In-text tags parsed by Evennia
    • Messages varying per receiver
    • Internationalization
    • Text Encodings
  • Access
    • Character connection styles
    • Guest Logins
    • Banning
  • Extending the Server
    • Protocols
    • New Models
    • Zones
• Coding and development help
  • Evennia Code Style
    • Main code style specification
    • Code Docstrings
    • Default Command Docstrings
    • Tools for auto-linting
  • Default Command Syntax
  • Coding using Version Control
    • Setting up Git
    • Common Git commands
    • Putting your game dir under version control
    • Contributing to Evennia
    • Troubleshooting
  • Debugging
    • Debugging Evennia
    • A simple example using pdb
    • Cheat-sheet of pdb/pudb commands
  • Unit Testing
    • Running the Evennia test suite
    • Running custom game-dir unit tests
    • Writing new unit tests
  • Profiling
    • Simple timer tests
    • Using cProfile
    • The Dummyrunner
  • Continuous Integration (CI)
    • Continuous-Integration guides
  • Setting up PyCharm with Evennia
    • Debug Evennia from inside PyCharm
    • Run Evennia from inside PyCharm
  • Evennia Changelog
    • Changelog
    • Overview-Changelogs
    • Older
• Contribs
  • Index
  • base_systems
    • AWSstorage system
    • Building menu
    • Additional Color markups
    • Components
    • Custom gameime
    • Email-based login system
    • Godot Websocket
    • Evennia in-game Python system
    • Menu-based login system
    • Legacy Comms-commands
    • Unix-like Command style
    • awsstorage
    • building_menu
    • color_markups
    • components
    • custom_gametime
    • email_login
    • godotwebsocket
    • ingame_python
    • menu_login
    • mux_comms_cmds
    • unixcommand
  • full_systems
    • EvscapeRoom
    • evscaperoom
  • game_systems
    • Barter system
    • Clothing
    • Containers
    • Cooldowns
    • Crafting system
    • Gendersub
    • In-Game Mail system
    • Evennia Multidescer
    • Puzzles System
    • Turn based battle system framework
    • barter
    • clothing
    • containers
  • Installation
    • cooldowns
    • crafting
    • gendersub
    • mail
    • multidescer
    • puzzles
    • turnbattle
  • grid
    • Extended Room
    • Basic Map
    • Map Builder
    • SimpleDoor
    • Slow Exit
    • Wilderness system
    • XYZgrid
    • extended_room
    • ingame_map_display
    • mapbuilder
    • simpledoor
    • slow_exit
    • wilderness
    • xyzgrid
  • rpg
    • Buffs
    • Character Creator
    • Dice roller
    • Health Bar
    • Large Language Model (“Chat-bot AI”) integration
    • Roleplaying base system for Evennia
    • Traits
    • buffs
    • character_creator
    • dice
    • health_bar
    • llm
    • rpsystem
    • traits
  • tutorials
    • Batch processor examples
    • Script example
    • EvAdventure
    • TutorialMirror
    • Red Button example
    • Talkative NPC example
    • Evennia Tutorial World
    • batchprocessor
    • bodyfunctions
    • evadventure
    • mirror
    • red_button
    • talking_npc
    • tutorial_world
  • utils
    • Input/Output Auditing
    • Easy fillable form
    • In-game Git Integration
    • Random Name Generator
    • Pseudo-random generator and registry
    • Easy menu selection tree
    • auditing
    • fieldfill
    • git_integration
    • name_generator
    • random_string_generator
    • tree_select
• How To Contribute And Get Help
  • Getting Help
  • Giving Help
    • Help with Documentation
    • Helping with code
    • Helping with Donations
• Contributing to Evennia Docs
  • Source file structure
  • Editing syntax
    • Italic/Bold
    • Headings
    • Lists
    • Blockquotes
    • Links
    • Urls/References in one place
    • Tables
    • Verbatim text
    • Code blocks
    • MyST directives
  • Writing Code docstrings for autodocs
  • Building the docs locally
    • Building only the main documentation
    • Building the main documentation and API docs
    • Building multiversion docs
• Licensing Q&A
• Links
  • Official Evennia resources
  • Evennia Community
  • Third-party
    • Other
  • General MU* resources
    • Tools
    • Informational
    • Interesting Communities
  • General Game-Dev Resources
    • Tools
    • Frameworks
    • Learning Python
    • General RPG
    • Literature