Updated the game template, renaming subdir typeclasses rather than types since the latter collides with the python library module of the same name.

bin/evennia.py

@@ -16,7 +16,7 @@ import shutil
 import importlib
 from argparse import ArgumentParser
 from subprocess import Popen
-from django.core import management
+import django
 
 # Signal processing
 SIG = signal.SIGINT
@@ -87,9 +87,9 @@ CREATED_NEW_GAMEDIR = \
     """
     ... Created new Evennia game directory '{gamedir}'.
 
-    Inside your new game directory, edit {settings_path} to suit your
+    Inside your new game directory, you can now optionally edit
-    setup, then run this command again from inside the game directory
+    {settings_path} to suit your setup. Then run this command again
-    to start the server.
+    from inside the game directory to start the server.
     """
 
 ERROR_NO_GAMEDIR = \
@@ -433,13 +433,12 @@ def init_game_directory(path):
     # Prepare django; set the settings location
     os.environ['DJANGO_SETTINGS_MODULE'] = SETTINGS_DOTPATH
 
-    # testing the main library import. If there are errors in importing
+    # required since django1.7
-    # the main library, it should show here.
+    django.setup()
-    importlib.import_module("evennia")
 
     # test existence of the settings module
     try:
-        settings = importlib.import_module(SETTINGS_DOTPATH)
+        from django.conf import settings
     except Exception, ex:
         if not str(ex).startswith("No module named"):
             import traceback
@@ -447,16 +446,15 @@ def init_game_directory(path):
         print ERROR_SETTINGS
         sys.exit()
 
-    import django
+    # testing the main library import. If there are errors in importing
-    # required since django1.7.
+    # the main library, it should show here.
-    django.setup()
+    importlib.import_module("evennia")
 
     # check all dependencies
     from evennia.utils.utils import check_evennia_dependencies
     if not check_evennia_dependencies:
         sys.exit()
 
-
     # set up the Evennia executables and log file locations
     global SERVER_PY_FILE, PORTAL_PY_FILE
     global SERVER_LOGFILE, PORTAL_LOGFILE, HTTP_LOGFILE
@@ -523,16 +521,14 @@ def init_game_directory(path):
 
 
 def create_database():
-    from django.core.management import call_command
     print "\nCreating a database ...\n"
-    call_command("migrate", interactive=False)
+    django.core.management.call_command("migrate", interactive=False)
     print "\n ... database initialized.\n"
 
 
 def create_superuser():
-    from django.core.management import call_command
     print "\nCreate a superuser below. The superuser is Player #1, the 'owner' account of the server.\n"
-    call_command("createsuperuser", interactive=True)
+    django.core.management.call_command("createsuperuser", interactive=True)
 
 
 def check_database(automigrate=False):
