Skip to content

Latest commit

 

History

History
86 lines (64 loc) · 3.75 KB

README.md

File metadata and controls

86 lines (64 loc) · 3.75 KB
Raw

GoWarcraft3

Build Status Build status GoDoc License: MPL 2.0

This library provides a set of go packages and command line utilities that implement Warcraft III protocols and file formats.

Tools

Name Description
bncsclient A mocked Warcraft III chat client that can be used to connect to BNCS servers.
w3gsclient A mocked Warcraft III game client that can be used to add dummy players to games.
bncsdump A tool that decodes and dumps BNCS packets via pcap (on the wire or from a file).
w3gsdump A tool that decodes and dumps W3GS packets via pcap (on the wire or from a file).
w3mdump A tool that decodes and dumps w3m/w3x files.

Download

Official binaries for tools are available. Simply download and run.

Note: additional dependencies may be required (see build).

Build

# Linux dependencies
apt-get install --no-install-recommends -y build-essential cmake git golang-go libgmp-dev libbz2-dev zlib1g-dev libpcap-dev

# OSX dependencies
brew install cmake git go gmp bzip2 zlib libpcap

# Windows dependencies (use MSYS2 -- https://www.msys2.org/)
# Install WinPcap in C:\WinPcap (https://www.winpcap.org/devel.htm)
pacman --needed --noconfirm -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-go mingw-w64-x86_64-cmake

# Download vendor submodules
git submodule update --init

# Run tests
make test

# Build release files in ./bin/
make release

Packages

Name Description
file Package file implements common utilities for handling Warcraft III file formats.
file/blp Package blp is a BLIzzard Picture image format decoder.
file/mpq Package mpq provides golang bindings to the StormLib library to read MPQ archives.
file/w3m Package w3m implements basic information extraction functions for w3m/w3x files.
network Package network implements common utilities for higher-level (emulated) Warcraft III network components.
network/bnet Package bnet implements a mocked BNCS client that can be used to interact with BNCS servers.
network/dummy Package dummy implements a mocked Warcraft 3 game client that can be used to add dummy players to lobbies.
network/lan Package lan implements a mocked Warcraft 3 LAN client that can be used to discover local games.
network/peer Package peer implements a mocked Warcraft 3 client that can be used to manage peer connections in lobbies.
protocol Package protocol implements common utilities for Warcraft III network protocols.
protocol/bncs Package bncs implements the Battle.net chat protocol for Warcraft III.
protocol/w3gs Package w3gs implements the game protocol for Warcraft III.

Download

go get github.com/nielsAD/gowarcraft3/${PACKAGE_NAME}

Import

import (
    "github.com/nielsAD/gowarcraft3/${PACKAGE_NAME}"
)

Note: additional dependencies may be required (see build).

Documentation

Documentation is available on godoc.org