Eluna TS

Eluna-TS is a system that uses TypeScriptToLua to compile Lua files compatible with the Eluna Engine

This project is composed by:

• ✔️ A pre-configured workspace compatible with VSCode to compile your sources
• ✔️ The deps/eluna-ts-definitions which adds Eluna definition files to Typescript allowing proper type-checking and intellisense feature
• ✔️ The deps/eluna-ts-lib which must be included in your project to add needed methods and make it work on Eluna. It also adds some useful reusable Typescript classes and functions.

DISCLAIMER ⚠️: not all Typescript features are supported by Eluna-TS, the limitations are listed inside the documentation of the TypeScriptToLua project.

Demo

Last Eluna commit compatibility check

Installation (Without Docker)

If you don't have docker or you already have Nodejs install, you can just follow this guide to setup your environment by using Nodejs directly.

1. Requirements

• Install nodejs 12+

NOTE: You can run the bash install-node.sh command to do it with an automatic script (it works on almost every OS with bash)

2. Install dependencies

• Run npm install to install the required node dependencies

Installation (With Docker)

1. Requirements

• Docker

2. Build and run the container

• Run docker-compose up --build eluna-ts-dev

Configure your environment

Unit tests

Unit tests coverage report