Skip to content

03. Commands, Permissions, Configs

Exenco edited this page Apr 20, 2024 · 2 revisions

Commands

Every command begins with /ls:

Command Permission Description
/ls lightshow.show Toggles if a player is seeing the show
/ls reload lightshow.reload Reloads the plugin
/ls play <sequence> lightshow.start Plays a recorded sequence
/ls stop lightshow.stop Stops the currently played sequence
/ls artnet start lightshow.artnet.start Starts the Art-Net server
/ls artnet stop lightshow.artnet.stop Stops the Art-Net server
/ls artnet check lightshow.artnet.check Checks if the plugin is receiving Art-Net packages
/ls artnet record <sequence> lightshow.artnet.record Records received Art-Net packets to sequence file. Execute again to stop and save recording.

Config.json

For simplicity, keys defining chat messages are not listed here.

Stage

Key Value-Description
Location The location of the stage (see below)
Radius The radius in which players receive light-show packets

The format for all location entries remains consistent. However, fixture definitions do not include the world parameter.

"Location": {
  "world": "world",
  "x": 0.5,
  "y": 70,
  "z": 0.5
}

ArtNet

Key Value-Description
Enabled Whether art-net commands should be accessible. While guarded by permissions it is recommended to turn off on public servers.
Address The ip-address and port to be used for Art-Net connectivity.
Timeout The amount of time to wait until a check counts as timed out.

FixtureFiles

This list is used to define which files containing definitions about fixtures to include. Here one specifies the universe and optionally an offset for the DmxIds.

Example:

{
  "Universe": 1,
  "Filename": Lasers,
  "Offset": 30
},
{
  "Universe": 2,
  "Filename": Led
}

This would mean the in file Lasers.json defined fixtures will be listened to on universe 1 and fixtures defined in Led.json will be listened to on universe 2. Additionally, all DmxIDs used in Lasers.json are positively offset by 30.