Optional kill signal handler registration

.gitignore

@@ -1,4 +1,5 @@
 *.pyc
 *.log
 login.py
-run.py
+run.py
+/build

ReadMe.md

@@ -1,30 +1,45 @@
 Inspired by remyroy's COPS, a Minecraft client in Python. Protocol implementation based on barneymc
-Currently Supports Minecraft 1.7.4
+
+Spock currently supports Minecraft 1.8.1
 
 spock
 =====
 
 Bot framework, currently under heavy development
 
-Protocol stuff lives in spock/mcp
-Map stuff lives in spock/mcmap
-Important client stuff lives in spock/plugins/core
-Less important stuff lives in spock/plugins/helpers
-
-Client could loosely be called "event-driven", by default plugins register handler functions to handle events that may or may not be emitted by other plugins. Everything is a plugin in spock, including the event loop/framework itself, so you can feel free to rip out the entire back end and replace it with your framework or paradigm of choice. As long as you provide the same simple APIs, other plugins won't know the difference.
-
-Currently writing Spock plugins requires a fairly intricate understanding of the MC protocol, since there aren't many plugins that provide higher abstractions than MC packets. That said the API is starting to shape up quite nicely, we've got threading and the start of a World API. Once Python 3.4 comes out we'll probably try to stablize the event loop API around asyncio and provide some sort of ghetto fallback for older Python 3.x
+Protocol stuff lives in spock/mcp  
+Map stuff lives in spock/mcmap  
+Important client stuff lives in spock/plugins/core  
+Less important stuff lives in spock/plugins/helpers  
+
+Client could loosely be called "event-driven", by default plugins register
+handler functions to handle events that may or may not be emitted by other
+plugins. Everything is a plugin in spock, including the event loop/framework
+itself, so you can feel free to rip out the entire back end and replace it with
+your framework or paradigm of choice. As long as you provide the same simple
+APIs, other plugins won't know the difference.
+
+Currently writing Spock plugins requires a fairly intricate understanding of the
+MC protocol, since there aren't many plugins that provide higher abstractions
+than MC packets. That said the API is starting to shape up quite nicely, we've
+got timers and the start of a World API.
+
+Speaking of compatibility, Spock runs on Python 3.x on *Nix operating systems,
+and requires PyCrypto. Theoretically it runs on Windows but no one has ever
+tested it and I'm fairly sure there are a couple (easy to fix) errors that will
+pop up. Python 2.x would be nice, but it becomes an ever more distant goal as
+Spock continues to grow dependencies on new Python features. Not impossible,
+just not a priority
 
-Speaking of compatibility, Spock runs on Python 3.x on *Nix operating systems, and requires PyCrypto. Theoretically it runs on Windows but no one has ever tested it and I'm fairly sure there are a couple (easy to fix) errors that will
- pop up. Python 2.x would be nice, but it becomes an ever more distant goal as Spock continues to grow dependencies on new Python features. Not impossible, just not a priority
-
 I'll write a real ReadMe and API docs when everything is done and stable-ish.
-For now you can check out the plugins folder to get a vague idea of what plugins should look like, find me on #mcdevs or email me at nickelpro@gmail.com if you have questions
+For now you can check out the plugins folder to get a vague idea of what plugins
+should look like, find me on #mcdevs or email me at nickelpro@gmail.com if you
+have questions
 
 
 ###Legal
 
 License is MIT and can be found in license.md
 
-The NBT parser and the original protocol implementation came from other projects, 
+The NBT parser and the original protocol implementation came from other projects,
 relevant legal information and attribution can be found in legal.md

examples/demo.py

@@ -1,27 +1,14 @@
+"""
+Basic demo example
+"""
+
 from spock.client import Client
 from spock.plugins import DefaultPlugins
 from demoplugin import DemoPlugin
 #Open login.py and put in your username and password
 from login import username, password
