attempt to merge graylinkim/sc2reader hots branch into master branch of ggtracker/sc2reader

Author: dsjoerg

.gitignore

@@ -4,4 +4,7 @@ dist
 build
 sc2reader.egg-info
 replay_profile
-PKG-INFO.txt
+PKG-INFO.txt
+sc2reader/bin
+sc2reader/include
+sc2reader/lib

STYLE_GUIDE.rst

@@ -0,0 +1,39 @@
+STYLE GUIDE
+==============
+
+Use your common sense and have some decency. Also try to stick to the following where reasonable.
+
+
+Absolute Imports
+----------------------
+
+Always use absolute imports::
+
+	from __future__ import absolute_import
+
+That means imports should always start with sc2reader... instead of being relative to the current module.
+
+	from sc2reader.utils import ReplayBuffer
+
+
+Explicit Imports
+---------------------
+
+Prefer explicit imports to globbed imports
+
+	from sc2reader.events import ChatEvent
+
+is better than
+
+	from sc2reader.events import *
+
+
+Formatting Strings
+-----------------------
+
+Use string.format(args) instead string % (args).
+
+To support python 2.6, use numerical indexes even though it is a pain in the ass::
+
+	"{0} minerals, {1} gas, {2} terrazine, and {3} custom".format(self.minerals, self.vespene, self.terrazine, self.custom)
+

sc2reader/constants.py

@@ -50,71 +50,14 @@
     # ptBR - Brazilian Portuguese
 }
 
-#
-# Codes as found in bytestream
-#
-
-RACE_CODES = {
-    'Terr': 'Terran',
-    'Zerg': 'Zerg',
-    'Prot': 'Protoss',
-    'RAND': 'Random',
-}
 MESSAGE_CODES = {
     '0': 'All',
     '2': 'Allies',
     '128': 'Header',
     '125': 'Ping',
 }
-TEAM_COLOR_CODES = {
-    'tc01': "Red",
-    'tc02': "Blue",
-    'tc03': "Teal",
-    'tc04': "Purple",
-    'tc05': "Yellow",
-    'tc06': "Orange",
-    'tc07': "Green",
-    'tc08': "Light Pink",
-    'tc09': "Violet",
-    'tc10': "Light Grey",
-    'tc11': "Dark Green",
-    'tc12': "Brown",
-    'tc13': "Light Green",
-    'tc14': "Dark Grey",
-    'tc15': "Pink",
-    'tc16': "??",
-}
-DIFFICULTY_CODES = {
-    'VyEy': 'Very easy',
-    'Easy': 'Easy',
-    'Medi': 'Medium',
-    'Hard': 'Hard',
-    'VyHd': 'Very hard',
-    'Insa': 'Insane',
-}
-GAME_TYPE_CODES = {
-    'Priv': 'Private',
-    'Pub':  'Public',
-    'Amm':  'Ladder',
-    '':     'Single',
-}
-# (name, key for team ids)
-GAME_FORMAT_CODES = {
-    '1v1': '1v1',
-    '2v2': '2v2',
-    '3v3': '3v3',
-    '4v4': '4v4',
-    '5v5': '5v5',
-    '6v6': '6v6',
-    'FFA': 'FFA',
-}
-GAME_SPEED_CODES = {
-    'Slor': 'Slower',
-    'Slow': 'Slow',
-    'Norm': 'Normal',
-    'Fast': 'Fast',
-    'Fasr': 'Faster',
-}
+
+
 
 GAME_SPEED_FACTOR = {
     'Slower':   0.6,
@@ -124,12 +67,6 @@
     'Faster':   1.4
 }
 
-PLAYER_TYPE_CODES = {
-    'Humn': 'Human',
-    'Comp': 'Computer',
-    'Open': 'Open',
-    'Clsd': 'Closed',
-}
 GATEWAY_CODES = {
     'US': 'Americas',
     'KR': 'Asia',
@@ -355,3 +292,120 @@
         1: 'xx',
     },
 }
