Quick Start Guide

This section describes the steps required to use xLights/Nutcracker for the first time to create a sequence. The details of each step are covered in the respective sections covering that functionality..

Download and Install xLights

1. Download and Install the latest version of xLights, selcting the defaults.
2. The latest versions as well as more information on the install process is located on the Software Releases page.

Setup

1. The Setup page will instruct you how to setup the Show and Media directories as well as Lighting Network.
2. Show Directory
   1. The xLights/Nutcracker Show Directory is where all the required xLights/Nutcracker sequences, pictures, and user configuration files required to run the sequences are kept. When a sequence (.xml) is saved and a binary file (.fseq) rendered, both files are created in the show directory. This is the same location where xLights/Nutcracker configuration files can be found and the default location where the program will first prompt for, or look for files pertaining to several functions of xLights/Nutcracker.
3. Media Directory
   1. The xLights/Nutcracker Media Directory is where the required audio (.mp3) and video (.mp4) media files are kept. The media directory can be different to the show directory or can be the same directory. This is the default location where xLights/Nutcracker will first prompt for, or look for media files.
4. Lighting Network
   1. At this stage, the actual network does not matter as you can change the details later.
   2. You can click Add Null and define a block of say 10,000 channels to work with (ensure that this is larger than what you will have in all your models) or you can define them as E1.31.
   3. For E1.31, click on Add E1.31.
   4. Select Multicast, Starting Universe # = 1, #of Universes = 10, Last Channel = 512 and press okay. This will create 10 universes, each of 512 channels starting from Universe 1 to Universe 10. The start and end channels are automatically calculated and displayed in the last column.
   5. Click on Save Setup to save the network created.
   6. Click on the New Sequence Icon (or Select File, New Sequence) and follow the outline described in New Sequence.
   7. Click on the Sequencer tab and if you have not already done so, either create default timing marks say every 5 seconds or create a Timing Track via the Settings , Sequence Settings, Timings tab. Alternatively, just to get going quickly, you can set the default ‘New Timing’ timing mark off by un­ticking it. This will enable you to drop an effect anywhere. Note: You need to either select a Timing Track with some timing marks on it or deselect all the Timing Tracks, to be able to drop an effect on the sequencer grid.
   8. Define a model. Each model type is described in the Models section, however to get going, click on the Models icon and from the Models list window, click New and on the Model window that pops up, enter the following information:
      1. Model name – P10 Matrix (example)
      2. Display – Horiz Matrix
      3. Type of String – RGB Nodes
      4. Actual # of Strings – 50
      5. # of RGB Nodes per String – 50
      6. # of Strands per String – 1
      7. Start Channel – 1
      8. From Output – 1
      9. Starting Corner – Top Left
      10. Part of my Display – Tick
      11. Model Brightness Adjustment – 0
   9. Click OK to save the model
   10. Add a model to the sequencer.