Skip to main content

spawningtool

spawningtool is tools for analyzing StarCraft 2 Replays. It uses the data parsed by [sc2reader](https://github.com/ggtracker/sc2reader) to make data available in a more human-digestable format.

Currently, spawningtool offers a basic parser for extracting build orders from replays. Our goal is to incorporate more sophisticated techniques from Artificial Intelligence to understand and classify these build orders.

Installation

From PyPi (stable but often out of date for the latest patch) `bash pip install spawningtool `

From GitHub (less stable but recommended) `bash pip install -e git+git://github.com/StoicLoofah/spawningtool.git#egg=spawningtool `

Note that master usually requires sc2reader master, not the latest versioned release, so you will need to grab sc2reader from GitHub as well. Although it is less stable, it is recommended because the latest versions of both spawningtool and sc2reader are necessary to parse the most recent patches of StarCraft 2

Usage

To execute it directly from the command line `bash python -m spawningtool PATH/TO/REPLAY `

To execute it from within python `python import spawningtool.parser spawningtool.parser.parse_replay('PATH/TO/REPLAY') `

For more notes, see the [GitHub wiki](https://github.com/StoicLoofah/spawningtool/wiki)

Support

Please submit any issues you encounter to the [GitHub project](https://github.com/StoicLoofah/spawningtool/issues). You’re also welcome to email Kevin directly at kevin@kevinleung.com.

Thanks To

  • @dsjoerg for many contributions to sc2reader and replay parsing as a whole through his work at ggtracker

  • @hahnicity for all of the code cleanup. Previously, spawningtool was just a script. Thanks to his help, the code is actually readable and packaged for others to use and improve

  • @GraylinKim for lots of support. Even before the project switched over to using [sc2reader](https://github.com/GraylinKim/sc2reader), he offered advice and tips on getting this project off the ground.

Changes

  • v2.2.0, October 7, 2018 – bump sc2reader==1.2.0 for StarCraft 4.6, add Tychus

  • v2.1.0, June 13, 2018 – fix Lair and Hive co-op build time, add Abathur building morph reduction, fix co-op generic build times, moved this file

  • v2.0.0, May 18, 2018 – continuous integration, StarCraft 2 4.0 support (new unit types, chronoboost, etc.), Co-op support

  • v1.0.0, December 9, 2016 – improved LotV chronoboost support, better unit type coverage, updated to LotV 3.8.0 data

  • v0.2.1, December 12, 2015 – Legacy of the Void support, HotS chrono boost

  • v0.2.0, March 3, 2015 – python3 support, analysis script examples, map details, caching

  • v0.1.3, August 12, 2013 – bump to sc2reader 0.6.0, unit tests, add unit change events to build order, add units lost, add ability extraction

  • v0.1.2, June 15, 2013 – Locking in sc2reader version, fix supply for it

  • v0.1.1, May 12, 2013 – Updating main to be accessible via the package, adding more metadata

  • v0.1.0, May 12, 2013 – Initial release

Release files for spawningtool 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spawningtool 2.2.0
File Size Uploaded
spawningtool-2.2.0.tar.gz 33.3 kB Details

Release files / spawningtool-2.2.0.tar.gz

Download URL spawningtool-2.2.0.tar.gz
Size 33.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ebb7d9acca9d076bcb78273fb809458fc7fcec0df4e040f9c408976b848a6fb6
BLAKE2b-256 checksum
How to use checksums
c178e228768dae888d3d5dcccb56494bbad14dd0ae20f9d8e584bd48394a9549
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.12.4 setuptools/33.1.1 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.4.3

Release history Release notifications | RSS feed

3.0.0

2 release files

2.12.0

2 release files

2.10.0

2 release files

2.9.0

2 release files

2.8.0

2 release files

2.7.0

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.2

2 release files

2.2.1

2 release files

This release

2.2.0 This release

1 release file

2.1.0

1 release file

2.0.2

1 release file

2.0.1

1 release file

1.0.0

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page