Skip to content

Commit f196797

Browse files
authored
Update README.md
1 parent 7c71bf4 commit f196797

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# API
2+
This repository aims to document the different interfaces relevant to Dota 2 Modding. It uses these to render http://docs.moddota.com/ and provides a repository for TypeScript declarations to be used for Panorama UI or with [TypescriptToLua](https://github.com/Perryvw/TypescriptToLua) for game code.
23

3-
##File Structure
4-
### dota.d.ts
5-
Contains all the javascript API functions to do intellisense
6-
### dota_enums.d.ts
7-
Contains all the constants / enums that exist in the global panorama scope
8-
###dota_panels.d.ts
9-
Contains all the Panel types (Panel, Button, etc) and their associated properties
10-
###`gen/`
11-
This folder contains all the scripts to help automate this repository
4+
### File Structure
5+
**/_data** Contains raw dumps from the engine
6+
7+
**/declarations/panorama/** TypeScript declarations for Panorama.
8+
* **dota.d.ts** Declarations for interfacing with the game engine.
9+
* **dota_enums.d.ts** Declarations for enumerations used in Panorama.
10+
* **dota_panels.d.ts** Declarations for Panel interaction in Panorama.
11+
12+
**/declarations/server/** TypeScript declarations for the lua API (see [TypescriptToLua](https://github.com/Perryvw/TypescriptToLua)).
13+
* **dota-api.d.ts** Declarations for the Lua API.
14+
* **dota-enums.d.ts** Declarations of Lua enums.
15+
* **dota-gameevents.d.ts** Declarations of the different game events and their event contents.
16+
* **dota-modifier-properties.d.ts** Declarations for modifier properties on Lua modifiers.
17+
* **dota-std.d.ts** Lua std functions used for Dota modding.
18+
19+
**/examples/vscript/** Example TypeScript code.

0 commit comments

Comments
 (0)