dota-model

Status

I'm making major changes to this library. The Valve VPK files are very hard to use so I'm restructuring them to follow good Java object-oriented design. I've started with items. See the Item parent class for examples of what the new API looks like.

As I rework the raw VPK files into a true Java API, I've renamed properties to something more meaningful, dropped unneeded properties, removed internal items such as zero cost recipes, renamed the items classes to match their common name, and added JavaDoc to all the new methods.

It's a slow, manual process. Items are almost done. Next I'm going to significantly rework item abilities. Then I will start with the other objects.

Overview

This library provides a simple Java API for the Dota 2 VPK file data. This includes:

• npc_heroes
• items
• npc_units
• npc_abilities

Usage

You can use this library in one of two ways: through the Library class or by getting the object you want directly.

The Library class allows you to find the object by using its key.For example to get the data for the hero Anti-Mage,

import us.sharknet.dota.model;

Library library = new Library();
Antimage antimage = (Antimage) library.getHero("npc_dota_hero_antimage");
System.out.println( antimage.getAttackRange() );

This is useful if you are using the Clarity replay parser and need to get the hero data from a key. Library will also return collections of objects (hero, item, ability or NPC unit). You can get all the keys or get all the objects.

Alternately, you can simply get the object you want directly. For example, to get the data for a Yasha:

import us.sharknet.dota.model;
import us.sharknet.dota.model.item.*;


Yasha yasha = Yasha.instance();
System.out.println( yasha.getBonusAgility() );

You will have to browse through the classes under model.item, model.hero, etc. to see what is available.

See the classes under us.sharknet.dota.model.example for more usage examples.

Design

These are challenging to model in Java because they do not follow a standard class hierarchy. Instead, each "object" can have different properties. For this reason I have modeled them as distinct classes. Every hero, item, unit, and ability is its own class. There is, however, a parent, abstract class for each that has a few common properties.

All the Dota objects are modeled as immutable, singletons. There is only one instance of every object. Every object is a JavaBean as well so you can use them with other libraries that recognize the JavaBean standard.

I did not include the special mode objects such as the Diretide creeps or the Greevil stuff. I only included the main game objects.