Skip to content

Commit 34e6aa5

Browse files
authored
Merge pull request #59 from StoicLoofah/39-v1_release
v1 release
2 parents a76c954 + db816b8 commit 34e6aa5

File tree

3 files changed

+31
-23
lines changed

3 files changed

+31
-23
lines changed

CHANGELOG.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
CHANGELOG
22
============
33

4-
0.8.0 -
4+
1.0.0 - May 18, 2018
5+
--------------------
6+
* Added support for protocol 48258 through 64469
7+
* Update game data and scripts for generating game data
8+
* Fix ggtracker/sc2reader CircleCI build for python 3
9+
* Added support for parsing Co-op replays
10+
11+
0.8.0 - December 16, 2016
512
---------------------------
613
* Merged into ggtracker/sc2reader, which mostly means that we have a bunch of parsing fixes. Thanks @StoicLoofah!
714

README.rst

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ Who Uses sc2reader?
1212

1313
sc2reader is currently powering:
1414

15-
* Websites: `ggtracker.com`_, `gamereplays.org`_, `sc2companion.com`_
15+
* Websites: `gggreplays.com`_, `gamereplays.org`_, `spawningtool.com`_
1616
* Tools: `The Core`_
1717
* Experiments: `Midi Conversion`_
1818

1919
If you use sc2reader and you would like your tool, site, project, or implementation listed above, drop us a line on our `mailing list`_ or stop by our #sc2reader IRC channel and say hi!
2020

2121

22-
.. _ggtracker.com: http://ggtracker.com
22+
.. _gggreplays.com: http://gggreplays.com
2323
.. _gamereplays.org: http://www.gamereplays.org/starcraft2/
24-
.. _sc2companion.com: http://sc2companion.com
24+
.. _spawningtool.com: https://lotv.spawningtool.com
2525
.. _The Core: http://www.teamliquid.net/forum/viewmessage.php?topic_id=341878
2626
.. _Midi Conversion: https://github.com/obohrer/sc2midi
2727

@@ -47,7 +47,7 @@ Replays can be parsed for the following general types of information:
4747
- Unfiltered Unit commands (attack, move, train, build, psi storm, etc)
4848
- Camera Movements for all players and observers.
4949

50-
Replays from release 2.0.8 on ward make additional state information available:
50+
Replays from release 2.0.8 onward make additional state information available:
5151

5252
- Unit states - creation time, positions, and deaths times
5353
- Player resource stats - collection rates/unspent totals
@@ -142,7 +142,7 @@ If you want to load a collection of replays, you can use the plural form. Loadin
142142

143143
replays = sc2reader.load_replays('path/to/replay/directory')
144144

145-
.. _sc2reader.scripts: https://github.com/GraylinKim/sc2reader/tree/master/sc2reader/scripts
145+
.. _sc2reader.scripts: https://github.com/ggtracker/sc2reader/tree/upstream/sc2reader/scripts
146146

147147

148148
Loading Maps
@@ -214,46 +214,46 @@ or with setuptools (specify a valid x.x.x)::
214214
cd sc2reader-x.x.x
215215
python setup.py install
216216

217-
Releases to PyPi can be very delayed (sorry!), for the latest and greatest you are encouraged to install from Github master.
217+
Releases to PyPi can be very delayed (sorry!), for the latest and greatest you are encouraged to install from Github upstream.
218218

219219

220220
From Github
221221
--------------------------
222222

223-
Github master is generally stable with development branches more unstable.
223+
Github upstream is generally stable with development branches more unstable.
224224

225-
We use `travis-ci`_ to provide a record of our `continuous testing`_ and `coveralls.io`_ provides a record of our `test coverage`_. Please verify that tests are passing before installing development versions.
225+
We use `circle-ci`_ to provide a record of our `continuous testing`_. Please verify that tests are passing before installing development versions.
226226

227227
Install from the latest source on Github with pip::
228228

229-
pip install -e git+git://github.com/GraylinKim/sc2reader#egg=sc2reader
229+
pip install -e git+git://github.com/ggtracker/sc2reader#egg=sc2reader
230230