-from spock.plugins.helpers.clientinfo import ClientInfoPlugin
-from spock.plugins.helpers.move import MovementPlugin
-
-settings = {
-    'username': "Bot",
-    'authenticated': False, #Authenticate with authserver.mojang.com
-    'bufsize': 4096,       #Size of socket buffer
-    'sock_quit': True,     #Stop bot on socket error or hangup
-    'sess_quit': True,     #Stop bot on failed session login
-    'thread_workers': 5,   #Number of workers in the thread pool
-    'packet_trace': True,
-    'plugins': DefaultPlugins,         #Plugins
-    'plugin_settings': {}, #Extra settings for plugins
-}
 
 plugins = DefaultPlugins
-plugins.append(ClientInfoPlugin)
-plugins.append(MovementPlugin)
-# plugins.append(DemoPlugin)
-
-client = Client(plugins = plugins, settings = settings)
-client.start(host="192.168.2.19", port=25565)
+plugins.append(DemoPlugin)
+client = Client(plugins = plugins, username = username, password = password)
+client.start()

examples/demoplugin.py

@@ -2,22 +2,22 @@
 
 #TODO: Make this cooler
 class DemoPlugin:
-    def __init__(self, ploader, settings):
-        #Login Success
-        ploader.reg_event_handler(
-            (mcdata.LOGIN_STATE, mcdata.SERVER_TO_CLIENT, 0x02),
-            self.print_packets
-        )
-        #Chat Message
-        ploader.reg_event_handler(
-            (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x02),
-            self.print_packets
-        )
-        #Player List Item
-        ploader.reg_event_handler(
-            (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x38),
-            self.print_packets
-        )
+	def __init__(self, ploader, settings):
+		#Login Success
+		ploader.reg_event_handler(
+			(mcdata.LOGIN_STATE, mcdata.SERVER_TO_CLIENT, 0x02),
+			self.print_packets
+		)
+		#Chat Message
+		ploader.reg_event_handler(
+			(mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x02), 
+			self.print_packets
+		)
+		#Player List Item
+		ploader.reg_event_handler(
+			(mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x38),
+			self.print_packets
+		)
 
-    def print_packets(self, name, packet):
-        print(packet)
+	def print_packets(self, name, packet):
+		print(packet)

examples/login.py

@@ -1,2 +1,2 @@
 username = 'Put Your Username Here'
-password = 'Put Your Password Here'
+password = 'Put Your Password Here'

examples/settings.py

@@ -1,13 +1,12 @@
 from spock.plugins.defaults import DefaultPlugins
 
 default_settings = {
-    'username': 'Bot',     #minecraft.net username or name for unauthenticated servers
-    'password': '',           #Password for account, ignored if not authenticated
-    'authenticated': True, #Authenticate with authserver.mojang.com
-    'bufsize': 4096,       #Size of socket buffer
-    'sock_quit': True,     #Stop bot on socket error or hangup
-    'sess_quit': True,     #Stop bot on failed session login
-    'thread_workers': 5,   #Number of workers in the thread pool
-    'plugins': DefaultPlugins,         #Plugins
-    'plugin_settings': {}, #Extra settings for plugins
+	'username': 'Bot',     #minecraft.net username or name for unauthenticated servers
+	'password': '',	       #Password for account, ignored if not authenticated
+	'authenticated': True, #Authenticate with authserver.mojang.com
+	'bufsize': 4096,       #Size of socket buffer
+	'sock_quit': True,     #Stop bot on socket error or hangup
+	'sess_quit': True,     #Stop bot on failed session login
+	'plugins': DefaultPlugins,         #Plugins
+	'plugin_settings': {}, #Extra settings for plugins
 }

license.md

@@ -1,4 +1,4 @@
-Copyright (C) 2013 Nick Gamberini
+Copyright (C) 2015 Nick Gamberini
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ Copyright (C) 2013 Nick Gamberini
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
+ THE SOFTWARE.

plugins/AntiAFK.py

