Skip to content
GrandMA3 plugins

APIDump

Export LUA API data, used for the reference documentation generation.
Download Help Release Notes

Export data from the current grandMA3 version used for the documentation generation. Currently exports:

  • LUA Functions
  • LUA Enums
  • The data tree
  • Version and build information
Don’t forget to read the Reference Documentation generated from the data exported from this plugin

Usage

Section titled “Usage”
Plugin "APIDump"

Notes

Section titled “Notes”
  • Install in Simple_Show Demo showfile.
  • Rename Station Hostname to Laptop and Session to MySession (To avoid having device-specific data in the tree dump).
  • Run After a restart (to avoid having too much Undo history in the tree dump).

Installation

Section titled “Installation”
Download Latest

Requires grandMA3 version 2.0.2.0 or above.

Other versions of the plugin are available on the Releases page

Installation Steps

  1. Download plugin.

  2. Unzip the file in the gma3_library/datapools/plugins/ folder of your MA installation:

    • macOS: ~/MALightingTechnology/...
    • Windows: C:\ProgramData\MALightingTechnology\...
    • USB key: /grandMA3/...

    Once unzipped:

    • Directory.../gma3_library/datapools/plugins
      • DirectoryAPIDump_v1.1.0.0
        • APIDump.xml
        • APIDump.lua
      • ... Other plugin files

  3. In your showfile, import the plugin in a new Plugin pool object.

Release Notes

Section titled “Release Notes”

  • Release v1.1.0.0

      -  12/09/2025 Latest
    • Fixed Tree objects containing newlines in their name or path.

  • Release v1.0.0.0

      -  10/09/2025 Latest
    • Initial release with Functions, Enums and Tree exports to be used by generator scripts