Defold TypeScript Boom Template

A dev environment for Defold that transpiles TypeScript into lua using TypeScriptToLua.

Includes britzl's boom, a game framework built on top of Defold.

This template extends tsd-template. Use that one if you prefer a minimal setup.

Features

• Full Lua and Defold API type definitions for TypeScript auto-complete and type checking
• Built-in types for boom
• Eslint config for handling the caveats of TypeScriptToLua and keeping your code correct
  • yarn lint or npm run lint to run the linter
  • yarn lintfix or npm run lintfix to allow the linter to auto-fix issues
• Handles script, gui_script, and module exports using familiar ES6 export syntax
• Full boilerplate game project ready to transpile and go
• File watcher via yarn dev or npm run dev to transpile on save
• Optionally run yarn buildO1 or npm run buildO1 to strip source maps, unfold and propagate constants
• Access a library of types for Defold extensions by running yarn resolve or npm run resolve

You will need to have Node.js installed.

Quick Start

• Use yarn dev or npm run dev to start a watcher that compiles and emits lua and script when you save
• Use yarn build or npm run build to just compile your ts, sans watcher

Installation

1. Fork this template or use degit to download the template locally

npx degit thinknathan/tsd-template-boom my-game
# or
git clone https://github.com/thinknathan/tsd-template-boom.git my-game

2. Initialize

cd my-game
npm install
# or yarn

3. Generate

npm run build # Transpile the TypeScript files to lua
# or yarn build
# or
npm run dev # Watch for changes and regenerate files on save
# or yarn dev

4. Open app/game.project in Defold

• Start making games with TypesScript!

TypeScript ❤️ Defold

License

MIT

Based on tsd-template (Copyright (c) Justin Walsh (@thejustinwalsh)).

Graphics in the assets folder are CC0 licensed, from Kenney.