https://github.com/skadistats/clarity

Comically fast Dota 2, CSGO, CS2 and Deadlock replay parser written in Java.
https://github.com/skadistats/clarity

Last synced: 2 months ago
JSON representation

Comically fast Dota 2, CSGO, CS2 and Deadlock replay parser written in Java.

• Host: GitHub
• URL: https://github.com/skadistats/clarity
• Owner: skadistats
• License: bsd-3-clause
• Created: 2013-12-25T21:27:19.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-14T16:11:39.000Z (4 months ago)
• Last Synced: 2024-09-16T01:54:05.553Z (4 months ago)
• Language: Java
• Homepage:
• Size: 4.53 MB
• Stars: 642
• Watchers: 44
• Forks: 120
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-esports - Clarity - A Java library for parsing CS:GO and Dota 2 replays. (Libraries / Data parsing and analysis)
• awesome - skadistats/clarity - Comically fast Dota 2, CSGO, CS2 and Deadlock replay parser written in Java. (Java)

README

        
# Clarity

Clarity is an open-source parser for Dota 2, CSGO and CS2 replay files, written in Java.

## Changelog

see the [Changelog](/CHANGELOG.md) for recent project activity.

# 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 (17 and above)

* Gradle (for building)

# Usage

Depending on your project build, use one of the following

### Maven

```XML

	com.skadistats

	clarity

	3.0.6

```

### Gradle (Groovy)

```

    implementation group: 'com.skadistats', name: 'clarity', version: '3.0.6'

```

### Gradle (Kotlin)

```

    implementation("com.skadistats:clarity:3.0.6")

```

# Example Code

For example code, please see the separate project [clarity-examples](https://github.com/skadistats/clarity-examples).

# License

See [LICENSE](/LICENSE) in the project root.