@@ -8,19 +8,19 @@
 
 #Very bad and naive Anti-AFK plugin
 class AntiAFKPlugin:
-    def __init__(self, client, settings):
-        self.client = client
-        client.register_dispatch(self.avoid_afk, 0x03)
-        client.register_dispatch(self.revive, 0x08)
+	def __init__(self, client, settings):
+		self.client = client
+		client.register_dispatch(self.avoid_afk, 0x03)
+		client.register_dispatch(self.revive, 0x08)
 
-    def avoid_afk(self, packet):
-        msg = packet.data['text'].lower()
-        if ('afk plugin' in msg):
-            self.client.push(Packet('PLAY>Chat Message', data={
-                "text": "Hello, I am Spock_Bot, this message is to avoid AFKGC"
-                })
-            )
+	def avoid_afk(self, packet):
+		msg = packet.data['text'].lower()
+		if ('afk plugin' in msg):
+			self.client.push(Packet(ident=0x03, data={
+				"text": "Hello, I am Spock_Bot, this message is to avoid AFKGC"
+				})
+			)
 
-    def revive(self, packet):
-        if self.client.health['health']<=0:
-            self.client.push(Packet(ident='PLAY>Client Status', data={'action': 0}))
+	def revive(self, packet):
+		if self.client.health['health']<=0:
+			self.client.push(Packet(ident=0xCD, data={'payload': 1}))

plugins/DebugPlugin.py

@@ -4,33 +4,31 @@
 from spock.mcmap import mapdata
 from spock.mcp import mcdata
 from spock.utils import pl_announce
+import time
 
 class DebugPlugin:
-    def __init__(self, ploader, settings):
-        for packet in mcdata.hashed_structs:
-            ploader.reg_event_handler(packet, self.debug)
-        #ploader.reg_event_handler('tick', self.tick)
-        #ploader.reg_event_handler('w_map_chunk', self.map)
-        #ploader.reg_event_handler('w_block_update', self.block_update)
+	def __init__(self, ploader, settings):
+		#for packet in mcdata.hashed_structs:
+		#	ploader.reg_event_handler(packet, self.debug)
+		#ploader.reg_event_handler('w_block_update', self.block_test)
+		#ploader.reg_event_handler('client_tick', self.timer_test)
+		ploader.reg_event_handler('cl_health_update', self.clinfo_test)
+		self.old_time = 0
 
-    def debug(self, name, packet):
-        if packet.ident() == (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x26):
-            packet.data['data'] = b''
-            #print(packet)
-        #print(packet)
+	def debug(self, name, packet):
+		if packet.ident() == (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x26):
+			packet.data['data'] = b''
+			#print(packet)
+		#print(packet)
 
-    def block_update(self, name, data):
-        print('Block Updated!')
-        print(
-            'Block is:', mapdata.blocks[data.id]['display_name']+',',
-            'Biome:', mapdata.biomes[data.biome]['display_name']
-        )
-        print('Block Light:', str(data.block_light)+',', 'Sky Light:', data.sky_light)
+	def clinfo_test(self, event, data):
+		print('Health Update', data)
 
+	def block_test(self, event, block):
+		print('Block update at:', block['location'])
+		print('New block data:', block['block_data'])
 
-    def map(self, name, data):
-        print(data)
-
-    def tick(self, name, data):
-        print('tick!')
-        print('Current threads:', threading.active_count())
+	def timer_test(self, _, __):
+		new_time = int(round(time.time() * 1000))
+		print(new_time - self.old_time)
+		self.old_time = new_time

plugins/EchoPacket.py

@@ -1,8 +1,12 @@
-from spock.mcp.mcdata import structs
+from spock.mcp.mcdata import hashed_structs
+from spock.mcp import mcdata
 
 class EchoPacketPlugin:
-    def __init__(self, ploader, settings):
-        ploader.reg_event_handler(list(structs.keys()), self.echopacket)
+	def __init__(self, ploader, settings):
+		for i in list(hashed_structs.keys()):
+			ploader.reg_event_handler(i, self.echopacket)
 
