API Summary¶
evennia - library source tree
evennia.accounts - the out-of-character entities representing players
evennia.commands - handle all inputs. Also includes default commands
evennia.comms - in-game channels and messaging
evennia.contrib - game-specific tools and code contributed by the community
evennia.help - in-game help system
evennia.locks - limiting access to various systems and resources
evennia.objects - all in-game entities, like Rooms, Characters, Exits etc
evennia.prototypes - customize entities using dicts
evennia.scripts - all out-of-character game objects
evennia.server - core Server and Portal programs, also network protocols
evennia.typeclasses - core database-python bridge
evennia.utils - lots of useful coding tools and utilities
evennia.web - webclient, website and other web resources
Shortcuts¶
Evennia’s ‘flat API’ has shortcuts to common tools, available by only importing evennia
.
The flat API is defined in __init__.py
viewable here
Main config¶
evennia.settings_default - all settings (modify/override in
mygame/server/settings.py
)
Search functions¶
Create functions¶
Typeclasses¶
evennia.DefaultAccount - player account class (docs)
evennia.DefaultGuest - base guest account class
evennia.DefaultObject - base class for all objects (docs)
evennia.DefaultCharacter - base class for in-game characters (docs)
evennia.DefaultRoom - base class for rooms (docs)
evennia.DefaultExit - base class for exits (docs)
evennia.DefaultScript - base class for OOC-objects (docs)
evennia.DefaultChannel - base class for in-game channels (docs)
Commands¶
evennia.Command - base Command class. See also
evennia.default_cmds.MuxCommand
evennia.CmdSet - base CmdSet class
evennia.default_cmds - access all default command classes as properties
evennia.syscmdkeys - access system command keys as properties
Utilities¶
evennia.utils.utils - mixed useful utilities
evennia.gametime - server run- and game time (docs)
evennia.logger - logging tools
evennia.ansi - ansi coloring tools
evennia.spawn - spawn/prototype system (docs)
evennia.lockfuncs - default lock functions for access control (docs)
evennia.EvMenu - menu system (docs)
evennia.EvTable - text table creater
evennia.EvForm - text form creator
Evennia.EvMore - text paginator
evennia.EvEditor - in game text line editor (docs)
evennia.utils.funcparser.Funcparser - inline parsing of functions (docs)
Global singleton handlers¶
evennia.TICKER_HANDLER - allow objects subscribe to tickers (docs)
evennia.MONITOR_HANDLER - monitor changes (docs)
evennia.SESSION_HANDLER - manages all sessionsmain session handler
Database core models (for more advanced lookups)¶
evennia.managers - contains shortcuts to all database managers
Contributions¶
evennia.contrib game-specific contributions and plugins