Skip to content

ts-defold/tsd-template

Repository files navigation

Defold TypeScript Template (minimal)

Chat with us!

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

Features

  • Full Lua and Defold API type definitions for TypeScript auto-complete and type checking
  • Library of types for Defold extensions via npm run resolve
  • Eslint config for handling the caveats of TypeScriptToLua and keeping your code correct
  • Handles script, gui_script, and module exports using familiar ES6 export syntax
  • Full BoilerPlate game project ready to transpile and go
  • File watcher via npm run dev to transpile on save

Note that you will need to have Node.js installed.

Quick Start

  • Use npm run dev to start a watcher that compiles and emits lua and script when you save
  • Use 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 ts-defold/tsd-template my-game
# or
git clone https://github.com/ts-defold/tsd-template.git my-game
  1. Initialize
cd my-game
npm install
  1. Generate
npm run build # Transpile the TypeScript files to lua
# or
npm run dev # Watch for changes and regenerate files on save
  1. Code
code .
  1. Open app/game.project in Defold
  • Start making games with TypesScript!

TypeScript ❤️ Defold