Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ts-defold/tsd-template-yagames

Yandex Games Template
https://github.com/ts-defold/tsd-template-yagames

defold lua ts-defold-template typescript

Last synced: 27 days ago
JSON representation

Yandex Games Template

Awesome Lists containing this project

README

        

# Yandex Games TypeScript Template

Chat with us!

A dev environment for [Defold](https://defold.com/) pre-configured to use the Yandex Games SDK that transpiles TypeScript into lua using [TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua).

## Features

- Full Lua and Defold API type definitions for TypeScript auto-complete and type checking
- 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

## Bonus

- Throwback retro console frame with virtual dpad and buttons that work with touch input on mobile
- Online and ofline Leaderboards

_Note that you will need to have [Node.js](https://nodejs.org) 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. Use `npx @ts-defold/create my-gamejam-masterpiece --template yagames`

2. Generate

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

3. Code

```
code .
```

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

- Craft your next banger with the help of Typescript types!


TypeScript :heart: Defold