screp
moduleThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
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 thescrep
CLI app
There is a command line application in thecmd/screp folderwhich 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 calledsample.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 thescrep
CLI app
The easiest is to download the binary release prepared for your platform from theReleases page. Extract the archive and start usingscrep
.
If you want to buildscrep
from source, then simply clone the project and build thecmd/screp
app:
git clone https://github.com/icza/screpcd screp/cmd/screpgo build
This will create an executable binary in thecmd/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). |