@@ -589,7 +585,7 @@ def kill(pidfile, signal=SIG, succmsg="", errmsg="", restart_file=SERVER_RESTART
             os.remove(pidfile)
         # set restart/norestart flag
         if restart == 'reload':
-            management.call_command('collectstatic', interactive=False, verbosity=0)
+            django.core.management.call_command('collectstatic', interactive=False, verbosity=0)
         f = open(restart_file, 'w')
         f.write(str(restart))
         f.close()
@@ -715,7 +711,7 @@ def server_operation(mode, service, interactive, profiler):
             if interactive:
                 cmdstr.append('--iportal')
             cmdstr.append('--noserver')
-            management.call_command('collectstatic', verbosity=1, interactive=False)
+            django.core.management.call_command('collectstatic', verbosity=1, interactive=False)
         else:  # all
             # for convenience we don't start logging of
             # portal, only of server with this command.
@@ -723,7 +719,7 @@ def server_operation(mode, service, interactive, profiler):
                 cmdstr.append('--profile-server') # this is the common case
             if interactive:
                 cmdstr.append('--iserver')
-            management.call_command('collectstatic', verbosity=1, interactive=False)
+            django.core.management.call_command('collectstatic', verbosity=1, interactive=False)
         cmdstr.extend([GAMEDIR, TWISTED_BINARY, SERVER_LOGFILE, PORTAL_LOGFILE, HTTP_LOGFILE])
         # start the server
         Popen(cmdstr)
@@ -766,15 +762,20 @@ def error_check_python_modules():
     before we get any further.
     """
     from django.conf import settings
+    def imp(path, split=True):
+        mod, fromlist = path, "None"
+        if split:
+            mod, fromlist = path.rsplit('.', 1)
+            __import__(mod, fromlist=[fromlist])
 
     # core modules
-    importlib.import_module(settings.COMMAND_PARSER)
+    imp(settings.COMMAND_PARSER)
-    importlib.import_module(settings.SEARCH_AT_RESULT)
+    imp(settings.SEARCH_AT_RESULT)
-    importlib.import_module(settings.SEARCH_AT_MULTIMATCH_INPUT)
+    imp(settings.SEARCH_AT_MULTIMATCH_INPUT)
-    importlib.import_module(settings.CONNECTION_SCREEN_MODULE, split=False)
+    imp(settings.CONNECTION_SCREEN_MODULE, split=False)
     #imp(settings.AT_INITIAL_SETUP_HOOK_MODULE, split=False)
     for path in settings.LOCK_FUNC_MODULES:
-        importlib.import_module(path, split=False)
+        imp(path, split=False)
     # cmdsets
 
     deprstring = "settings.%s should be renamed to %s. If defaults are used, " \
@@ -798,12 +799,12 @@ def error_check_python_modules():
     if not cmdsethandler.import_cmdset(settings.CMDSET_CHARACTER, None): print "Warning: CMDSET_CHARACTER failed to load"
     if not cmdsethandler.import_cmdset(settings.CMDSET_PLAYER, None): print "Warning: CMDSET_PLAYER failed to load"
     # typeclasses
-    importlib.import_module(settings.BASE_PLAYER_TYPECLASS)
+    imp(settings.BASE_PLAYER_TYPECLASS)
-    importlib.import_module(settings.BASE_OBJECT_TYPECLASS)
+    imp(settings.BASE_OBJECT_TYPECLASS)
-    importlib.import_module(settings.BASE_CHARACTER_TYPECLASS)
+    imp(settings.BASE_CHARACTER_TYPECLASS)
-    importlib.import_module(settings.BASE_ROOM_TYPECLASS)
+    imp(settings.BASE_ROOM_TYPECLASS)
-    importlib.import_module(settings.BASE_EXIT_TYPECLASS)
+    imp(settings.BASE_EXIT_TYPECLASS)
-    importlib.import_module(settings.BASE_SCRIPT_TYPECLASS)
+    imp(settings.BASE_SCRIPT_TYPECLASS)
 
 
 
@@ -864,8 +865,7 @@ def main():
         # pass-through to django manager
         if mode in ('runserver', 'testserver'):
             print WARNING_RUNSERVER
-        from django.core.management import call_command
+        django.core.management.call_command(mode)
-        call_command(mode)
 
 
 if __name__ == '__main__':

evennia/__init__.py

@@ -12,64 +12,66 @@ See www.evennia.com for full documentation.
 
 """
 
-######################################################################
+if False:
-# set Evennia version in __version__ property
+
-######################################################################
+    ######################################################################
-import os
+    # set Evennia version in __version__ property
-try:
+    ######################################################################
+    import os
+    try:
         __version__ = "Evennia"
         with os.path.join(open(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))), "VERSION.txt", 'r') as f:
             __version__ += " %s" % f.read().strip()
-except IOError:
+    except IOError:
         __version__ += " (unknown version)"
-del os
+    del os
 
-######################################################################
+    ######################################################################
-# Start Evennia API
+    # Start Evennia API
-# (easiest is to import this module interactively to explore it)
+    # (easiest is to import this module interactively to explore it)
-######################################################################
+    ######################################################################
 
-# help entries
+    # help entries
-from help.models import HelpEntry
+    from help.models import HelpEntry
 
