You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-14
Original file line number
Diff line number
Diff line change
@@ -9,22 +9,21 @@
9
9
</a>
10
10
</p>
11
11
12
-
An sqlite database representing much of the data from dota2's game files, and an sqlalchemy representation to be used with it. This was built using my [dotabase-builder](https://github.com/mdiller/dotabase-builder) project. Note that I've removed the database from this repository as binary files are not git-friendly, and have replaced it with an sql file dump of the database.
12
+
A SQLite database representing much of the data from Dota 2 game files, and a SQLAlchemy representation to be used with it. This was built using my [dotabase-builder](https://github.com/mdiller/dotabase-builder) project. Note that I've removed the database from this repository, as binary files are not git-friendly, and have replaced it with a SQL file dump of the database.
13
13
14
14
## Description
15
-
The goal of this project is to provide an interface into dota's game files so that applications can be built around them. This repository will be kept up to date with dota so that changes to the game are available immediately.
16
-
One main feature of this project that I couldn't find anywhere else, is a representation of dota's Hero Response system. This is the system that controls the various vocal responses that heroes have to actions that are happening in the game.
17
-
In addition to supplying a sqlite database, this project includes a python sqlalchemy representation of the database, which provides an easy way to interface with python applications. (dotabase.py) It also happens to be a good file to look at if you want to get an idea of the structure of the database
18
-
NOTE: This project does not supply any player information or data from specific dota games. There are plenty of [already](http://dev.dota2.com/showthread.php?t=47115"Dota 2 Match History API")[existing](https://steamcommunity.com/dev"Steam Web API")[API](http://docs.opendota.com/"OpenDota/Yasp API")s for that.
15
+
The goal of this project is to provide an interface into Dota 2 game files so that applications can be built around them. This repository will be kept up to date with Dota so that changes to the game are immediately available.
16
+
One main feature of this project that I couldn't find anywhere else, is a representation of Dota's Hero Response system. This is the system that controls the various vocal responses that heroes have to actions that happen in the game.
17
+
In addition to supplying a SQLite database, this project includes a Python SQLAlchemy representation of the database, which provides an easy way to interface with Python applications. (dotabase.py) It also happens to be a good file to look at if you want to get an idea of the structure of the database
18
+
NOTE: This project does not supply any player information or data from specific Dota games. There are plenty of [already](http://dev.dota2.com/showthread.php?t=47115"Dota 2 Match History API")[existing](https://steamcommunity.com/dev"Steam Web API")[API](http://docs.opendota.com/"OpenDota/Yasp API")s for that.
19
19
20
20
## Usage
21
-
22
-
If you want to use the dotabase package in your python applications, you can install via pip like this:
21
+
If you want to use the dotabase package in your Python applications, you can install via pip like this:
23
22
```
24
23
pip install dotabase
25
24
```
26
25
27
-
Example Usage:
26
+
Example usage:
28
27
```python
29
28
from dotabase import*
30
29
@@ -35,19 +34,18 @@ for hero in session.query(Hero):
35
34
```
36
35
If you use MyPy, you should be able to get typing hints and your editor should recognize that the "hero" variable above is an instance of the "Hero" class.
37
36
38
-
Note that the package was built using python 3.9 and sqlalchemy 1.4
37
+
Note that the package was built using Python 3.9 and SQLAlchemy 1.4
39
38
40
39
## JSON files
41
-
42
-
In the `json` directory, I've auto-generated a bunch of json files that give you an idea of what is inside the database. These are also useful for seeing the difference between builds.
40
+
In the `json` directory, I've auto-generated a bunch of JSON files that give you an idea of what is inside the database. These are also useful for seeing the difference between builds.
43
41
44
42
## Builder
45
-
The database is built using my custom [dotabase-builder](https://github.com/mdiller/dotabase-builder"Dotabase Builder"). Check it out for more information of how this project is being constructed. Note that the database is constructed and then dumped to an sql creation script for saving to source control. You can reconstruct it with `sqlite3 dotabase.db ".read dotabase.db.sql"`
43
+
The database is built using my custom [dotabase-builder](https://github.com/mdiller/dotabase-builder"Dotabase Builder"). Check it out for more information on how this project is being constructed. Note that the database is constructed and then dumped to a SQL creation script for saving to source control. You can reconstruct it with `sqlite3 dotabase.db ".read dotabase.db.sql"`
46
44
47
45
## Extracted VPK Files
48
-
The files extracted from dota's vpk are all of the ones of the following types:
46
+
The files extracted from Dota's vpk are all the ones of the following types:
0 commit comments