-    def echopacket(self, name, packet):
-        print(packet)
+	def echopacket(self, name, packet):
+		#Dont print Chunk Data and Map Chunk Bulk
+		if packet.ident != (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x26) and packet.ident != (mcdata.PLAY_STATE, mcdata.SERVER_TO_CLIENT, 0x21) and packet.ident != (mcdata.PLAY_STATE, mcdata.CLIENT_TO_SERVER, 0x04):
+			print(packet)

plugins/ReConnect.py

@@ -3,45 +3,44 @@
 In the meantime, go look at plugins in spock.net.plugins for more up-to-date plugin examples
 """
 
-import threading
 from spock.mcp.mcpacket import Packet
 from spock.net.cflags import cflags
 from spock.net.timer import EventTimer
 
 #Will relentlessly try to reconnect to a server
 class ReConnectPlugin:
-    def __init__(self, client, settings):
-        self.client = client
-        self.lock = False
-        self.kill = False
-        self.delay = 0
-
-        client.register_handler(self.start_timer, cflags['SOCKET_ERR'], cflags['SOCKET_HUP'])
-        client.register_handler(self.stop, cflags['KILL_EVENT'])
-        client.register_dispatch(self.start_timer, 0xFF)
-        client.register_dispatch(self.grab_host, 0x02)
-        client.register_dispatch(self.reset_reconnect_time, 0x01)
-
-    def start_timer(self, *args):
-        if not self.lock:
-            self.client.register_timer(EventTimer(self.delay, self.reconnect))
-            self.lock = True
-
-    def stop(self, *args):
-        self.kill = True
-
-    def reconnect(self, *args):
-        if not self.kill:
-            if self.delay < 300:
-                self.delay += 30
-            self.client.start_session(self.client.mc_username, self.client.mc_password)
-            self.client.login(self.host, self.port)
-            self.lock = False
-
-    def reset_reconnect_time(self, *args):
-        self.delay = 0
-
-    #Grabs host and port on handshake
-    def grab_host(self, packet):
-        self.host = packet.data['host']
-        self.port = packet.data['port']
+	def __init__(self, client, settings):
+		self.client = client
+		self.lock = False
+		self.kill = False
+		self.delay = 0
+
+		client.register_handler(self.start_timer, cflags['SOCKET_ERR'], cflags['SOCKET_HUP'])
+		client.register_handler(self.stop, cflags['KILL_EVENT'])
+		client.register_dispatch(self.start_timer, 0xFF)
+		client.register_dispatch(self.grab_host, 0x02)
+		client.register_dispatch(self.reset_reconnect_time, 0x01)
+
+	def start_timer(self, *args):
+		if not self.lock:
+			self.client.register_timer(EventTimer(self.delay, self.reconnect))
+			self.lock = True
+
+	def stop(self, *args):
+		self.kill = True
+
+	def reconnect(self, *args):
+		if not self.kill:
+			if self.delay < 300:
+				self.delay += 30
+			self.client.start_session(self.client.mc_username, self.client.mc_password)
+			self.client.login(self.host, self.port)
+			self.lock = False
+
+	def reset_reconnect_time(self, *args):
+		self.delay = 0
+
+	#Grabs host and port on handshake
+	def grab_host(self, packet):
+		self.host = packet.data['host']
+		self.port = packet.data['port']

setup.py

@@ -4,11 +4,11 @@
     name='spock',
     version='1.2',
     packages=[
-        'spock',
-        'spock.mcp',
-        'spock.mcmap',
-        'spock.plugins',
-        'spock.plugins.core',
-        'spock.plugins.helpers',
+    	'spock', 
+    	'spock.mcp', 
+    	'spock.mcmap',
+    	'spock.plugins',
+    	'spock.plugins.core',
+    	'spock.plugins.helpers',
     ],
 )