bkutil / screp

StarCraft - Brood War replay parser

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

screp

Build Status GoDoc Go Report Card

StarCraft: Brood War replay parser.

Initially this parser was developed as part of the repMastered project (the initial history can be found there), but was outsourced here as a separate project.

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 a 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):

s2prot -map=true sample.rep

Or simply:

s2prot -map 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 run the following command:

go get -u github.com/icza/screp/...

This will clone this repo if you don't have it yet, or update it if you already have it in your $GOPATH, and will build and place screp inside $GOPATH/bin.

Example projects using this

About

StarCraft - Brood War replay parser

License:Apache License 2.0


Languages

Language:Go 98.4%Language:Shell 1.6%