+
+""" Still unknown
+    bbe: 3, 5, 7, 10, 15, 20, 25, 30
+"""
+LOBBY_PROPERTIES = {
+    # Default seems to be the only value possible.
+    # This arcade entry is just a hunch, need to confirm with an arcade game
+    0x03E8: ("???", {
+                'Dflt': 'Default'
+            }),
+    0x03E9: ("Arcade", {
+                'no':'no',
+                'yes':'yes'
+            }),
+
+    0x01F4: ("Player Type",  {
+                'Humn': 'Human',
+                'Comp': 'Computer',
+                'Open': 'Open',
+                'Clsd': 'Closed',
+            }),
+
+    0x07D1: ("Game Mode", {
+                '1v1': '1v1',
+                '2v2': '2v2',
+                '3v3': '3v3',
+                '4v4': '4v4',
+                '5v5': '5v5',
+                '6v6': '6v6',
+                'FFA': 'FFA',
+            }),
+
+    0x07D0: ("Team Count", lambda value: value), #T1,2,3,4,5,6, or Custom
+    0x07D2: ("Teams1v1", lambda value: int(value[1:])),
+    0x07D3: ("Teams2v2", lambda value: int(value[1:])),
+    0x07D4: ("Teams3v3", lambda value: int(value[1:])),
+    0x07D5: ("Teams4v4", lambda value: int(value[1:])),
+    0x07D6: ("TeamsFFA", lambda value: int(value[1:])),
+    0x07D7: ("Teams5v5", lambda value: int(value[1:])),
+    0x07D8: ("Teams6v6", lambda value: int(value[1:])),
+
+    0x07DB: ("2 Teams", lambda value: int(value[1:])),
+    0x07DC: ("3 Teams", lambda value: int(value[1:])),
+    0x07DD: ("4 Teams", lambda value: int(value[1:])),
+    0x07DE: ("5 Teams", lambda value: int(value[1:])),
+
+    0x07E1: ("FFA Teams", lambda value: int(value[1:])),
+    0x07E2: ("Custom Teams", lambda value: int(value[1:])),
+
+    0x0BB8: ("Game Speed", {
+                'Slor': 'Slower',
+                'Slow': 'Slow',
+                'Norm': 'Normal',
+                'Fast': 'Fast',
+                'Fasr': 'Faster',
+            }),
+    0x0BB9: ("Race", {
+                'Terr': 'Terran',
+                'Zerg': 'Zerg',
+                'Prot': 'Protoss',
+                'RAND': 'Random',
+            }),
+    0x0BBA: ("Color", {
+                'tc01': "Red",
+                'tc02': "Blue",
+                'tc03': "Teal",
+                'tc04': "Purple",
+                'tc05': "Yellow",
+                'tc06': "Orange",
+                'tc07': "Green",
+                'tc08': "Light Pink",
+                'tc09': "Violet",
+                'tc10': "Light Grey",
+                'tc11': "Dark Green",
+                'tc12': "Brown",
+                'tc13': "Light Green",
+                'tc14': "Dark Grey",
+                'tc15': "Pink",
+                'tc16': "??",
+            }),
+    0x0BBB: ("Handicap", {
+                '50': '50',
+                '60': '60',
+                '70': '70',
+                '80': '80',
+                '90': '90',
+                '100': '100',
+            }),
+    0x0BBC: ("Difficulty", {
+                'VyEy': 'Very easy',
+                'Easy': 'Easy',
+                'Medi': 'Medium',
+                'Hard': 'Hard',
+                'VyHd': 'Very hard',
+                'Insa': 'Insane',
+            }),
+
+
+    0x0BBF: ("Player Type", {
+                'Part':'Participant',
+                'Watc':'Watcher'
+            }),
+    0x0BC0: ("Watcher Type", {
+                'Obs': 'Observer',
+                'Ref':'Referee'
+            }),
+    0x0BC1: ("Category", {
+                'Priv': 'Private',
+                'Pub':  'Public',
+                'Amm':  'Ladder',
+                '':     'Single',
+            }),
+    0x0BC2: ("Alliances", {
+                'no':'unlocked',
+                'yes':'locked',
+            })
+}