evennia package

Evennia ‘flat’ API (use evennia.<component>.__doc__ to read doc-strings

and dict(evennia.component) or evennia.component.__dict__ to see contents)

Typeclass-bases: Database models:
DefaultAccount DefaultObject AccountDB ObjectDB
DefaultGuest DefaultCharacter ChannelDB

DefaultRoom ScriptDB

DefaultChannel DefaultExit Msg DefaultScript

Search functions: Command parents and helpers:

search_account search_object default_cmds search_script search_channel Command InterruptCommand search_help search_message CmdSet search_tag managers Utilities:

Create functions: settings lockfuncs

create_account create_object logger gametime create_script create_channel ansi spawn create_help_entry create_message contrib managers

Global handlers: set_trace

TICKER_HANDLER TASK_HANDLER EvMenu EvTable SESSION_HANDLER CHANNEL_HANDLER EvForm EvEditor

evennia._init()[source]

This function is called automatically by the launcher only after Evennia has fully initialized all its models. It sets up the API in a safe environment where all models are available already.

evennia.set_trace(term_size=(140, 80), debugger='auto')[source]

Helper function for running a debugger inside the Evennia event loop.

Parameters

  • term_size (tuple, optional) – Only used for Pudb and defines the size of the terminal (width, height) in number of characters.

  • debugger (str, optional) – One of ‘auto’, ‘pdb’ or ‘pudb’. Pdb is the standard debugger. Pudb is an external package with a different, more ‘graphical’, ncurses-based UI. With ‘auto’, will use pudb if possible, otherwise fall back to pdb. Pudb is available through pip install pudb.

Notes

To use:

  1. add this to a line to act as a breakpoint for entering the debugger:

    from evennia import set_trace; set_trace()

  2. restart evennia in interactive mode

    evennia istart

  3. debugger will appear in the interactive terminal when breakpoint is reached. Exit with ‘q’, remove the break line and restart server when finished.

Subpackages

Submodules

evennia.settings_default module

Master configuration file for Evennia.

NOTE: NO MODIFICATIONS SHOULD BE MADE TO THIS FILE!

All settings changes should be done by copy-pasting the variable and its value to <gamedir>/server/conf/settings.py.

Hint: Don’t copy&paste over more from this file than you actually want to change. Anything you don’t copy&paste will thus retain its default value - which may change as Evennia is developed. This way you can always be sure of what you have changed and what is default behaviour.