home/ atoms/ rgb-script-api

QLC+ RGB Scripts are self-executing JavaScript objects implementing rgbMapStepCount and rgbMap functions

An RGB Script is a .js file in the QLC+ rgbscripts directory. It must be a self-executing anonymous function returning an object with apiVersion (1 or 2), name, author, and optionally acceptColors (0=none, 1=start only, 2=start+end). The two mandatory functions are rgbMapStepCount(width, height) returning the number of animation steps, and rgbMap(width, height, rgb, step) returning a height×width 2D array of 32-bit 0x00RRGGBB integers. API version 2 adds properties (list, range, float, string types) with named read/write functions, allowing the RGB Matrix editor to expose sliders and dropdowns.

Examples

The ‘Full Columns’ bundled script returns width steps; rgbMap sets map[y][step]=rgb for all y — lighting one column per step.

Assessment

Given a 10×6 matrix, how many steps must a ‘one row at a time’ script return from rgbMapStepCount? Write the rgbMap logic for step 2 (third row).

“The scripts must be self-executing, i.e. when they are evaluated, the script itself is put inside an anonymous function that executes itself and returns an object that contains the required API functions”
corpus · qlc-user-manual-open-source-dmx-lighting-control · chunk 11