Warning
This is the WIP documentation of the development branch of Evennia (v1.0-dev).
Unless you are beta-testing the new version, you are likely best off using v0.9.5 of the docs (switch to it in the bottom left) or the original github wiki. You have been warned.
Evennia Documentation¶
This is the manual of Evennia, the open source Python
MU* creation system.
Main sections¶
Server Setup, Maintenance and Life - how to run, maintain and release
Tutorials and Howto’s - projects and hints for reaching particular effects and goals
Core components - the core building blocks of Evennia
Concepts - larger-scale concepts and features
API - the full API-reference, generated from source
Default Commands - list of game commands included out of the box
Coding - coding and development hints and resources
Contribs - game-specific tools and code added by the community
Links - useful links
How to contribute to these docs - if you want to help out
All Sections¶
Click here to expand the full list of Documentation sections.
- Evennia Introduction
- Server Setup and Life
- Tutorials and Howto’s
- Core Components
- Database entites
- Commands
- Utils and tools
- Web components
- Server and network
- Portal And Server
- Inputfuncs
- Outputfuncs
- Server component
- Webserver
- Web Client
- Evennia Web Client API (from evennia.js)
- Plugin Manager API (from webclient_gui.js)
- Plugin callbacks API
- Example/Default Plugins (plugins/*.js)
- A side note on html messages vrs text2html messages
- Writing your own Plugins
- Bootstrap Components and Utilities
- Signals
- Core Concepts
- Coding and development help
- Contribs
- base_systems
- AWSstorage system
- Building menu
- Additional Color markups
- Components
- The Components Contrib
- Pros
- Cons
- How to install
- Full Example
- Custom gameime
- Email-based login system
- Evennia in-game Python system
- Menu-based login system
- Legacy Comms-commands
- Unix-like Command style
- Contrib:
awsstorage - Contrib:
building_menu - Contrib:
color_markups - Contrib:
components
- base_systems
- The Components Contrib
- Contrib:
custom_gametime - Contrib:
email_login - Contrib:
ingame_python - Contrib:
menu_login - Contrib:
mux_comms_cmds - Contrib:
unixcommand - full_systems
- game_systems
- Barter system
- Clothing
- Cooldowns
- Crafting system
- Gendersub
- In-Game Mail system
- Evennia Multidescer
- Puzzles System
- Turn based battle system framework
- Contrib:
barter - Contrib:
clothing - Contrib:
cooldowns - Contrib:
crafting - Contrib:
gendersub - Contrib:
mail - Contrib:
multidescer - Contrib:
puzzles - Contrib:
turnbattle
- grid
- rpg
- tutorials
- utils
- Contrib:
- How To Contribute And Get Help
- Contributing to Evennia Docs
- Licensing Q&A
- Links