README.md

Manta

Manta is a fully functional Dota 2 replay parser written in Go, targeting the Source 2 (Dota 2 Reborn) game engine.

Getting Started

Manta is a low-level replay parser, meaning that it will provide you access to the raw data in the replay, but doesn't provide any opinion on how that data should be structured for your use case. You'll need to create callback functions, inspect the raw data, and decide how you're going to use it.

Usage

Get the code:

go get github.com/dotabuff/manta

Use it to parse a replay:

import (
  "log"
  "os"

  "github.com/dotabuff/manta"
  "github.com/dotabuff/manta/dota"
)

func main() {
  // Create a new parser instance from a file. Alternatively see NewParser([]byte)
  f, err := os.Open("my_replay.dem")
  if err != nil {
    log.Fatalf("unable to open file: %s", err)
  }
  defer f.Close()

  p, err := manta.NewStreamParser(f)
  if err != nil {
    log.Fatalf("unable to create parser: %s", err)
  }

  // Register a callback, this time for the OnCUserMessageSayText2 event.
  p.Callbacks.OnCUserMessageSayText2(func(m *dota.CUserMessageSayText2) error {
    log.Printf("%s said: %s\n", m.GetParam1(), m.GetParam2())
    return nil
  })

  // Start parsing the replay!
  p.Start()

  log.Printf("Parse Complete!\n")
}

Developing

To run make update you will need a few things installed:

# Install subversion. On OS X:
brew install subversion

# Install protoc. On OS X:
brew install protobuf

# Install gnu-sed. Not needed on Linux. On OS X:
brew install gnu-sed

# Install protoc-gen-go:
go install github.com/golang/protobuf/[email protected]

License

Manta is distributed under the MIT license.

Code of Conduct

Manta has adopted the Contributor Covenant Code of Conduct.

Getting Help

The best place to ask questions about Dota 2 replay parsing is the #dota2replay channel on QuakeNet, where we're happy to answer any questions you may have. Please only open Github issues for actual bugs in manta, not questions about usage.

Looking to parse Source 1 (original Dota 2) replays? Take a look at Yasha.

Authors and Acknowledgements

Manta is maintained and development is sponsored by Dotabuff, a leading Dota 2 community website with an emphasis on statistics. Manta wouldn't exist without the efforts of a number of people:

• Michael Fellinger built Dotabuff's Source 1 parser yasha.
• Robin Dietrich built the C++ parser Alice.
• Martin Schrodt built the Java parser clarity.
• Drew Schleck, built an original C++ parser edith.