gortiz / clarity

Comically fast Java Dota 2 replay parser.

Clarity 2

Clarity is a parser for Dota 2 replay files written in Java.

Version 2 offers a new event based interface to replay data, which will make usage much easier and more versatile for you.

News

I made a formal 2.0 release from the latest snapshot. There have not been bug reports for quite some time, so I decided to mark the current state as 2.0. Work on version 2.1, with Source 2 support, has started.

Current status regarding Source 2:

• reading info: working
• processing gameevents: working
• stringtables: working
• combat log: working
• DT-classes: in progress
• entities: not at all
• temp entities: well, no
• modifiers: nope

Replay Data

clarity produces the following data you might be interested in from a replay. Choose from:

• combat log: a detailed log of events that happened in the game
• entities: in-game things like heroes, players, and creeps
• modifiers: auras and effects on in-game entities
• temporary entities: fire-and-forget things the game server tells the client about*
• user messages: many different things, including spectator clicks, global chat messages, overhead events (like last-hit gold, and much more), particle systems, etc.*
• game events: lower-level messages like Dota TV control (directed camera commands, for example), etc.*
• voice data: commentary in pro matches*
• sounds: sounds that occur in the game*
• overview: end-of-game summary, including players, game winner, match id, duration, and often picks/bans

* unprocessed: data is provided as original protobuf message object

Requirements

• Java 7 or newer
• Maven

Usage

Fetch the current stable version (2.0) from Maven Central with

<dependency>
	<groupId>com.skadistats</groupId>
	<artifactId>clarity</artifactId>
	<version>2.0</version>
</dependency>

Clarity 2.1 is work in progress and only available as a snapshot, so you got to add a pointer to the repository to your pom.xml (see the pom.xml of clarity-examples, which already does that)

To add the snapshot repository, add the following:

<repositories>
	<repository>
		<id>sonatype.oss.snapshots</id>
		<name>Sonatype OSS Snapshot Repository</name>
		<url>http://oss.sonatype.org/content/repositories/snapshots</url>
		<releases>
			<enabled>false</enabled>
		</releases>
		<snapshots>
			<enabled>true</enabled>
		</snapshots>
	</repository>
</repositories>

and then fetch the dependency with:

<dependency>
	<groupId>com.skadistats</groupId>
	<artifactId>clarity</artifactId>
	<version>2.1-SNAPSHOT</version>
</dependency>

Example Code

For example code, please see the the separate project clarity-examples.

License

See LICENSE in the project root.