Skip to content

Commit 595be9c

Browse files
committed
Fix grammar & stylistic mistakes in README.md
1 parent c7572ce commit 595be9c

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,21 @@
99
</a>
1010
</p>
1111

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.
1313

1414
## 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.
1919

2020
## 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:
2322
```
2423
pip install dotabase
2524
```
2625

27-
Example Usage:
26+
Example usage:
2827
```python
2928
from dotabase import *
3029

@@ -35,19 +34,18 @@ for hero in session.query(Hero):
3534
```
3635
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.
3736

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
3938

4039
## 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.
4341

4442
## 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"`
4644

4745
## 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:
4947
- txt
5048
- png
5149
- mp3 (extracted from vsnd_c files)
5250

53-
More file types will be added later
51+
More file types will be added later.

0 commit comments

Comments
 (0)