polishing and version bump

Author: XenGi

controller_example.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python2.7
+#!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 
 """
@@ -18,6 +18,8 @@
 
 import pygame
 
+DEBUG = True
+
 # define some constants
 E_UID = pygame.USEREVENT + 1
 E_DOWNLOAD = pygame.USEREVENT + 2
@@ -29,7 +31,7 @@ class ReceiverThread(Thread):
     """
     This thread will listen on a UDP port for packets from the game.
     """
-    def __init__(self, host='0.0.0.0', port=11337):
+    def __init__(self, host='0.0.0.0', port=1338):
         """
         Creates the socket and binds it to the given host and port.
         """
@@ -48,24 +50,26 @@ def run(self):
             logging.warning('example warning')
             logging.error('example error')
             logging.critical('example critical')
-            #print(datetime.now(), '<<< {}'.format(data))
             if data.startswith('/uid/'):
-                #print(datetime.now(), '### uid', data[5:], 'received')
                 e = pygame.event.Event(E_UID, {'uid': int(data[5:])})
                 pygame.event.post(e)
+                if DEBUG: logging.info('uid received: {}'.format(data[5:]))
             elif data.startswith('/download/'):
                 e = pygame.event.Event(E_DOWNLOAD, {'url': str(data[10:])})
                 pygame.event.post(e)
+                if DEBUG: logging.info('download of {} triggered'.format(data[10:]))
             elif data.startswith('/play/'):
                 e = pygame.event.Event(E_PLAY, {'filename': str(data[6:])})
                 pygame.event.post(e)
+                if DEBUG: logging.info('playback of {} triggered'.format(data[6:]))
             elif data.startswith('/rumble/'):
-                e = pygame.event.Event(E_RUMBLE, {'duration': float(data[8:].replace(',', '.'))})
+                e = pygame.event.Event(E_RUMBLE, {'duration': int(data[8:])})
                 pygame.event.post(e)
+                if DEBUG: logging.info('request rumble for {}ms'.format(data[8:]))
 
 
 class Controller(object):
-    def __init__(self, game_host='127.0.0.1', game_port=1338, host='0.0.0.0', port=11337):
+    def __init__(self, game_host='127.0.0.1', game_port=1338, host='0.0.0.0', port=1338):
         self.game_host = game_host  # Host of Mate Light
         self.game_port = game_port  # Port of Mate Light
         self.host = host  # Host of ReceiverThread
@@ -104,35 +108,41 @@ def __init__(self, game_host='127.0.0.1', game_port=1338, host='0.0.0.0', port=1
 
     def ping(self):
         if self.uid:
+            if DEBUG: logging.info('sending ping')
             msg = '/controller/{}/ping/{}'.format(self.uid, self._receiver.port)
             self.sock.sendto(msg.encode('utf-8'), (self.game_host, self.game_port))
-            #print(datetime.now(), '>>>', msg)
 
     def send_keys(self):
         # alternative states creation: [1 if k else 0 for k in self.keys]
         states = '/controller/{}/states/{}'.format(self.uid, ''.join([str(k) for k in self.keys]))
+        if DEBUG: logging.info('sending states {}'.format(''.join([str(k) for k in self.keys])))
         self.sock.sendto(states.encode('utf-8'), (self.game_host, self.game_port))
-        #print(datetime.now(), '>>>' + states)
         self.timeout = time.time()
 
     def send_message(self, msg):
+        if DEBUG: logging.info('sending of messages not yet implemented')
         pass
 
     def disconnect(self):
+        if DEBUG: logging.info('disconnecting from game')
         msg = '/controller/{}/kthxbye'.format(self.uid)
         self.sock.sendto(msg.encode('utf-8'), (self.game_host, self.game_port))
 
     def connect(self):
+        if DEBUG: logging.info('connecting to game')
         msg = '/controller/new/{}'.format(self.port)
         self.sock.sendto(msg.encode('utf-8'), (self.game_host, self.game_port))
 
     def rumble(self, duration):
+        if DEBUG: logging.info('rumble not yet implemented')
         pass
 
     def download_sound(self, url):
+        if DEBUG: logging.info('downloading of media files not yet implemented')
         pass
 
     def play_sound(self, filename):
+        if DEBUG: logging.info('playing media files not yet implemented')
         pass
 
     def handle_inputs(self):
@@ -147,11 +157,9 @@ def handle_inputs(self):
             elif event.type == pygame.MOUSEBUTTONUP:
                 pygame.event.post(pygame.event.Event(pygame.QUIT))
             elif event.type == E_UID:
-                #print(datetime.now(), '### UID event received', event.uid)
                 self.uid = event.uid
 
             if self.uid is not None:
-                #print(datetime.now(), '### UID set. checking other events')
                 if event.type == E_DOWNLOAD:
                     self.download_sound(event.url)
                 elif event.type == E_PLAY:
@@ -162,22 +170,19 @@ def handle_inputs(self):
                     try:
                         button = self.mapping[event.key]
                         if event.type == pygame.KEYDOWN:
-                            #print('{} | {}'.format(event.key, button))
                             self.keys[button] = 1
                         elif event.type == pygame.KEYUP:
-                            #print('{} | {}'.format(event.key, button))
                             self.keys[button] = 0
                         self.send_keys()
                     except KeyError:
                         break
             else:
-                #print(datetime.now(), '### UID not set. connecting to game.')
                 self.connect()
                 time.sleep(1)
 
 
 if __name__ == '__main__':
-    ctlr = Controller('127.0.0.1', 1338, '0.0.0.0', 11337)
+    ctlr = Controller('127.0.0.1', 1338, '0.0.0.0', 1338)
     try:
         while True:
             ctlr.handle_inputs()

emulator.py

@@ -57,7 +57,6 @@ def __init__(self, width=40, height=16, ip='127.0.0.1', port=1337, dotsize=10):
         self.clock = pygame.time.Clock()
         self.matrix = []
         for c in range(self.width * self.height * 3):
-            # fill matrix with black color
             self.matrix.append(0)
 
         self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

game_example.py

@@ -13,15 +13,15 @@
 __copyright__ = 'Copyright 2014, Ricardo Band'
 __credits__ = ['Ricardo Band']
 __license__ = 'MIT'
-__version__ = '0.2.0'
+__version__ = '0.3.0'
 __maintainer__ = 'Ricardo Band'
 __email__ = '[email protected]'
 __status__ = 'Development'
 
 from datetime import datetime
 
 import pymlgame
-from pymlgame.locals import *
+from pymlgame.locals import WHITE, BLUE, GREEN, CYAN, MAGENTA, YELLOW, RED, BLACK, E_NEWCTLR, E_DISCONNECT, E_KEYDOWN, E_KEYUP, E_PING
 from pymlgame.screen import Screen
 from pymlgame.clock import Clock
 from pymlgame.surface import Surface

pymlgame/__init__.py

@@ -1,10 +1,14 @@
 # -*- coding: utf-8 -*-
 
+"""
+PyMLGame
+"""
+
 __author__ = 'Ricardo Band'
 __copyright__ = 'Copyright 2014, Ricardo Band'
 __credits__ = ['Ricardo Band']
 __license__ = 'MIT'
-__version__ = '0.2.0'
+__version__ = '0.3.0'
 __maintainer__ = 'Ricardo Band'
 __email__ = '[email protected]'
 __status__ = 'Development'
@@ -15,17 +19,17 @@
 from pymlgame.surface import Surface
 from pymlgame.controller import Controller
 
-_ctlr = Controller()
+CONTROLLER = Controller()
 
 
 def init(host='0.0.0.0', port=1338):
     """
