https://github.com/azerothcore/eluna-ts
Eluna-TS converts TS files to Lua scripts compatible with the Eluna system
https://github.com/azerothcore/eluna-ts
azerothcore azerothcore-module lua typescript typescripttolua
Last synced: 9 months ago
JSON representation
Eluna-TS converts TS files to Lua scripts compatible with the Eluna system
- Host: GitHub
- URL: https://github.com/azerothcore/eluna-ts
- Owner: azerothcore
- License: agpl-3.0
- Created: 2021-05-05T18:20:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T21:16:57.000Z (over 1 year ago)
- Last Synced: 2025-04-30T01:38:30.413Z (9 months ago)
- Topics: azerothcore, azerothcore-module, lua, typescript, typescripttolua
- Language: TypeScript
- Homepage:
- Size: 1.3 MB
- Stars: 30
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eluna TS
Eluna-TS is a system that uses [TypeScriptToLua](https://typescripttolua.github.io/) to compile Lua files compatible with the [Eluna Engine](https://github.com/ElunaLuaEngine/Eluna/blob/master/README.md)
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
[](https://www.youtube.com/watch?v=FEmjdauPKH0)
[Last Eluna commit compatibility check](https://github.com/ElunaLuaEngine/Eluna/commit/2962d4fea3708cf22964d1cc750290b8980b313f)
## 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 16+](https://nodejs.org/en/)
**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](https://docs.docker.com/get-docker/)
### 2. Build and run the container
- Run `docker-compose up --build eluna-ts-dev`
## Configure your environment
Work in progress...
## Unit tests
[Unit tests coverage report](./coverage/lcov-report/index.html)