-# players
+    # players
-from players.player import DefaultPlayer
+    from players.player import DefaultPlayer
-from players.models import PlayerDB
+    from players.models import PlayerDB
 
-# commands
+    # commands
-from commands.command import Command
+    from commands.command import Command
-from commands.cmdset import CmdSet
+    from commands.cmdset import CmdSet
-# (default_cmds is created below)
+    # (default_cmds is created below)
 
-# locks
+    # locks
-from locks import lockfuncs
+    from locks import lockfuncs
 
-# scripts
+    # scripts
-from scripts.scripts import Script
+    from scripts.scripts import Script
 
-# comms
+    # comms
-from comms.models import Msg, ChannelDB
+    from comms.models import Msg, ChannelDB
-from comms.comms import Channel
+    from comms.comms import Channel
 
-# objects
+    # objects
-from objects.objects import DefaultObject, DefaultCharacter, DefaultRoom, DefaultExit
+    from objects.objects import DefaultObject, DefaultCharacter, DefaultRoom, DefaultExit
 
-# utils
+    # utils
 
-from utils.search import *
+    from utils.search import *
-from utils.create import *
+    from utils.create import *
-from scripts.tickerhandler import TICKER_HANDLER as tickerhandler
+    from scripts.tickerhandler import TICKER_HANDLER as tickerhandler
-from utils import logger
+    from utils import logger
-from utils import utils
+    from utils import utils
-from utils import gametime
+    from utils import gametime
-from utils import ansi
+    from utils import ansi
-from utils.spawner import spawn
+    from utils.spawner import spawn
 
-######################################################################
+    ######################################################################
-# API containers and helper functions
+    # API containers and helper functions
-######################################################################
+    ######################################################################
 
-def help(header=False):
+    def help(header=False):
         """
         Main Evennia API.
            ev.help() views API contents
@@ -85,7 +87,7 @@ def help(header=False):
             return ", ".join(names)
 
 
-class _EvContainer(object):
+    class _EvContainer(object):
         """
         Parent for other containers
 
@@ -98,7 +100,7 @@ class _EvContainer(object):
         help = property(_help)
 
 
-class DBmanagers(_EvContainer):
+    class DBmanagers(_EvContainer):
         """
         Links to instantiated database managers.
 
@@ -137,11 +139,11 @@ class DBmanagers(_EvContainer):
         #del ExternalChannelConnection
         del ObjectDB, ServerConfig, Tag, Attribute
 
-managers = DBmanagers()
+    managers = DBmanagers()
-del DBmanagers
+    del DBmanagers
 
 
-class DefaultCmds(_EvContainer):
+    class DefaultCmds(_EvContainer):
         """
         This container holds direct shortcuts to all default commands in Evennia.
 
@@ -177,11 +179,11 @@ class DefaultCmds(_EvContainer):
             add_cmds(help)
             add_cmds(system)
             add_cmds(unloggedin)
