🎄

xLights Show Reference

First-time setup — create your admin account
🎄

xLights Show Reference

Sign in to continue

xLights Show Reference

Signed in as
Overview
Models
Controllers
Groups

Import xLights Config Files

Upload xlights_networks.xml (controllers) and xlights_rgbeffects.xml (models). Both live in your xLights show folder. Upload either one independently to refresh just that section — wiring notes are always preserved.

Quick Troubleshooting

  • Know the channel number? → Models tab, sort by Start Channel
  • Know the controller? → Controllers tab, see all port assignments and wiring
  • Looking for a prop group? → Groups tab
  • Need to add wire info? → Click any model row → Edit Wiring
Name Type Start Ch End Ch Nodes Controller Port / Protocol Wiring
No models match your search.

Wiring —

👥 User Management

Add New User

📡 LR Boards —

Document the long range receiver boards connected to this controller. Each board has up to 32 channels. Channels already assigned via wiring notes are highlighted.

? xLights Show Reference — User Guide

Getting Started

This app is your xLights show technical reference — a fast lookup tool for channel numbers, controller ports, wire assignments, and physical locations. Your data is private to your account; each user sees only their own imported show data and wiring notes.

Importing Your xLights Config

Click ↑ Import XML in the header. You'll need two files from your xLights show folder:

  • → xlights_networks.xml — controller definitions (IPs, protocols, channel counts)
  • → xlights_rgbeffects.xml — model layout (props, nodes, ports, groups)

You can upload either file independently to refresh just that section. Wiring notes are always preserved across re-imports.

Models Tab

Every prop/model in your show. Columns:

  • → Start / End Ch — absolute universe channel, or controller-relative channel if model uses relative addressing
  • → Nodes — pixel count for the model
  • → Controller / Port / Protocol — which output port and pixel protocol (ws2811, etc.)
  • → Wiring — green badge means wiring info recorded; grey means not yet documented

Click any row to expand sub-models, aliases, groups, and wiring detail. Click any column header to sort. Use the search box to filter by name, channel, controller, group, type, or wiring info. Use the controller filter buttons to narrow to a single controller.

Controllers Tab

One card per controller. Shows IP address (clickable link to the controller web UI), protocol, max channels, and a port-by-port list of every model assigned to it. Wiring summary is shown inline per port. Click any port row to open the wiring modal for that model.

Groups Tab

All xLights model groups imported from your rgbeffects file. Each card shows group name, member count, aliases, and the list of models in that group.

Wiring Documentation

Click any model row → Add / Edit Wiring Info, or click the wiring badge, or click a port row in the Controllers tab. Fields:

  • → Wire Color — wire color and gauge (e.g. Red 18AWG)
  • → Connector Type — connector style at the prop end (e.g. 3-pin JST, waterproof)
  • → Physical Location — where in the yard/house this prop lives
  • → Wire Route / Run — how the cable runs from controller to prop
  • → Power Injection — PSU details and injection points
  • → Long Range Receiver — unit number and port number if signal travels through an LR receiver board
  • → Repeater — unit number and port number if signal passes through a repeater board
  • → Notes — troubleshooting tips, known issues, anything else
User Management (Admin only)

Admins see a 👥 Users button in the header. From there you can add new users (assign User or Admin role), remove users, and manage accounts. Each user has their own independent show data — importing XML or saving wiring notes never affects another user's data.

Quick Troubleshooting Tips
  • → Know the channel number? → Models tab, sort by Start Channel
  • → Prop not lighting up? → Controllers tab → find the port → check wiring notes
  • → Wrong colors? → Check Protocol column — confirm ws2811 vs ws2812 etc.
  • → Signal dying mid-run? → Check Long Range Receiver and Repeater fields in wiring notes
  • → Need to find a group of props? → Groups tab, or search the model name in Models tab
  • → Re-imported XML and lost data? → You won't — wiring notes are always preserved on import