-    Initialize pymlgame. This creates a controller thread that listens for game controllers and events.
+    Initialize PyMLGame. This creates a controller thread that listens for game controllers and events.
     """
-    _ctlr.host = host
-    _ctlr.port = port
-    _ctlr.setDaemon(True)  # because it's a deamon it will exit together with the main thread
-    _ctlr.start()
+    CONTROLLER.host = host
+    CONTROLLER.port = port
+    CONTROLLER.setDaemon(True)  # because it's a deamon it will exit together with the main thread
+    CONTROLLER.start()
 
 
 def get_events(maximum=10):
@@ -35,10 +39,10 @@ def get_events(maximum=10):
     events = []
     for ev in range(0, maximum):
         try:
-            if _ctlr.queue.empty():
+            if CONTROLLER.queue.empty():
                 break
             else:
-                events.append(_ctlr.queue.get_nowait())
+                events.append(CONTROLLER.queue.get_nowait())
         except NameError:
             not_initialized()
             events = False
@@ -50,11 +54,11 @@ def get_event():
     """
     Get the next event in the queue if there is one.
     """
-    if not _ctlr.queue.empty():
-        return _ctlr.queue.get_nowait()
+    if not CONTROLLER.queue.empty():
+        return CONTROLLER.queue.get_nowait()
     else:
         return False
 
 
 def not_initialized():
-    print('pymlgame is not initialized correctly. Use pymlgame.init() first.')
+    print('PyMLGame is not initialized correctly. Use pymlgame.init() first.')

pymlgame/clock.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Clock
+PyMLGame - Clock
 """
 
 import time
@@ -21,5 +21,5 @@ def tick(self):
         """
         Let the Clock tick.
         """
-        #TODO: I think this is not the correct way. Should think about this again..
-        time.sleep(1.0/self.fps)
+        #TODO: I think this is not the correct way. I should think about this again..
+        time.sleep(1.0/self.fps)