-default_cmds = DefaultCmds()
+    default_cmds = DefaultCmds()
-del DefaultCmds
+    del DefaultCmds
 
 
-class SystemCmds(_EvContainer):
+    class SystemCmds(_EvContainer):
         """
         Creating commands with keys set to these constants will make
         them system commands called as a replacement by the parser when
@@ -207,7 +209,7 @@ class SystemCmds(_EvContainer):
         CMD_CHANNEL = cmdhandler.CMD_CHANNEL
         CMD_LOGINSTART = cmdhandler.CMD_LOGINSTART
         del cmdhandler
-syscmdkeys = SystemCmds()
+    syscmdkeys = SystemCmds()
-del SystemCmds
+    del SystemCmds
-del _EvContainer
+    del _EvContainer
 

evennia/settings_default.py

@@ -274,26 +274,26 @@ SERVER_SESSION_CLASS = "evennia.server.serversession.ServerSession"
 # Base paths for typeclassed object classes. These paths must be
 # defined relative evennia's root directory. They will be searched in
 # order to find relative typeclass paths.
-OBJECT_TYPECLASS_PATHS = ["types", "contrib"]
+OBJECT_TYPECLASS_PATHS = ["typeclasses", "contrib"]
-SCRIPT_TYPECLASS_PATHS = ["types" "contrib"]
+SCRIPT_TYPECLASS_PATHS = ["typeclasses" "contrib"]
-PLAYER_TYPECLASS_PATHS = ["types", "contrib"]
+PLAYER_TYPECLASS_PATHS = ["typeclasses", "contrib"]
-CHANNEL_TYPECLASS_PATHS = ["types", "contrib"]
+CHANNEL_TYPECLASS_PATHS = ["typeclasses", "contrib"]
 
 # Typeclass for player objects (linked to a character) (fallback)
-BASE_PLAYER_TYPECLASS = "types.player.Player"
+BASE_PLAYER_TYPECLASS = "typeclasses.player.Player"
 # Typeclass and base for all objects (fallback)
-BASE_OBJECT_TYPECLASS = "types.object.Object"
+BASE_OBJECT_TYPECLASS = "typeclasses.object.Object"
 # Typeclass for character objects linked to a player (fallback)
-BASE_CHARACTER_TYPECLASS = "types.character.Character"
+BASE_CHARACTER_TYPECLASS = "typeclasses.character.Character"
 # Typeclass for rooms (fallback)
-BASE_ROOM_TYPECLASS = "types.room.Room"
+BASE_ROOM_TYPECLASS = "typeclasses.room.Room"
 # Typeclass for Exit objects (fallback).
-BASE_EXIT_TYPECLASS = "types.exit.Exit"
+BASE_EXIT_TYPECLASS = "typeclasses.exit.Exit"
 # Typeclass for Channel (fallback).
-BASE_CHANNEL_TYPECLASS = "type.channel.Channel"
+BASE_CHANNEL_TYPECLASS = "typeclasses.channel.Channel"
 # Typeclass for Scripts (fallback). You usually don't need to change this
 # but create custom variations of scripts on a per-case basis instead.
-BASE_SCRIPT_TYPECLASS = "type.scripts.Script"
+BASE_SCRIPT_TYPECLASS = "typeclasses.scripts.Script"
 # The default home location used for all objects. This is used as a
 # fallback if an object's normal home location is deleted. Default
 # is Limbo (#2).
@@ -399,7 +399,7 @@ CLIENT_DEFAULT_HEIGHT = 45 # telnet standard is 24 but does anyone use such
 # This enables guest logins, by default via "connect guest"
 GUEST_ENABLED = False
 # Typeclass for guest player objects (linked to a character)
-BASE_GUEST_TYPECLASS = "types.player.Guest"
+BASE_GUEST_TYPECLASS = "typeclasses.player.Guest"
 # The permission given to guests
 PERMISSION_GUEST_DEFAULT = "Guests"
 # The default home location used for guests.

evennia/utils/utils.py

@@ -308,7 +308,7 @@ def get_evennia_version():
     Check for the evennia version info.
     """
     try:
-        f = open(settings.BASE_PATH + os.sep + "VERSION.txt", 'r')
+        f = open(settings.ROOT_DIR + os.sep + "VERSION.txt", 'r')
         return "%s-%s" % (f.read().strip(), os.popen("git rev-parse --short HEAD").read().strip())
     except IOError:
         return "Unknown version"
