s2protocol is a reference Python library and standalone tool to decode StarCraft II replay files into Python data structures.
Currently s2protocol can decode these structures and events:
s2protocol can be used as a base-build-specific library to decode binary blobs, or it can be run as a standalone tool to pretty print information from supported replay files.
Note that s2protocol does not expose game balance information or provide any kind of high level analysis of replays; it's meant to be just the first tool in the chain for your data mining application.
s2protocol supports all StarCraft II replay files that were written with retail versions of the game. The current plan is to support all future publicly released versions, including public betas.
Some notes on tracker events:
unitIndex = event['m_firstUnitIndex'] for i in range(0, len(event['m_items']), 3): unitIndex += event['m_items'][i + 0] x = event['m_items'][i + 1] * 4 y = event['m_items'][i + 2] * 4 # unit identified by unitIndex at the current event['_gameloop'] time is at approximate position (x, y)
Copyright (c) 2013 Blizzard Entertainment
Open sourced under the MIT license. See the included LICENSE file for more information.
The standalone tool uses mpyq to read mopaq files.
Thanks to David Joerg and Graylin Kim of GGTracker for design feedback and beta-testing.
There are unofficial ports of s2protocol (and the required MPQ parser) available in other languages:
This Go implementation is a standalone project for both the MPQ parser and the s2protocol implementation (also provide some higher level API):
Go MPQ parser: https://github.com/icza/mpq
Go s2protocol: https://github.com/icza/s2prot
This Java implementation is part of the open source Scelight project (which is much more than just a replay parser, it also gives a high-level API):