Version 1.2.1:

* Plugin state is now saved; MOTD settings in existing plugins will have to be deleted and replaced after first run.

 * Starbound configuration manager assures that the settings for the server are correct before running. It can be disabled.

 * Added /list_players and /delete_player commands. Supports wildcards.

  * Unicode MOTD support.

 Errata:

 Reformatted a bunch of files.
 Restructured plugin storage.

Author: AMorporkian

base_plugin.py

@@ -21,6 +21,12 @@ class BasePlugin(object):
     depends = []
     auto_activate = True
 
+    def __init__(self):
+        plugin_config = self.config.plugin_config
+        if 'auto_activate' not in plugin_config:
+            plugin_config['auto_activate'] = self.auto_activate
+        self.config.plugin_config = plugin_config
+
     def activate(self):
         """
         Called when the plugins are activated, do any setup work here.

config.py

@@ -80,12 +80,12 @@ def __getattr__(self, item):
                 self.logger.error("Couldn't find configuration option %s in configuration file.", item)
                 raise AttributeError
 
+
     def __setattr__(self, key, value):
         if key == "config":
             super(ConfigurationManager, self).__setattr__(key, value)
         elif key == "plugin_config":
             caller = inspect.stack()[1][0].f_locals["self"].__class__.name
-
             self.config["plugin_config"][caller] = value
         else:
             self.config[key] = value

config/config.json.default

@@ -15,12 +15,34 @@
     "logging_format_console": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
     "logging_format_debugfile": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
     "logging_format_logfile": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    "owner_uuid": "!!--REPLACE THIS--!!",
+    "owner_uuid": "b07dbd8c1a681d71ef728161976b6fa5",
     "passthrough": false,
     "player_db": "config/player.db",
     "plugin_config": {
-        "motd_plugin": "Welcome to the server! Play nice.",
+        "admin_messenger": {
+            "auto_activate": true
+        },
+        "announcer_plugin": {
+            "auto_activate": true
+        },
+        "bouncer": {
+            "auto_activate": false
+        },
+        "chat_logger": {
+            "auto_activate": true
+        },
+        "command_dispatcher": {
+            "auto_activate": true
+        },
+        "motd_plugin": {
+            "auto_activate": true,
+            "motd": "Welcome to the server! Play nice."
+        },
+        "mute_manager": {
+            "auto_activate": true
+        },
         "new_player_greeter_plugin": {
+            "auto_activate": true,
             "items": [
                 [
                     "coalore",
@@ -34,6 +56,7 @@
             "message": "Welcome to the server! Here are some starter items to get you off to a good start."
         },
         "planet_protect": {
+            "auto_activate": true,
             "blacklist": [
                 "bomb",
                 "bombblockexplosion",
@@ -111,10 +134,23 @@
             "protected_planets": []
         },
         "player_manager": {
+            "auto_activate": true,
             "name_removal_regexes": [
                 "\\^#[\\w]+;",
                 "[^ \\w]+"
             ]
+        },
+        "plugin_manager": {
+            "auto_activate": true
+        },
+        "starbound_config_manager": {
+            "auto_activate": true
+        },
+        "user_management_commands": {
+            "auto_activate": true
+        },
+        "warpy_plugin": {
+            "auto_activate": true
         }
     },
     "plugin_path": "plugins",

plugin_manager.py

@@ -31,11 +31,13 @@ class MissingDependency(PluginNotFound):
     of a plugin.
     """
 
+
 class UnresolvedOrCircularDependencyError(Exception):
     """
     Raised whenever there is a circular dependency detected in the loading of of plugins.
     """
 
+
 class PluginManager(object):
     logger = logging.getLogger('starrypy.plugin_manager.PluginManager')
 
@@ -79,7 +81,8 @@ def load_plugins(self, plugin_dir):
             try:
                 mod = __import__(name, globals(), locals(), [], 0)
                 for _, plugin in inspect.getmembers(mod, inspect.isclass):
-                    if issubclass(plugin, self.base_class) and plugin is not self.base_class and plugin not in seen_plugins:
+                    if issubclass(plugin,
+                                  self.base_class) and plugin is not self.base_class and plugin not in seen_plugins:
                         plugin.config = self.config
                         plugin.factory = self.factory
                         plugin.active = False
@@ -92,21 +95,22 @@ def load_plugins(self, plugin_dir):
                 self.logger.critical("Import error for %s", name)
                 sys.exit()
         try:
-            dependencies = {x.name:set(x.depends) for x in seen_plugins}
-            classes = {x.name:x for x in seen_plugins}
+            dependencies = {x.name: set(x.depends) for x in seen_plugins}
+            classes = {x.name: x for x in seen_plugins}
             while len(dependencies) > 0:
                 ready = [x for x, d in dependencies.iteritems() if len(d) == 0]
                 if len(ready) == 0:
                     ex = []
                     for n, d in dependencies.iteritems():
                         for dep in d:
                             ex.append("%s->%s" % (n, dep))
-                    raise UnresolvedOrCircularDependencyError("Unresolved or circular dependencies found:\n%s" % "\n".join(ex))
+                    raise UnresolvedOrCircularDependencyError(
+                        "Unresolved or circular dependencies found:\n%s" % "\n".join(ex))
                 for name in ready:
                     self.plugins[name] = classes[name]()
                     self.load_order.append(name)
                     self.logger.debug("Instantiated plugin '%s'" % name)
-                    del(dependencies[name])
+                    del (dependencies[name])
                 for name, depends in dependencies.iteritems():
                     to_load = depends & set(self.plugins.iterkeys())
                     dependencies[name] = dependencies[name].difference(set(self.plugins.iterkeys()))
@@ -132,7 +136,7 @@ def reload_plugins(self):
 
     def activate_plugins(self):
         for plugin in [self.plugins[x] for x in self.load_order]:
-            if plugin.auto_activate:
+            if self.config.config['plugin_config'][plugin.name]['auto_activate']:
                 try:
                     plugin.activate()
                 except FatalPluginError as e:

plugins/admin_messenger/admin_messenger.py

@@ -36,6 +36,6 @@ def message_admins(self, message):
     def broadcast_message(self, message):
         for protocol in self.factory.protocols.itervalues():
             protocol.send_chat_message("%sSERVER BROADCAST: %s%s" % (
-            self.config.colors["admin"], message.message[3:], self.config.colors["default"]))
+                self.config.colors["admin"], message.message[3:], self.config.colors["default"]))
             self.logger.info("Broadcast from %s. Message: %s", self.protocol.player.name,
                              message.message[3:])

plugins/chat_logger/chat_logger.py

@@ -4,6 +4,7 @@
 
 class ChatLogger(BasePlugin):
     name = "chat_logger"
+
     def on_chat_sent(self, data):
         parsed = chat_sent().parse(data.data)
         parsed.message = parsed.message.decode("utf-8")

plugins/core/admin_commands_plugin/admin_command_plugin.py

@@ -93,6 +93,7 @@ def make_guest(self, player):
         except:
             self.player_manager.session.rollback()
             raise
+
     @permissions(UserLevels.MODERATOR)
     def make_registered(self, player):
         player.access_level = UserLevels.REGISTERED
@@ -178,7 +179,8 @@ def give_item(self, data):
                 self.protocol.send_chat_message("Please check your syntax. %s" % str(e))
                 return
             except AttributeError:
-                self.protocol.send_chat_message("Please check that the username you are referencing exists. If it has spaces, please surround it by quotes.")
+                self.protocol.send_chat_message(
+                    "Please check that the username you are referencing exists. If it has spaces, please surround it by quotes.")
                 return
             except:
                 self.protocol.send_chat_message("An unknown error occured. %s" % str(e))

plugins/core/player_manager/manager.py

@@ -87,8 +87,10 @@ def __delitem__(self, key):
         dict.__delitem__(self, key)
         self.changed()
 
+
 MutableDict.associate_with(JSONEncodedDict)
 
+
 class Player(Base):
     __tablename__ = 'players'
 

plugins/core/player_manager/plugin.py

@@ -14,6 +14,7 @@
 class PlayerManagerPlugin(SimpleCommandPlugin):
     name = "player_manager"
     commands = ["list_players", "delete_player"]
+
     def activate(self):
         super(PlayerManagerPlugin, self).activate()
         self.player_manager = PlayerManager(self.config)
@@ -47,7 +48,8 @@ def on_client_connect(self, data):
                 protocol=self.protocol.id)
             return True
         except AlreadyLoggedIn:
-            self.reject_with_reason("You're already logged in! If this is not the case, please wait 10 seconds and try again.")
+            self.reject_with_reason(
+                "You're already logged in! If this is not the case, please wait 10 seconds and try again.")
             self.logger.info("Already logged in user tried to log in.")
         except Banned:
             self.reject_with_reason("You have been banned!")