@@ -317,7 +317,7 @@ def get_evennia_version():
 def pypath_to_realpath(python_path, file_ending='.py'):
     """
     Converts a path on dot python form (e.g. 'evennia.objects.models') to
-    a system path ($BASE_PATH/evennia/objects/models.py). Calculates all
+    a system path ($ROOT_DIR/evennia/objects/models.py). Calculates all
     paths as absoulte paths starting from the evennia main directory.
 
     Since it seems to be a common mistake to include the file ending
@@ -330,7 +330,7 @@ def pypath_to_realpath(python_path, file_ending='.py'):
         pathsplit = pathsplit[:-1]
     if not pathsplit:
         return python_path
-    path = settings.BASE_PATH
+    path = settings.ROOT_DIR
     for directory in pathsplit:
         path = os.path.join(path, directory)
     if file_ending:

game_template/commands/default_cmdsets.py

@@ -0,0 +1,91 @@
+"""
+Command sets
+
+All commands in the game must be grouped in a cmdset.  A given command
+can be part of any number of cmdsets and cmdsets can be added/removed
+and merged onto entities at runtime.
+
+To create new commands to populate the cmdset, see
+commands/command.py.
+
+This module wrap the default command sets of Evennia; overload them
+to add/remove commands from the default lineup. You can create your
+own cmdsets by inheriting from them or directly from evennia.CmdSet.
+
+"""
+
+from evennia import default_cmds
+
+class CharacterCmdSet(default_cmds.CharacterCmdSet):
+    """
+    The CharacterCmdSet contains general in-game commands like look,
+    get etc available on in-game Character objects. It is merged with
+    the PlayerCmdSet when a Player puppets a Character.
+    """
+    key = "DefaultCharacter"
+
+    def at_cmdset_creation(self):
+        """
+        Populates the cmdset
+        """
+        super(CharacterCmdSet, self).at_cmdset_creation()
+        #
+        # any commands you add below will overload the default ones.
+        #
+
+
+class PlayerCmdSet(default_cmds.PlayerCmdSet):
+    """
+    This is the cmdset available to the Player at all times. It is
+    combined with the CharacterCmdSet when the Player puppets a
+    Character. It holds game-account-specific commands, channel
+    commands etc.
+    """
+    key = "DefaultPlayer"
+
+    def at_cmdset_creation(self):
+        """
+        Populates the cmdset
+        """
+        super(PlayerCmdSet, self).at_cmdset_creation()
+        #
+        # any commands you add below will overload the default ones.
+        #
+
+
+class UnloggedinCmdSet(default_cmds.UnloggedinCmdSet):
+    """
+    Command set available to the Session before being logged in.  This
+    holds commands like creating a new account, logging in etc.
+    """
+    key = "DefaultUnloggedin"
+
+    def at_cmdset_creation(self):
+        """
+        Populates the cmdset
+        """
+        super(UnloggedinCmdSet, self).at_cmdset_creation()
+        #
+        # any commands you add below will overload the default ones.
+        #
+
+
+class SessionCmdSet(default_cmds.SessionCmdSet):
+    """
+    This cmdset is made available on Session level once logged in. It
+    is empty by default.
+    """
+    key = "DefaultSession"
+
+    def at_cmdset_creation(self):
+        """
+        This is the only method defined in a cmdset, called during
+        its creation. It should populate the set with command instances.
+
+        As and example we just add the empty base Command object.
+        It prints some info.
+        """
+        super(SessionCmdSet, self).at_cmdset_creation()
+        #
+        # any commands you add below will overload the default ones.
+        #

game_template/server/conf/inlinefunc.py

@@ -0,0 +1,42 @@
+"""
+Inlinefunc
+
+Inline functions allow for direct conversion of text users mark in a
+special way. Inlinefuncs are deactivated by default. To activate, add
+
+    INLINEFUNC_ENABLED = True
+
+to your settings file. The default inlinefuncs are found in
+evennia.utils.inlinefunc.
+
+In text, usage is straightforward:
+
+{funcname([arg1,arg2,...]) text {/funcname
+
+Example 1 (using the "pad" inlinefunc):
+    "This is {pad(50,c,-) a center-padded text{/pad of width 50."
+    ->
+    "This is -------------- a center-padded text--------------- of width 50."
+
+Example 2 (using "pad" and "time" inlinefuncs):
+    "The time is {pad(30){time(){/time{/padright now."
+    ->
+    "The time is         Oct 25, 11:09         right now."
+
+To add more inline functions, add them to this module, using
+the following call signature:
+
+    def funcname(text, *args)
+
+where the text is always the part between {funcname(args) and
+{/funcname and the *args are taken from the appropriate part of the
+call. It is important that the inline function properly clean the
+incoming args, checking their type and replacing them with sane
+defaults if needed. If impossible to resolve, the unmodified text
+should be returned. The inlinefunc should never cause a traceback.
+
+"""
+
+#def capitalize(text, *args):
+#    "Silly capitalize example"
+#    return text.capitalize()

game_template/server/conf/settings.py

@@ -0,0 +1,92 @@
+"""
+Evennia settings file.
+
+The full options are found in the default settings file found here:
+
+{settings_default}
+
+Note: Don't copy more from the default file than you actually intend to
+change; this will make sure that you don't overload upstream updates
+unnecessarily.
+
+"""
+
+# Use the defaults from Evennia unless explicitly overridden
+import os
+from evennia.settings_default import *
+
+######################################################################
+# Evennia base server config
+######################################################################
+
+# This is the name of your game. Make it catchy!
+SERVERNAME = {servername}
+
+# Path to the game directory (use EVENNIA_DIR to refer to the
+# core evennia library)
+GAME_DIR = {game_dir}
+
+# Place to put log files
+LOG_DIR = os.path.join(GAME_DIR, "server", "logs")
+SERVER_LOG_FILE = os.path.join(LOG_DIR, 'server.log')
+PORTAL_LOG_FILE = os.path.join(LOG_DIR, 'portal.log')
+HTTP_LOG_FILE = os.path.join(LOG_DIR, 'http_requests.log')
+
+######################################################################
+# Evennia Database config
+######################################################################
+
+# Database config syntax:
+# ENGINE - path to the the database backend. Possible choices are:
+#            'django.db.backends.sqlite3', (default)
+#            'django.db.backends.mysql',
+#            'django.db.backends.'postgresql_psycopg2' (see Issue 241),
+#            'django.db.backends.oracle' (untested).
+# NAME - database name, or path to the db file for sqlite3
+# USER - db admin (unused in sqlite3)
+# PASSWORD - db admin password (unused in sqlite3)
+# HOST - empty string is localhost (unused in sqlite3)
+# PORT - empty string defaults to localhost (unused in sqlite3)
+DATABASES = {{
+    'default': {{
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(GAME_DIR, "server", "evennia.db3"),
+        'USER': '',
+        'PASSWORD': '',
+        'HOST': '',
+        'PORT': ''
+        }}}}
+
+######################################################################
+# Django web features
+######################################################################
+
+# Absolute path to the directory that holds file uploads from web apps.
+# Example: "/home/media/media.lawrence.com"
+MEDIA_ROOT = os.path.join(GAME_DIR, "gamesrc", "web", "media")
+
+# The master urlconf file that contains all of the sub-branches to the
+# applications. Change this to add your own URLs to the website.
+ROOT_URLCONF = 'web.urls'
+
+# URL prefix for admin media -- CSS, JavaScript and images. Make sure
+# to use a trailing slash. Django1.4+ will look for admin files under
+# STATIC_URL/admin.
+STATIC_URL = '/static/'
+STATIC_ROOT = os.path.join(GAME_DIR, "web", "static")
+
+# Directories from which static files will be gathered from.
+STATICFILES_DIRS = (
+    os.path.join(GAME_DIR, "web", "static_overrides"),
+    os.path.join(EVENNIA_DIR, "web", "static"),)
+
+# We setup the location of the website template as well as the admin site.
+TEMPLATE_DIRS = (
+    os.path.join(GAME_DIR, "web", "template_overrides"),
+    os.path.join(EVENNIA_DIR, "web", "templates", ACTIVE_TEMPLATE),
+    os.path.join(EVENNIA_DIR, "web", "templates"),)
+
+# The secret key is randomly seeded upon creation. It is used to
+# salt cryptographic keys. Don't change this once you have created users
+# and don't share it with anyone.
+SECRET_KEY = {secret_key}