231231
or with setuptools::
232232

233-
wget -O sc2reader-master.tar.gz https://github.com/GraylinKim/sc2reader/tarball/master
234-
tar -xzf sc2reader-master.tar.gz
235-
cd sc2reader-master
233+
wget -O sc2reader-upstream.tar.gz https://github.com/ggtracker/sc2reader/tarball/upstream
234+
tar -xzf sc2reader-upstream.tar.gz
235+
cd sc2reader-upstream
236236
python setup.py install
237237

238-
.. _travis-ci: https://travis-ci.org/
238+
.. _circle-ci: https://circleci.com/
239239
.. _coveralls.io: https://coveralls.io
240240
.. _test coverage: https://coveralls.io/r/GraylinKim/sc2reader
241-
.. _continuous testing: https://travis-ci.org/GraylinKim/sc2reader
241+
.. _continuous testing: https://circleci.com/gh/ggtracker/sc2reader
242242

243243

244244
For Contributors
245245
-------------------
246246

247247
Contributors should install from an active git repository using setuptools in `develop`_ mode. This will install links to the live code so that local edits are available to external modules automatically::
248248

249-
git clone https://github.com/GraylinKim/sc2reader.git
249+
git clone https://github.com/ggtracker/sc2reader.git
250250
cd sc2reader
251251
python setup.py develop
252252

253253
Please review the `CONTRIBUTING.md`_ file and get in touch with us before doing too much work. It'll make everyone happier in the long run.
254254

255255
.. _develop: http://peak.telecommunity.com/DevCenter/setuptools#development-mode
256-
.. _CONTRIBUTING.md: https://github.com/GraylinKim/sc2reader/blob/master/CONTRIBUTING.md
256+
.. _CONTRIBUTING.md: https://github.com/ggtracker/sc2reader/blob/upstream/CONTRIBUTING.md
257257

258258

259259
Testing
@@ -273,8 +273,8 @@ When repeatedly running tests it can be very helpful to make sure you've set a l
273273
To run just one test:
274274

275275
SC2READER_CACHE_DIR=local_cache PYTHONPATH=. python -m unittest test_replays.test_all.TestReplays.test_38749
276-
277-
276+
277+
278278
Good luck, have fun!
279279

280280

@@ -290,7 +290,7 @@ Issues and Support
290290
We have an `issue tracker`_ on Github that all bug reports and feature requests should be directed to. We have a `mailing list`_ with Google Groups that you can use to reach out for support. We are generally on FreeNode in the #sc2reader and can generally provide live support and address issues there as well.
291291

292292
.. _mailing list: http://groups.google.com/group/sc2reader
293-
.. _issue tracker: https://github.com/GraylinKim/sc2reader/issues
293+
.. _issue tracker: https://github.com/ggtracker/sc2reader/issues
294294

295295

296296
Acknowledgements
@@ -310,6 +310,7 @@ and kept this project going.
310310
their `s2protocol`_ full reference implementation.
311311

312312

313+
.. _ggtracker.com: http://ggtracker.com
313314
.. _phpsc2replay: http://code.google.com/p/phpsc2replay/
314315
.. _sc2replay-csharp: https://github.com/ascendedguard/sc2replay-csharp
315316
.. _s2protocol: https://github.com/Blizzard/s2protocol

setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
setuptools.setup(
55
license="MIT",
66
name="sc2reader",
7-
version='0.8.0',
7+
version='1.0.0',
88
keywords=["starcraft 2", "sc2", "replay", "parser"],
99
description="Utility for parsing Starcraft II replay files",
1010
long_description=open("README.rst").read()+"\n\n"+open("CHANGELOG.rst").read(),
1111

12-
author="Graylin Kim",
13-
author_email="graylin.kim@gmail.com",
12+
author="Kevin Leung",
13+
author_email="kkleung89@gmail.com",
1414
url="https://github.com/ggtracker/sc2reader",
1515

1616
platforms=["any"],

0 commit comments

Comments
 (0)