README
¶
screp
StarCraft: Brood War replay parser.
The package is designed to be used by other packages or apps, and is safe for concurrent use. There is also an example CLI app that can be used standalone.
Parses both "modern" (starting from 1.18) and "legacy" (pre 1.18) replays.
Check out the sister project to parse StarCraft II replays: s2prot
Using the screp CLI app
There is a command line application in the cmd/screp folder which can be used to parse and display information about a single replay file.
The extracted data is displayed using JSON representation.
Usage is as simple as:
screp [FLAGS] repfile.rep
Run with -h to see the list of available flags.
Example to parse a file called sample.rep, and display replay header (included by default)
and basic map data info (without tiles and resource location info):
screp -map=true sample.rep
Or simply:
screp -map sample.rep
There is also a handy -overview flag which displays an overview / summary about the rep in human readable format (no JSON):
screp -overview sample.rep
Installing the screp CLI app
The easiest is to download the binary release prepared for your platform from the Releases page. Extract the archive and start using screp.
If you want to build screp from source, then simply clone the project and build the cmd/screp app:
git clone https://github.com/icza/screp
cd screp/cmd/screp
go build
This will create an executable binary in the cmd/screp folder, ready to run.
Example projects using this
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
screp
A simple CLI app to parse and display information about a StarCraft: Brood War replay passed as a CLI argument.
|
A simple CLI app to parse and display information about a StarCraft: Brood War replay passed as a CLI argument. |
|
Package rep models StarCraft: Brood War replays.
|
Package rep models StarCraft: Brood War replays. |
|
repcmd
Package repcmd models player commands.
|
Package repcmd models player commands. |
|
repcore
Package repcore contains core types and utilities used for modeling StarCraft: Brood War replays.
|
Package repcore contains core types and utilities used for modeling StarCraft: Brood War replays. |
|
Package repparser implements StarCraft: Brood War replay parsing.
|
Package repparser implements StarCraft: Brood War replay parsing. |
|
repdecoder
Package repdecoder implements decoding StarCraft Brood War replay files (*.rep).
|
Package repdecoder implements decoding StarCraft Brood War replay files (*.rep). |