Blizzard / Blizzard/s2protocol

How to get started?

Open
#68 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
641
Forks
118
PR merge metrics
No merged PRs in 30d

Description

This is quite frustrating! I have been scouring the internet for some sort of idea how to get started with this replay parser. I can get the "load programmatically" http://s2protocol.readthedocs.io/en/latest/tutorial.html#using-s2protocol-programmatically

`import mpyq

archive = mpyq.MPQArchive("C:/Users/Tim/Desktop/Replays/replay1.SC2Replay")
contents = archive.header['user_data_header']['content']

from s2protocol import versions
header = versions.latest().decode_replay_header(contents)`

I get the header object result but it seems it is just a bunch of game version, and bunch of not what I need beeswax.

What other parameters are there besides ['user_data_header'] and ['content']? What do I need to parse to get the game events? such as number of workers, or minerals mined or game time?

The documentation does no help it just says "Oh you would need to load the files programmatically", ok, then what? the example was useful to load the replay file but how do I read the bloody contents?

I am sorry, I am a complete python noob and would prefer to work in R for this but unfortunately the parser is written in python :(

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked programmatic tutorial and the shown mpyq/s2protocol loading example. Identify and document the path from the decoded replay header to game events such as workers, minerals, and game time. Done means the documentation explains the required inputs and access pattern for those events.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.