https://github.com/icza/screp

StarCraft - Brood War replay parser
https://github.com/icza/screp

broodwar command-line-tool decoder parser replay replay-header starcraft

Last synced: 4 days ago
JSON representation

StarCraft - Brood War replay parser

• Host: GitHub
• URL: https://github.com/icza/screp
• Owner: icza
• License: apache-2.0
• Created: 2017-05-16T21:23:52.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-17T12:09:17.000Z (17 days ago)
• Last Synced: 2024-12-23T17:11:30.200Z (11 days ago)
• Topics: broodwar, command-line-tool, decoder, parser, replay, replay-header, starcraft
• Language: Go
• Homepage:
• Size: 196 KB
• Stars: 86
• Watchers: 8
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# screp

![Build Status](https://github.com/icza/screp/actions/workflows/go.yml/badge.svg)

[![Go Reference](https://pkg.go.dev/badge/github.com/icza/screp.svg)](https://pkg.go.dev/github.com/icza/screp)

[![Go Report Card](https://goreportcard.com/badge/github.com/icza/screp)](https://goreportcard.com/report/github.com/icza/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](https://github.com/icza/s2prot)_

## Using the `screp` CLI app

There is a command line application in the [cmd/screp](https://github.com/icza/screp/tree/master/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](https://github.com/icza/screp/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

- [RepMastered™](https://repmastered.icza.net)