grandma3-ts-types/README.md

TypeScript definitions for grandMA3 Lua library.

# grandMA3 types for TypeScriptToLua

> This repo will soon merge back to https://github.com/LightYourWay/grandMA3-types and will be deprecated

:warning: **OPEN ALPHA** → as there is no official API reference from MAlighting avaliable type declarations may be faulty or incomplete.

TypeScript definitions for grandMA3 Lua API.
This is a fork of https://www.npmjs.com/package/grandma3-types, by [Lukas Runge](https://www.npmjs.com/~lukas-runge). Since he is not responsive, I detached this fork and started maintaining it myself.

## Versions

- Versions 2.x.x corresponds to MA3 version 1.9
- Versions 1.x.x correspond to MA3 version 1.8

## Install
```bash
npm install -D grandma3-ts-types
```

## integrate into `tsconfig.json`

```json
{
	"compilerOptions": {
		"types": ["grandma3-ts-types"]
	}
}
```

## Contributors

If you have something to contribute / add to the type declarations - **AWESOME** :tada: feel free to:
- [create a **GitHub Issue**](https://github.com/LightYourWay/grandMA3-types/issues/new/choose) for it.
- Or better yet, fork and create a PR with your changes.