azerothcore / eluna-ts Goto Github PK

View Code? Open in Web Editor NEW

20.0 5.0 3.0 1.33 MB

Eluna-TS converts TS files to Lua scripts compatible with the Eluna system

License: GNU Affero General Public License v3.0

JavaScript 21.35% Dockerfile 4.56% Shell 1.48% TypeScript 72.61%

lua typescripttolua typescript azerothcore azerothcore-module

eluna-ts's Introduction

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 16+

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

Work in progress...

Unit tests

Unit tests coverage report

eluna-ts's People

Contributors

Stargazers

Watchers

Forkers

unco999 shadowburn-entertainment linecode

eluna-ts's Issues

Bug: Location methods that return tuples do not work

Methods that return tuples are not translated correctly. This is most common in methods related to positions where there is an X,Y,Z return value

Bug: Register Server Events, Package Events do not accept an entry

This code should not expect an entry:

declare function RegisterServerEvent(
  this: void,
  entry: number,
  event: ServerEvents.SERVER_EVENT_ON_PACKET_RECEIVE,
  func: HookFunctionNoSelf<server_event_on_packet_receive_any>,
  shots?: number,
): (...args: any[]) => any;
declare function RegisterServerEvent(
  this: void,
  entry: number,
  event: ServerEvents.SERVER_EVENT_ON_PACKET_SEND,
  func: HookFunctionNoSelf<server_event_on_packet_send_any>,
  shots?: number,
): (...args: any[]) => any;

Env without Docker

Hi!

I'm really interested in this project but I haven't been able to run it properly, not much documentation on how to set up the environment when not using Docker.

Requesting a lil help,

Thanks!

Global functions get transpiled with a nil first argument

It seems that some functions that are available from the global scope are incorrectly transpiled to Lua.
For example:

const map = GetMapById(1);
print(map.GetName());

transpiles to

local map = GetMapById(nil, 1)
print(
    map:GetName()
)

notice the nil before the 1, which causes an error: bad argument #1 to 'GetMapById' (number expected, got nil)

Same behavior with

const query = CharDBQuery("...");

which transpiles to

local query = CharDBQuery(nil, "...")

and therefore gives the error bad argument #1 to 'CharDBQuery' (string expected, got nil)

I'm using the following versions:

@azerothcore/eluna-ts-lib: ^1.0.13
typescript: 4.2.4
typescript-to-lua: ^0.39.3
Node v14.16.0

Bug: SendMail function does not translate to lua correctly and causes and error

This should have @noself annotation on it.

azerothcore / eluna-ts Goto Github PK

eluna-ts's Introduction

Eluna TS

Demo

Installation (Without Docker)

1. Requirements

2. Install dependencies

Installation (With Docker)

1. Requirements

2. Build and run the container

Configure your environment

Unit tests

eluna-ts's People

Contributors

Stargazers

Watchers

Forkers

eluna-ts's Issues

Recommend Projects

Recommend Topics

Recommend Org