Blizzard / Blizzard/s2protocol
Need documentation/code examples for encoders.py
- Dominant language
- Python
- Stars
- 641
- Forks
- 118
- PR merge metrics
- No merged PRs in 30d
Description
I have read gameevents like here:
https://github.com/Blizzard/s2protocol/blob/master/docs/tutorial_API.rst
And I deleted some gameevent then trying to encode back to a replay file,
https://github.com/Blizzard/s2protocol/blob/ea1fe843b46ee5589a86054361d8d13e49483790/s2protocol/encoders.py seems like can do it,but there is no code examples for that.
Any one knows how to do?
Contributor guide
No contributing guide indexed for this repository
Research direction
Read docs/tutorial_API.rst and inspect s2protocol/encoders.py to understand how decoded game events are represented and encoded. Document a concrete example for removing an event and encoding the result back into a replay file, including what successful output looks like.
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
- 35/100