Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thinknathan/tsd-template-deno2

Boilerplate TypeScript template with @ts-defold and Deno 2.x for the game engine Defold.
https://github.com/thinknathan/tsd-template-deno2

defold defold-game deno game-development lua ts-defold-template typescript

Last synced: 25 days ago
JSON representation

Boilerplate TypeScript template with @ts-defold and Deno 2.x for the game engine Defold.

Awesome Lists containing this project

README

        

Template Deno2

# Defold TypeScript Template (minimal - Deno 2.x version)

Chat with us!
[![CI/CD](https://github.com/thinknathan/tsd-template-deno2/actions/workflows/build.yml/badge.svg)](https://github.com/thinknathan/tsd-template-deno2/actions/workflows/build.yml)
![GitHub License](https://img.shields.io/github/license/thinknathan/tsd-template-deno2)

A dev environment for [Defold](https://defold.com/) that transpiles TypeScript
into lua using
[TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua) and
[Deno](https://deno.com/).

## Features

- Full Lua and Defold API type definitions for TypeScript auto-complete and type
checking
- Library of types for Defold extensions via `deno run resolve`
- Handles script, gui_script, and module exports using familiar ES6 export
syntax
- Full BoilerPlate game project ready to transpile and go
- File watcher via `deno run dev` to transpile on save

_Note that you will need to have [Deno](https://deno.com/) installed._

## Quick Start

- Use `deno run dev` to start a watcher that compiles and emits lua and script
when you save
- Use `deno run build` to just compile your ts, sans watcher

## Installation

1. Fork this template or use [degit](https://www.npmjs.com/package/degit) to
download the template locally

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

2. Initialize

```bash
cd my-game
deno install
```

3. Generate

```bash
deno run build # Transpile the TypeScript files to lua
# or
deno run dev # Watch for changes and regenerate files on save
```

4. Code

```
code .
```

5. Open `app/game.project` in Defold

- Start making games with TypesScript!


TypeScript :heart: Defold