@@ -106,12 +108,14 @@ def on_client_disconnect(self, player):
     def delete_player(self, data):
         name = " ".join(data)
         if self.player_manager.get_logged_in_by_name(name) is not None:
-            self.protocol.send_chat_message("That player is currently logged in. Refusing to delete logged in character.")
+            self.protocol.send_chat_message(
+                "That player is currently logged in. Refusing to delete logged in character.")
             return False
         else:
             player = self.player_manager.get_by_name(name)
             if player is None:
-                self.protocol.send_chat_message("Couldn't find a player named %s. Please check the spelling and try again." % name)
+                self.protocol.send_chat_message(
+                    "Couldn't find a player named %s. Please check the spelling and try again." % name)
                 return False
             self.player_manager.session.delete(player)
             self.protocol.send_chat_message("Deleted player with name %s." % name)
@@ -122,11 +126,16 @@ def list_players(self, data):
             self.format_player_response(self.player_manager.session.query(Player).all())
         else:
             rx = re.sub(r"[\*]", "%", " ".join(data))
-            self.format_player_response(self.player_manager.session.query(Player).filter(Player.name.like(rx)).all())
+            self.format_player_response(
+                self.player_manager.session.query(Player).filter(Player.name.like(rx)).all())
 
     def format_player_response(self, players):
         if len(players) <= 25:
-            self.protocol.send_chat_message("Results: %s" % "\n".join(["%s: %s" % (player.uuid, player.name) for player in players]))
+            self.protocol.send_chat_message(
+                "Results: %s" % "\n".join(["%s: %s" % (player.uuid, player.name) for player in players]))
         else:
-            self.protocol.send_chat_message("Results: %s" % "\n".join(["%s: %s" % (player.uuid, player.name) for player in players[:25]]))
-            self.protocol.send_chat_message("And %d more. Narrow it down with SQL like syntax. Feel free to use a *, it will be replaced appropriately." % (len(players) - 25))
+            self.protocol.send_chat_message(
+                "Results: %s" % "\n".join(["%s: %s" % (player.uuid, player.name) for player in players[:25]]))
+            self.protocol.send_chat_message(
+                "And %d more. Narrow it down with SQL like syntax. Feel free to use a *, it will be replaced appropriately." % (
+                len(players) - 25))

plugins/core/starbound_config_manager/starbound_config_manager.py

@@ -1,17 +1,40 @@
+import json
 import os
-from base_plugin import BasePlugin
+from base_plugin import SimpleCommandPlugin
 from plugin_manager import FatalPluginError
+from plugins.core import permissions, UserLevels
 
-class StarboundConfigManager(BasePlugin):
+
+class StarboundConfigManager(SimpleCommandPlugin):
     name = "starbound_config_manager"
+    depends = ['command_dispatcher', 'warpy_plugin']
+    commands = ["spawn"]
 
     def activate(self):
         super(StarboundConfigManager, self).activate()
         try:
             configuration_file = os.path.join(self.config.starbound_path, "starbound.config")
             if not os.path.exists(configuration_file):
-                raise FatalPluginError("Could not open starbound configuration file. Tried path: %s" % configuration_file)
+                raise FatalPluginError(
+                    "Could not open starbound configuration file. Tried path: %s" % configuration_file)
         except AttributeError:
             raise FatalPluginError("The starbound path (starbound_path) is not set in the configuration.")
+        try:
+            with open(configuration_file, "r") as f:
+                starbound_config = json.load(f)
+        except Exception as e:
+            raise FatalPluginError(
+                "Could not parse the starbound configuration file as JSON. Error given from JSON decoder: %s" % str(
+                    e))
+        if self.config.upstream_port != starbound_config['gamePort']:
+            raise FatalPluginError(
+                "The starbound gamePort option (%d) does not match the config.json value (%d)." % (
+                starbound_config['gamePort'], self.config.upstream_port))
+        self._spawn = starbound_config['defaultWorldCoordinate'].split(":")
 
+    @permissions(UserLevels.GUEST)
+    def spawn(self, data):
+        """Warps you to spawn. Syntax: /spawn"""
+        self.plugins['warpy_plugin'].move_player_ship(self.protocol, self._spawn)
+        self.protocol.send_chat_message("Moving your ship to spawn.")