pymlgame/controller.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Controller
+PyMLGame - Controller
 """
 
 from uuid import uuid4
@@ -11,7 +11,7 @@
 from queue import Queue
 from threading import Thread
 
-from pymlgame.locals import *
+from pymlgame.locals import E_NEWCTLR, E_DISCONNECT, E_PING, E_KEYUP, E_KEYDOWN, E_MESSAGE, E_RUMBLE
 from pymlgame.event import Event
 
 
@@ -39,7 +39,7 @@ def _new_controller(self, addr, port):
         for uid, controller in self.controllers.items():
             if controller[0] == addr:
                 # duplicate address. sending the uid again
-                print('/uid/{} => {}:{}'.format(uid, addr, port))
+                #print('/uid/{} => {}:{}'.format(uid, addr, port))
                 self.sock.sendto('/uid/{}'.format(uid).encode('utf-8'), (addr, port))
                 return False
 
@@ -48,7 +48,7 @@ def _new_controller(self, addr, port):
         self.controllers[uid] = [addr, port, '00000000000000', time.time()]
 
         # tell the controller about it
-        print('/uid/{} => {}:{}'.format(uid, addr, port))
+        #print('/uid/{} => {}:{}'.format(uid, addr, port))
         self.sock.sendto('/uid/{}'.format(uid).encode('utf-8'), (addr, port))
 
         # create event for pymlgame
@@ -128,10 +128,10 @@ def send(self, uid, event, payload):
             addr = self.controllers[uid][0]
             port = self.controllers[uid][1]
             if event == E_MESSAGE:
-                print('/message/{} => {}:{}'.format(payload, addr, port))
+                #print('/message/{} => {}:{}'.format(payload, addr, port))
                 return sock.sendto('/message/{}'.format(payload).encode('utf-8'), (addr, port))
             elif event == E_RUMBLE:
-                print('/rumble/{} => {}:{}'.format(payload, addr, port))
+                #print('/rumble/{} => {}:{}'.format(payload, addr, port))
                 return sock.sendto('/rumble/{}'.format(payload).encode('utf-8'), (addr, port))
             else:
                 pass
@@ -147,7 +147,6 @@ def run(self):
             data, sender = self.sock.recvfrom(1024)
             addr = sender[0]
             msg = data.decode('utf-8')
-            print('New msg: ' + msg)
             if msg.startswith('/controller/'):
                 try:
                     uid = msg.split('/')[2]

pymlgame/event.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Event
+PyMLGame - Event
 """
 
 from pymlgame.locals import E_KEYDOWN, E_KEYUP

pymlgame/locals.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Locals
+PyMLGame - Locals
 """
 
 # event types
@@ -52,4 +52,4 @@
 GREY3 = (178, 178, 178)
 GREY2 = (204, 204, 204)
 GREY1 = (229, 229, 229)
-WHITE = (255, 255, 255)
+WHITE = (255, 255, 255)

pymlgame/screen.py

@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Screen
+PyMLGame - Screen
 """
 
 import socket
 
-from pymlgame.locals import *
+from pymlgame.locals import BLACK
 from pymlgame.surface import Surface
 
 

pymlgame/surface.py

@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
 
 """
-pymlgame - Surface
+PyMLGame - Surface
 """
 
 import math
 
-from pymlgame.locals import *
+from pymlgame.locals import BLACK
 
 
 class Surface(object):
@@ -111,4 +111,4 @@ def replace_color(self, before, after):
         for x in range(self.width):
             for y in range(self.height):
                 if self.matrix[x][y] == before:
-                    self.matrix[x][y] = after
+                    self.matrix[x][y] = after

setup.py

@@ -9,7 +9,7 @@
 __copyright__ = 'Copyright 2014, Ricardo Band'
 __credits__ = ['Ricardo Band']
 __license__ = 'MIT'
-__version__ = '0.2.0'
+__version__ = '0.3.0'
 __maintainer__ = 'Ricardo Band'
 __email__ = '[email protected]'
 __status__ = 'Development'
@@ -25,16 +25,16 @@
 def read(fname):
     return open(os.path.join(os.path.dirname(__file__), fname)).read()
 
-setup(name='pymlgame',
+setup(name='PyMLGame',
       version=__version__,
       author=__author__,
       author_email=__email__,
       maintainer=__maintainer__,
       maintainer_email=__email__,
-      url='http://github.com/c-base/pymlgame',
-      description='pymlgame is an abstraction layer to easily build games for Mate Light inspired by pygame.',
+      url='http://github.com/PyMLGame/pymlgame',
+      description='PyMLGame is an abstraction layer to easily build games for Mate Light inspired by PyGame.',
       long_description=read('README.md'),
-      download_url='https://github.com/c-base/pymlgame/archive/master.zip',
+      download_url='https://github.com/PyMLGame/pymlgame/archive/master.zip',
       classifiers=['Development Status :: 4 - Beta',
                    'Environment :: Console',
                    'Intended Audience :: Developers',