Skip to content

Commit 84ad88e

Browse files
committed
Adds 1.2 support as well as a broken start on 1.0 support. Fixes several bugs and typos. Updates the README.txt file to point to the mailing list and point more prominently at the issue tracker.
1 parent 185061f commit 84ad88e

16 files changed

+668
-396
lines changed

README.txt

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
What is sc2reader?
22
-------------------
33

4-
sc2reader is a library for extracting game information from Starcraft II
5-
replay files into a replay object. It is based heavily on documentation
6-
from the awesome `phpsc2replay`_ project.
4+
1. sc2reader is a library for extracting game information from Starcraft II
5+
replay files into a replay object. Please join the `mailing list`_ to be
6+
notified of updates and participate in discussion around the replay format.
7+
8+
2. sc2reader is also a format documentation project, documentation is always in
9+
progress and the latest and greatest can be found on the `github wiki`.
10+
11+
Contributions, bugs, and suggestions are always welcome. Please direct them
12+
to the `issue tracker`_ or the `mailing list`_ as appropriate.
13+
14+
*Special thanks to the people of the awesome `phpsc2replay` project whose
15+
public documentation and source code made this library possible.*
716

817
Example Usage
918
--------------
@@ -34,7 +43,7 @@ wraps up the above code as a (simple) demonstration of the libraries utility::
3443

3544
$ sc2printer game1.sc2replay game2.sc2replay
3645

37-
See the sc2replay `wiki`_ for additional usage details.
46+
See the sc2replay `wiki`_ for additional usage details (coming soon).
3847

3948
Current Status
4049
---------------
@@ -47,12 +56,12 @@ that the following information can be extracted:
4756
- Message details (text, time, player, target, ...)
4857
- Game details (winners, losers, unit abilities,unit selections, ...)
4958

50-
For ``version < 16561``: replay, player, and message details can still be
59+
For 1.1 release replays: replay, player, and message details can still be
5160
extracted because their formats do not seem to have changed as far as testing
5261
shows.
5362

54-
Support for older builds may be patched in future releases as development is
55-
on going.
63+
Very experimental support for 1.0 and 1.2 replays has been added. 1.0 support
64+
is completely untested as I don't have any 1.0 replays (I'll find some soon).
5665

5766
Installation
5867
-------------
@@ -86,12 +95,12 @@ Issues and Support
8695

8796
Until some further infrastructure is set up:
8897

89-
- Please refer to the `wiki`_ for documentation
98+
- Refer to the `wiki`_ for replay format documentation
9099
- Visit `issue tracker`_ to report bugs and request features
91-
- `email me`_ for technical support issues.
100+
- Join the `mailing list`_ to request support and contribute to the effort
92101

93102

94-
.. _email me: mailto:graylin.kim@gmail.com
103+
.. _mailing list: http://groups.google.com/group/sc2reader
95104
.. _mpyq: http://pypi.python.org/pypi/mpyq
96105
.. _wiki: https://github.com/GraylinKim/sc2reader/wiki
97106
.. _phpsc2replay: http://code.google.com/p/phpsc2replay/

sc2reader/data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
0x021b00: 'Warp in Zealot',
8080
0x030510: 'Warp in Zealot (warp gate)',
8181
0x021b01: 'Warp in Stalker',
82-
0x030511: 'Wrap in Stalker (warp gate)',
82+
0x030511: 'Warp in Stalker (warp gate)',
8383
0x021b05: 'Warp in Sentry',
8484
0x030515: 'Warp in Sentry (warp gate)',
8585
0x030513: 'Warp in High Templar (warp gate)',

0 commit comments

Comments
 (0)