// spxlLabelParams sample configuration file // INSTRUCTIONS // 1. Make a copy of the plugin DLL file with a unique name. // 2. Make a copy of this configuration file (or create a new file) with the same basename as plugin DLL, with extension ".txt" // 3. Ensure to specify a UNIQUE Plugin ID and name (displayed in Resolume) in the configuration file. // eg: // spxlLabelParams-v1.1-ffgl21-x64.dll // spxlLabelParams-v1.1-ffgl21-x64.txt (id:_prm, name:_LabelParams) // ParamsCustom01.dll // ParamsCustom01.txt (id:_p01, name:Params Custom 01) // SpecialLayout.dll // SpecialLayout.txt (id:_p02, name:Params Special) // 4. Define as many paramters as you need, with names, default values and/or ranges. // Lines beginnig with "//" are comments // Lines are split into fields separated by colon (":") characters // The first field is either a value to be configured (plugin ID, plugin name), or indicates what kind of parameter(s) to generate. // Spaces and tabs at the beginning and end of lines (and fields) are ignored. // eg " a : b : c " is the same as "a:b:c". // Blank lines (including lines with only spaces and tabs) and comment lines are ignored. // Lines where the first field is not recognised are ignored. // Config values with errors (eg an ID string with the wrong length) are ignored. // CONFIG VALUES // id:(4 characters, must be UNIQUE amongst all the plugins you are using) // name:(1-16 characters including spaces) // NUMPARAMS GENERATOR // "numparams" generates a group of float parameters, using the provided base name and a counter to label them. // numparams:count:[baseName]:[defaultValue]:[min:max] // SIMPLE PARAMETERS // Usual form is "{type}:{name}:{defaultValue}" where only type is required. Integer (i) fields require a range to be specified. // The name is auto-generated, if not supplied, based on the parameter type and a counter for each type (eg "Int 1", "Int 2", "Int 3"). // The default value is zero (or false, or empty string) if not supplied. // Otherwise, default values are specified using the range displayed in Resolume, eg 0 to 127 for RGB values. // Some parameters allow a range to be specified; this is not supported by Resolume v5 and v6. // f:[name]:[defaultValue]:[min:max] - Float (standared slider, range optional) // i:[name]:[defaultValue]:min:max - Integer value (range required) // b:[name]:[defaultValue 0 or 1] - Boolean (toggle) // event:[name] - Event button (boolean value, "piano mode" button) // red:[name]:[defaultValue 0-255] - Red slider // green:[name]:[defaultValue 0-255] - Green slider // blue:[name]:[defaultValue 0-255] - Blue slider // x:[name]:[defaultValue 0-1]:[min:max] - X position (range optional) // y:[name]:[defaultValue 0-1]:[min:max] - Y position (range optional) // text:[name]:[defaultText] - Text field // hue:[name]:[defaultValue 0-360] - Hue (rainbow) slider [Resolume v6+] // sat:[name]:[defaultValue 0-100] - Saturation slider [Resolume v6+] // bri:[name]:[defaultValue 0-100] - Brightness slider [Resolume v6+] // alpha:[name]:[defaultValue 0-100] - Alpha slider [Resolume v7+] // OPTION PARAMETERS // An "Option" parameter is specified by one "option" line and multiple "elem" lines. // The "value" field for an element can be used internally by an FFGL plugin, however it seems // for now that Resolume will only output the selected element index via OSC, in other words, // the value is of no direct use. The elment index will be used for the internal value if not specified. // option:[name]:[defaultOptionIndex 0-(n-1)] where n in thenumber of option elements // elem:[name]:[value] // RGB PARAMETERS - three parameters generated as a group ("name R", "name G", "name B" sliders) // rgb:[name]:[red 0-255]:[green 0-255]:[blue 0-255] // RGB RANGE PARAMETERS (range required). Three float range params ("name R", "name G", "name B" sliders) // rgbrange:[name]:[defaultVlaue]:min:max // COLOR PICKER PARAMETERS // Resolume v6 generates a fancy color picker widget (taking the name of the hue field) // in the place of a group of Hue, Saturation and Brightness parameters when they appear together in that order. // Similarly, Resolume v7 generates a fancy color picker widget (taking the name of the hue field) // in the place of a group of Hue, Saturation, Brightness and Alpha parameters when they appear together in that order. // The "pick" parameter generator creates the three or four required parameters in a group. // Color picker (hue, saturation, brightness, alpha parameters named "name" (hue), "name S", "name B", "name A") // pick:[name]:[defaultHue 0-360]:[defaultSat 0-100]:[defaultBri 0-100]:[defaultAlpha 0-100] // EXAMPLES: // ID must be UNIQUE for each loaded plugin and EXACTLY 4 characters long // Strongly recommended that you create a numbering system eg _p00, _p01, _p02 so you don't trip over yourself or other plugins! id:_prm // NAME is limited to 16 characters (including spaces) name:_LabelParams // Set of float parameters. // numparams:count:[baseName]:[defaultValue]:[min]:[max] numparams:5:Offset:0:-1.0:1.0 // Boolean parameter // b:[name]:[defaultValue 0/1] b b::1 b:MyBool b:MyBoolF:0 b:MyBoolT:1 // "Event" parameter // event:[name] event event:MyEvent // Red (color) parameter // red:[name]:[defaultValue 0-255] red red::255 red:MyRedZero red:MyRedHalf:127 red:MyRedFull:255 // Green (color) parameter // green:[name]:[defaultValue 0-255] green green::255 green:MyGreenZero green:MyGreenHalf:127 green:MyGreenFull:255 // Blue (color) parameter // blue:[name]:[defaultValue 0-255] blue blue::255 blue:MyBlueZero blue:MyBlueHalf:127 blue:MyBlueFull:255 // X-position parameter // x:[name]:[defaultValue]:[min:max] x x::1.0 x:::-10:0 x:MyXPosZero x:MyXposHalf:0.5 x:MyXposFull:1.0 x:X Range:0:-100:100 x:Bad X Rng::-100:-50 // Y-position parameter // y:[name]:[defaultValue]:[min:max] y y::1.0 y:::0:10 y:MyYPosZero y:MyYposHalf:0.5 y:MyYposFull:1.0 y:Y Range:0:-50:50 y:Bad Y Rng:5:10 // Float / standard parameter // f:[name]:[defaultValue]:[min:max] f f::1.0 f:::-1.0:1.0 f:MyFloatZero f:MyFloatHalf:0.5 f:MyFloatFull:1.0 // Float with name, default value, range (min, max) f:EvenRange:0.0:-10.0:10.0 f:UnevenRange:43.21:-12.34:56.78 f:BadRange:-65.43:-13.57:24.68 // "Option" parameter // option:[name]:[defaultOption 0-(n-1)] where n is number of option elements option option elem elem elem option:Choose:2 elem:ZERO elem:one elem: elem elem:BONUS:123.45 // Integer parameter (range required) // i:[name]:[defaultValue]:min:max i:::0:1920 i::640:0:1280 i:MyIntEven::-10:10 i:MyIntEvenNZ:3:-5:5 i:MyIntUneven:-2:-12:7 i:BadInt:100:1:20 // Text parameter // text:[name]:[defaultText] text text::Abracadabra text:MyTextEmpty text:MyTextHello:Hello World // Hue (color) parameter // hue:[name]:[defaultValue 0-360] hue hue::360 hue:MyHueZero hue:MyHueHalf:180.0 hue:MyHueFull:360.0 // Saturation (color) parameter // sat:[name]:[defaultValue 0-100] sat sat::100.0 sat:MySatZero sat:MySatHalf:50.0 sat:MySatFull:100.0 // Brightness (color) parameter // bri:[name]:[defaultValue 0-100] bri bri::100.0 bri:MyBriZero bri:MyBriHalf:50.0 bri:MyBriFull:100.0 // Alpha (color) parameter // alpha:[name]:[defaultValue 0-100] alpha alpha::100 alpha:AlphaZero alpha:AlphaHalf:50.0 alpha:AlphaFull:100.0 // Unnamed color picker (using simple parameters) hue sat bri alpha // Unnamed color picker with defaults // DEFAULTS DO NOT WORK IN RESOLUME v6, but do in v7 hue::123.45 sat::98.76 bri::87.65 alpha::76.54 // Named color picker (using simple parameters) hue:MyColor sat:MyColor S bri:MyColor B alpha:MyColor A // Named color picker with defaults // DEFAULTS DO NOT WORK IN RESOLUME v6, but do in v7 hue:MyColor2:56.78 sat:MyColor2 S:67.89 bri:MyColor2 B:78.90 alpha:MyColor2 A:89.01 // Color picker (HSB or HSBA) parameters // pick:[name]:[hue 0-360]:[sat 0-100]:[bri 0-100]:[alpha 0-100] pick pick::8:81.23:84.56 pick::9:98.76:97.53:91.35 pick:PickYellow:60:100:100 pick:PickMagenta:300.12:90.34:80.56:70.78 // RGB parameters // rgb:[name]:[red 0-255]:[green 0-255]:[blue 0-255] rgb rgb::255:255:0 rgb:MyRGBPink:255:123.45:155.66 // RGB Range parameters (range required) // rgbrange:[name]:[defaultVlaue]:min:max rgbrange:::-1:1 rgbrange::150:100:200 rgbrange:RGBr Even::-2.5:2.5 rgbrange:RGBr Uneven:0.0:-10.0:20.0 rgbrange:RGBr Bad d:-5:-1:1 rgbrange:RGBr Bad r ::3:0