evennia/game/gamesrc/conf/examples/server_services_plugin.py

24 lines
813 B
Python

"""
This plugin module can define user-created services for the Portal to start.
To use, copy this module up one level to game/gamesrc/conf/ and set
settings.PORTAL_SERVICES_PLUGIN_MODULE to point to this module.
This module must handle all imports and setups required to start a twisted
service (see examples in src/server/server.py). It must also contain a
function start_plugin_services(application). Evennia will call this function
with the main Portal application (so your services can be added to it). The
function should not return anything. Plugin services are started last in
the Portal startup process.
"""
def start_plugin_services(portal):
"""
This hook is called by Evennia, last in the Portal startup process.
portal - a reference to the main portal application.
"""
pass