Core Components

These are the ‘building blocks’ out of which Evennia is built. This documentation is complementary to, and often goes deeper than, the doc-strings of each component in the API.

Database entites

• Typeclasses
  • Difference between typeclasses and classes
  • Creating a new typeclass
  • About typeclass properties
  • Overloading hooks
  • Querying for typeclasses
  • Updating existing typeclass instances
  • Swap typeclass
  • How typeclasses actually work
  • Caveats
• Sessions
  • Properties on Sessions
  • Multisession mode
  • Returning data to the session
  • Customizing the Session object
  • Portal and Server Sessions
  • Sessionhandlers
• Accounts
  • How to create your own Account types
  • Properties on Accounts
• Objects
  • How to create your own object types
  • Adding common functionality
  • Properties and functions on Objects
  • Subclasses of Object
• Scripts
  • In-game command examples
  • Code examples
  • Defining new Scripts
  • Timed Scripts
  • Script attached to another object
  • Other Script methods
  • The GLOBAL_SCRIPTS container
  • Hints: Dealing with Script Errors
• Channels
  • Using channels in-game
  • Allowing Characters to use Channels
  • Customizing channel output and behavior
  • Channels in code
  • Channel logging
• Msg
  • Msg in code
  • TempMsg
• Attributes
  • Managing Attributes in Code
  • Managing Attributes in-game
  • Locking and checking Attributes
  • What types of data can I save in an Attribute?
  • Properties of Attributes
  • In-memory Attributes (NAttributes)
• Nicks
  • Coding with nicks
  • Advanced note
• Tags
  • Properties of Tags (and Aliases and Permissions)
  • Adding/Removing Tags
  • Searching for objects with a given tag
  • Using Aliases and Permissions
  • Assorted notes
• Spawner and Prototypes
  • Using the OLC
  • The prototype
  • Storing prototypes
  • Using @spawn
  • Using evennia.prototypes.spawner()
• Help System
  • Using the help system from in-game
  • Sources of help entries
  • Entry priority
  • Locking help entries
  • Customizing the look of the help system
  • Technical notes
• Permissions
  • Managing Permissions
  • The permission hierarchy
  • Checking permissions
  • Superusers
  • Quelling

Commands

• Command System
• Commands
  • Defining Commands
  • Exiting a command
  • Pauses in commands
  • Asking for user input
  • System commands
  • Dynamic Commands
  • Exits
  • Command instances are re-used
  • Dynamically created commands
  • How commands actually work
  • Assorted notes
• Command Sets
  • Defining Command Sets
  • Command Sets Searched
  • Adding and Merging Command Sets
• Default Commands
• Connection Screen
  • Commands available at the Connection Screen
• Batch Processors
  • A note on File Encodings
• Batch Code Processor
  • Basic Usage
  • The batch file
  • Debug mode
  • Interactive mode
  • Limitations and Caveats
• Batch Command Processor
  • Basic Usage
  • The batch file
  • Interactive mode
  • Limitations and Caveats
  • Assorted notes

Utils and tools

• Coding Utils
  • Searching
  • Create
  • Logging
  • Time Utilities
  • Object Classes
  • Text utilities
  • Display utilities
• EvEditor
  • Launching the editor
  • Example of usage
  • Persistent editor
  • Line editor usage
  • The EvEditor to edit code
• EvMenu
  • Introduction
  • Launching the menu
  • The Menu nodes
  • Temporary storage
  • Customizing Menu formatting
  • EvMenu templating language
  • Examples:
  • Ask for simple input
  • The @list_node decorator
  • Assorted notes
• EvMore
  • Using EvMore
• MonitorHandler
  • Using the MonitorHandler
• TickerHandler
  • About Tickers
• Locks
  • Setting and checking a lock
  • Defining locks
  • Checking simple strings
  • Default locks
  • More Lock definition examples
  • A complete example of setting locks on an object
  • On Django’s permission system
• The Inline Function Parser
  • Uses in default Evennia
  • Using the FuncParser
  • Defining custom callables
  • Default callables

Web components

• Game website
  • Modifying the default Website
  • Examples of commom web changes
  • Adding a new web page
  • User forms
• Evennia REST API
  • Usage
  • Customizing the API
• The Web Admin
  • Usage
  • Grant others access to the admin
  • Customizing the web admin

Server and network

• Portal And Server
• Inputfuncs
  • Adding your own inputfuncs
  • Default inputfuncs
  • unmonitor
• Outputfuncs
• Server component
• Webserver
  • Basic Webserver data flow
• Web Client
  • Customizing the 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
  • GoldenLayout
• Bootstrap Components and Utilities
  • General Styling
  • Components
• Signals
  • Attaching a handler to a signal
  • Available signals