Merge branch 'master' into dev

Author: minecraft server

README

@@ -0,0 +1,12 @@
+MCProxy is a python application that aims to:
+	Proxy minecraft packet connections between clients and servers
+	Packet inspection on that link
+	Implement features/restrictions on the minecraft game by modifying the packet stream
+
+The main proxy (in the top level directory) is the guts and provides a framework for making plugins.
+Plugins are in the plugins directory and are loaded in order. This order is set in the plugins.py file.
+
+All packets recieved are filtered through each plugin in order. Each plugin may replace it, modify it or just drop it completely.
+See the plugin spec for details.
+
+Within the plugins directory there are several core plugins that provide a framework for player interaction and other useful tasks.

packet_decoder.py

@@ -4,21 +4,10 @@
 import sys
 
 #TODO: Review which of these we actually need
-NODE_SERVER = 0x01
 SERVER_TO_CLIENT = 0x01
-FROM_SERVER = 0x01
-TO_CLIENT = 0x01
-
-NODE_CLIENT = 0x02
 CLIENT_TO_SERVER = 0x02
-FROM_CLIENT = 0x02
-TO_SERVER = 0x02
-
-EVENT_CLIENT_CONNECT = 0x00
-EVENT_CLIENT_DISCONNECT = 0x01
-EVENT_SERVER_DISCONNECT = 0x02
 
-PROTOCOL_VERSION = 23
+PROTOCOL_VERSION = 28
 
 class Packet:
 	def __init__(self):

plugin-spec.txt

@@ -0,0 +1,32 @@
+Plugin files are python modules.
+
+Plugins SHOULD contain the following global variables:
+AUTHOR: String containing name or handle of plugin author, or list of the same.
+CONTACT: String containing contact details (preferably an email address) for author, or list of the same.
+DESCRIPTION: String containing description of plugin.
+
+Plugins MAY contain the following defined functions:
+	on_start():
+		Run on plugin initialisation. If an exception is raised here, plugin is disabled and a warning is given.
+	on_tick(users):
+		Run approximately every server tick (200ms). Users is a list of all currently connected User objects.
+		Important note: This call occurs on a signal and may interrupt any other execution at any point.
+		Any code using this function should prepare accordingly.
+	on_packet(packet, user, to_server):
+		This function is called for every packet passing through the proxy.
+		packet is a Packet and contains packet data.
+		user is a User and contains session data.
+		to_server is a bool and is True for client->server packets, False for server->client.
+		This function may return:
+			a Packet
+			a list of Packet
+		and each packet in the list will be passed along to the next plugin in the chain.
+		Note that returning [] has the effect of dropping the packet.
+		Note also that it is common to simply modify the given Packet before returning it.
+
+If a plugin wishes to log to the main logger, it MAY use the root logger available through the logging module.
+However, in general, the plugin SHOULD use its own logging path.
+
+Plugins MAY import any of the items contained in the top level directory.
+As an exception, plugins MAY NOT import proxy.py
+Plugins SHOULD make use of the functions given in helpers.py

useful-plugins.txt

@@ -0,0 +1,21 @@
+The following plugins are designed for use by other plugins.
+You may depend on their presence - please use them.
+
+usernames
+	Doesn't need to be imported directly.
+	This module ensures that the user's name is available under user.username
+
+timed_events
+	Still in testing/development. Used for scheduling functions to occur at a later time.
+
+player_cmd
+	Register functions to be called when players type a given message. Runs on regex :D.
+
+menus
+	Menu interface system for any situation where you want players to read pages of text,
+	interactively pick an option, etc.
+	Highly flexible but somewhat overly so - see menu_test for good example usage.
+
+plugin_helpers
+	Still in development. This is the place for any helper functions that don't need a seperate plugin
+	but require other plugins to operate (and so cannot go in helpers.py to prevent cyclic dependencies).