mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
278 lines
10 KiB
Python
278 lines
10 KiB
Python
"""
|
|
|
|
Central API for the Evennia MUD/MUX/MU* creation system.
|
|
|
|
This is basically a set of shortcuts for accessing things in src/ with less boiler plate.
|
|
Import this from your code, use it with @py from in-game or explore it interactively from
|
|
a python shell.
|
|
|
|
Notes:
|
|
|
|
0) Use ev.help(), ev.managers.help(), ev.default_cmds.help() and syscmdkeys.help() to
|
|
view the API structure and explore which variables/methods are available.
|
|
|
|
1) You should import things explicitly from the root of this module - you can not use
|
|
dot-notation to import deeper. Hence, to access a default command, you can do
|
|
import ev
|
|
ev.default_cmds.CmdLook
|
|
or
|
|
from ev import default_cmds
|
|
default_cmds.CmdLook
|
|
But trying to import CmdLook directly with "from ev.default_cmds import CmdLook" will
|
|
not work since default_cmds is a property on the "ev" module, not a module of its own.
|
|
|
|
2) "managers" is a container object that contains shortcuts to initiated versions of Evennia's django
|
|
database managers (e.g. managers.objects is an alias for ObjectDB.objects). These allow
|
|
for exploring the database in various ways. To use in code, do 'from ev import managers', then
|
|
access the managers on the managers object. Please note that the evennia-specific methods in
|
|
managers return typeclasses (or lists of typeclasses), whereas the default django ones (filter etc)
|
|
return database objects. You can convert between the two easily via dbobj.typeclass and
|
|
typeclass.dbobj, but it's worth to remember this difference.
|
|
|
|
3) "syscmdkeys" is a container object holding the names of system commands. Import with
|
|
'from ev import syscmdkeys', then access the variables on the syscmdkeys object.
|
|
|
|
4) You -have- to use the create_* functions (shortcuts to src.utils.create) to create new
|
|
Typeclassed game entities (Objects, Scripts or Players). Just initializing e.g. the Player class will
|
|
-not- set up Typeclasses correctly and will lead to errors. Other types of database objects
|
|
can be created normally, but there are conveniant create_* functions for those too, making
|
|
some more error checking.
|
|
|
|
5) "settings" links to Evennia's game/settings file. "settings_full" shows all of django's available
|
|
settings. Note that this is for viewing only - you cannot *change* settings from here in a meaningful
|
|
way but have to update game/settings.py and restart the server.
|
|
|
|
6) The API accesses all relevant and most-neeeded functions/classes from src/ but might not
|
|
always include all helper-functions referenced from each such entity. To get to those, access
|
|
the modules in src/ directly. You can always do this anyway, if you do not want to go through
|
|
this API.
|
|
"""
|
|
|
|
import sys, os
|
|
|
|
######################################################################
|
|
# set Evennia version in __version__ property
|
|
######################################################################
|
|
|
|
try:
|
|
f = open(os.path.dirname(os.path.abspath(__file__)) + os.sep + "VERSION", 'r')
|
|
__version__ = "Evennia %s-r%s" % (f.read().strip(), os.popen("hg id -i").read().strip())
|
|
f.close()
|
|
del f
|
|
except IOError:
|
|
__version__ = "Evennia (unknown version)"
|
|
|
|
######################################################################
|
|
# Stop erroneous direct run (would give a traceback since django is
|
|
# not yet initialized)
|
|
######################################################################
|
|
|
|
if __name__ == "__main__":
|
|
print \
|
|
"""
|
|
Evennia MU* creation system (%s)
|
|
|
|
This module gives access to Evennia's API (Application Programming
|
|
Interface). It should *not* be run on its own, but be imported and
|
|
accessed from your code or explored interactively from a Python
|
|
shell.
|
|
|
|
For help configuring and starting the Evennia server, see the
|
|
INSTALL file. More help can be found at http://www.evennia.com.
|
|
""" % __version__
|
|
sys.exit()
|
|
|
|
######################################################################
|
|
# make sure settings is available, also if starting this API stand-alone
|
|
# make settings available, and also the full django settings
|
|
######################################################################
|
|
|
|
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
from django.conf import settings as settings_full
|
|
from game import settings
|
|
try:
|
|
settings_full.configure()
|
|
except RuntimeError:
|
|
pass
|
|
del sys, os
|
|
|
|
try:
|
|
import src.objects
|
|
except (ImportError, AttributeError):
|
|
err = "\nInitializing ev.py: The correct environment variables were not set."
|
|
err += "\nUse \"python game/manage.py shell\" to start an interpreter"
|
|
err += " with everything set up correctly."
|
|
raise ImportError(err)
|
|
del src.objects
|
|
|
|
######################################################################
|
|
# Start Evennia API
|
|
# (easiest is to import this module interactively to explore it)
|
|
######################################################################
|
|
|
|
README = __doc__
|
|
|
|
# help entries
|
|
from src.help.models import HelpEntry
|
|
|
|
# players
|
|
from src.players.player import Player
|
|
from src.players.models import PlayerDB, PlayerAttribute, PlayerNick
|
|
|
|
# commands
|
|
from src.commands.command import Command
|
|
from src.commands.cmdset import CmdSet
|
|
# (default_cmds is created below)
|
|
|
|
# locks
|
|
from src.locks import lockfuncs
|
|
|
|
# scripts
|
|
from src.scripts.scripts import Script
|
|
|
|
# comms
|
|
from src.comms.models import Msg, Channel, PlayerChannelConnection, ExternalChannelConnection
|
|
|
|
# objects
|
|
from src.objects.objects import Object, Character, Room, Exit
|
|
|
|
# utils
|
|
|
|
from src.utils.search import *
|
|
from src.utils.create import *
|
|
from src.utils import logger
|
|
from src.utils import utils
|
|
from src.utils import gametime
|
|
from src.utils import ansi
|
|
|
|
######################################################################
|
|
# API containers and helper functions
|
|
######################################################################
|
|
|
|
def help(header=False):
|
|
"""
|
|
Main Evennia API.
|
|
ev.help() views API contents
|
|
ev.help(True) or ev.README shows module instructions
|
|
|
|
See www.evennia.com for the full documentation.
|
|
"""
|
|
if header:
|
|
return __doc__
|
|
else:
|
|
import ev
|
|
names = [var for var in ev.__dict__ if not var.startswith('_')]
|
|
return ", ".join(names)
|
|
|
|
class _EvContainer(object):
|
|
"""
|
|
Parent for other containers
|
|
|
|
"""
|
|
def help(self):
|
|
"Returns list of contents"
|
|
names = [name for name in self.__class__.__dict__ if not name.startswith('_')]
|
|
names += [name for name in self.__dict__ if not name.startswith('_')]
|
|
return self.__doc__ + "-"*60 + "\n" + ", ".join(names)
|
|
|
|
class DBmanagers(_EvContainer):
|
|
"""
|
|
Links to instantiated database managers.
|
|
|
|
helpentry - HelpEntry.objects
|
|
players - PlayerDB.objects
|
|
scripts - ScriptDB.objects
|
|
msgs - Msg.objects
|
|
channels - Channel.objects
|
|
connections - PlayerChannelConnection.objects
|
|
externalconnections - ExternalChannelConnection.objects
|
|
objects - ObjectDB.objects
|
|
|
|
"""
|
|
from src.help.models import HelpEntry
|
|
from src.players.models import PlayerDB
|
|
from src.scripts.models import ScriptDB
|
|
from src.comms.models import Msg, Channel, PlayerChannelConnection, ExternalChannelConnection
|
|
from src.objects.models import ObjectDB
|
|
from src.server.models import ServerConfig
|
|
|
|
helpentry = HelpEntry.objects
|
|
players = PlayerDB.objects
|
|
scripts = ScriptDB.objects
|
|
msgs = Msg.objects
|
|
channels = Channel.objects
|
|
connections = PlayerChannelConnection.objects
|
|
externalconnections = ExternalChannelConnection.objects
|
|
objects = ObjectDB.objects
|
|
serverconfigs = ServerConfig.objects
|
|
del HelpEntry, PlayerDB, ScriptDB, Msg, Channel, PlayerChannelConnection,
|
|
del ExternalChannelConnection, ObjectDB, ServerConfig
|
|
|
|
managers = DBmanagers()
|
|
del DBmanagers
|
|
|
|
class DefaultCmds(_EvContainer):
|
|
"""
|
|
This container holds direct shortcuts to all default commands in Evennia.
|
|
|
|
To access in code, do 'from ev import default_cmds' then
|
|
access the properties on the imported default_cmds object.
|
|
|
|
"""
|
|
|
|
from src.commands.default.cmdset_character import CharacterCmdSet
|
|
from src.commands.default.cmdset_player import PlayerCmdSet
|
|
from src.commands.default.cmdset_unloggedin import UnloggedinCmdSet
|
|
from src.commands.default.muxcommand import MuxCommand, MuxPlayerCommand
|
|
|
|
def __init__(self):
|
|
"populate the object with commands"
|
|
|
|
def add_cmds(module):
|
|
"helper method for populating this object with cmds"
|
|
cmdlist = utils.variable_from_module(module, module.__all__)
|
|
self.__dict__.update(dict([(c.__name__, c) for c in cmdlist]))
|
|
|
|
from src.commands.default import admin, batchprocess, building, comms, general, player, help, system, unloggedin
|
|
add_cmds(admin)
|
|
add_cmds(building)
|
|
add_cmds(batchprocess)
|
|
add_cmds(building)
|
|
add_cmds(comms)
|
|
add_cmds(general)
|
|
add_cmds(player)
|
|
add_cmds(help)
|
|
add_cmds(system)
|
|
add_cmds(unloggedin)
|
|
default_cmds = DefaultCmds()
|
|
del DefaultCmds
|
|
|
|
class SystemCmds(_EvContainer):
|
|
"""
|
|
Creating commands with keys set to these constants will make
|
|
them system commands called as a replacement by the parser when
|
|
special situations occur. If not defined, the hard-coded
|
|
responses in the server are used.
|
|
|
|
CMD_NOINPUT - no input was given on command line
|
|
CMD_NOMATCH - no valid command key was found
|
|
CMD_MULTIMATCH - multiple command matches were found
|
|
CMD_CHANNEL - the command name is a channel name
|
|
CMD_LOGINSTART - this command will be called as the very
|
|
first command when a player connects to
|
|
the server.
|
|
|
|
To access in code, do 'from ev import syscmdkeys' then
|
|
access the properties on the imported syscmdkeys object.
|
|
|
|
"""
|
|
from src.commands import cmdhandler
|
|
CMD_NOINPUT = cmdhandler.CMD_NOINPUT
|
|
CMD_NOMATCH = cmdhandler.CMD_NOMATCH
|
|
CMD_MULTIMATCH = cmdhandler.CMD_MULTIMATCH
|
|
CMD_CHANNEL = cmdhandler.CMD_CHANNEL
|
|
CMD_LOGINSTART = cmdhandler.CMD_LOGINSTART
|
|
del cmdhandler
|
|
syscmdkeys = SystemCmds()
|
|
del SystemCmds
|
|
del _EvContainer
|