A template for Dota 2 Custom Games built with modern technologies.
This tutorial explains how to set up and use the template.
The template includes:
- TypeScript for Panorama
- TypeScript for VScripts
- Simple commands to build and launch your custom game
- Continuous Integration support
- Clone this repository or, if you're planning to have a repository for your custom game on GitHub, create a new repository from this template and clone it instead.
- Open the directory of your custom game and change
namefield inpackage.jsonfile to the name of your addon name. - Open terminal in that directory and run
npm installto install dependencies. You also should runnpm updateonce in a while to get tool updates.
After that you can press Ctrl+Shift+B in VSCode or run npm run dev command in terminal to compile your code and watch for changes.
- [src/common]: TypeScript .d.ts type declaration files with types that can be shared between Panorama and VScripts
- [src/vscripts]: TypeScript code for Dota addon (Lua) vscripts. Compiles lua to game/scripts/vscripts.
- [src/panorama]: TypeScript code for panorama UI. Compiles js to content/panorama/scripts/custom_game
--
- [game/*]: Dota game directory containing files such as npc kv files and compiled lua scripts.
- [content/*]: Dota content directory containing panorama sources other than scripts (xml, css, compiled js)
--
- [scripts/*]: Repository installation scripts
This template includes a GitHub Actions workflow that builds your custom game on every commit and fails when there are type errors.