This template enables TypeScript support for mods in Teardown. The TypeScript isn't ran natively, it's compiled into Lua by TSTL.
src/
- TypeScript source filesdist/dist/mod
- Compiled Lua file and mod files.assets/
- Generic assets such as vox files or sounds that are compiled into the mod.info.txt
- The normal Teardown info.txt file, copied into the compiled mod.teardown-ts-gen
- Submodule to thedecgen
branch of teardown-ts-gen. Adds the typed Teardown API to your TS environment.tsconfig.json
- TypeScript configuration file, you shouldn't have to tinker with this much.
- Go into
package.json
and customize the scripts to your liking (such as changing the folder name it copies to) - Run
npm run compile:windows
to build the mod, compile it all together, and then finally copy it to your Teardownmods
directory (windows only)
You can delete all of the example files in src/
and assets/
if you want, they're just there to show you how it works.