Skip to content

Commit 970dfaa

Browse files
committed
Adds a setup.py and MANIFEST.in file; also reorganizes file tree to accomodate a proper structure for publishing.
1 parent db565b4 commit 970dfaa

20 files changed

+116
-0
lines changed
File renamed without changes.

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include LICENSE.txt

README.txt

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
What is sc2reader?
2+
-------------------
3+
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.
7+
8+
Example Usage
9+
--------------
10+
11+
>>>from sc2reader import Replay
12+
>>>replay = Replay('path/to/replay.sc2replay')
13+
14+
#TODO: more work to be done here
15+
16+
17+
See the sc2replay `wiki`_ for additional usage details.
18+
19+
Current Status
20+
---------------
21+
22+
sc2reader is written to parse replays where build ``version >= 16561``. This means
23+
that the following information can be extracted:
24+
25+
- Replay details (map, length, version, game type, game speed, ...)
26+
- Player details (name, race, team, color, ...)
27+
- Message details (text, time, player, target, ...)
28+
- Game details (winners, losers, unit abilities,unit selections, ...)
29+
30+
For ``version < 16561``: replay, player, and message details can still be
31+
extracted because their formats do not seem to have changed as far as testing
32+
shows.
33+
34+
Support for older builds may be patched in future releases as development is
35+
on going.
36+
37+
Installation
38+
-------------
39+
40+
Requirements
41+
~~~~~~~~~~~~~
42+
43+
- Python 2.6+, Python 3.0 untested
44+
- The `mpyq`_ MPQ exraction library
45+
46+
Basic Install
47+
~~~~~~~~~~~~~~
48+
49+
::
50+
51+
$ easy_install sc2reader
52+
53+
Advanced Install
54+
~~~~~~~~~~~~~~~~~
55+
56+
::
57+
58+
$ git clone https://github.com/GraylinKim/sc2reader.git
59+
$ cd sc2reader
60+
$ python setup.py install
61+
62+
Issues and Support
63+
-------------------
64+
65+
Until some further infrastructure is set up:
66+
67+
- Please refer to the `wiki`_ for documentation
68+
- Visit `issue tracker`_ to report bugs and request features
69+
- `email me`_ for technical support issues.
70+
71+
72+
.. _email me: mailto:graylin.kim@gmail.com
73+
.. _mpyq: http://pypi.python.org/pypi/mpyq
74+
.. _wiki: https://github.com/GraylinKim/sc2reader/wiki
75+
.. _phpsc2replay: http://code.google.com/p/phpsc2replay/
76+
.. _issue tracker: https://github.com/GraylinKim/sc2reader/issues

sc2reader/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from replay import Replay
2+
3+
__version__ = "0.1.0"
File renamed without changes.

0 commit comments

Comments
 (0)