grandMA3 Toolkit

A reusable library of functions and abstractions for grandMA3 plugin development. It is intended to be consumed as a peer dependency from your own plugin project.

Installation

npm install --save-dev grandma3-toolkit
Copy

The toolkit declares the grandMA3 toolchain as peer dependencies so your plugin project controls the versions:

npm install --save-dev \
  grandma3-types \
  lua-types \
  typescript-to-lua
Copy

Recommended starting point: clone the grandma3-ts-template-plugin template.

Usage

Import helpers from the package root:

import { is } from 'grandma3-toolkit';

const obj = SomeHandleReturningFunction();

if (is.Sequence(obj)) {
  // obj is now typed as Sequence
  Printf('Sequence: %s', obj.name);
}

if (is.DataPools(obj)) {
  // obj is now typed as DataPools
}
Copy

Available helpers

is — class guards

Type guards for grandMA3 object classes. Each guard narrows the input type based on the result of GetClass().

More helpers will be added over time.

Development

This package is itself a TypeScript project compiled with the standard grandMA3 toolchain.

npm install
npm run check
Copy

The package ships TypeScript sources directly ("main": "src/index.ts"); the consuming plugin project does the TypeScriptToLua compilation. There is no build step in this repository.

Contributing

Issues and pull requests are welcome at https://github.com/LightYourWay/grandMA3-toolkit/issues.

License

Copyright © 2026 Lukas Runge Veranstaltungstechnik

grandma3-toolkit is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 3 or (at your option) any later version, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

The full license texts are included in this repository:

• COPYING — GNU General Public License v3.0
• COPYING.LESSER — GNU Lesser General Public License v3.0

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.