Interface

• • This page is under development **

File

The File menu enables you to create a new xLights/Nutcracker sequence, open an existing xLights/Nutcracker sequence, Save, Save As or Close a sequence that is currently open, select a show directory, backup xLights/Nutcracker sequences to another directory and quit the xLights/Nutcracker application. These actions can also be done using shortcut keys and via icons on the top bar of the canvas.

New Sequence

To create a new sequence, either use the New Sequence icon, select New Sequence from the File menu or press Ctrl N.

Musical Sequence

If creating a music sequence, click on Musical Sequence.

Select your media file.

Select the frames per second (fps) for your sequence. The most common one used is 20fps (50ms).

Skip on the next screen

If creating an xLights/Nutcracker sequence, at this stage you can select ‘Done’ and import timing marks later (either via the Timings menu or by Right Clicking on the Sequencer menu ). Alternatively, you can click on the Timings tab now – this will lead to the Timings menu. On the Timing menu, you can select one or more of a number of timing bar options, which will generate timing marks automatically (similar to those that can be done via Audacity).

If you click on the Edit Metadata tab, this will lead to the Sequence Settings dialog box.

At this stage a new empty sequence has been created. You can... ● Select Save to save the sequence in your show directory – you will be prompted for a sequence name. ● Click on the Sequencer tab and continue with ○ Adding models for this sequence to the sequencer view, ○ Creating/adding timing marks ○ Dropping effects on the sequencer grid ○ Playing the sequence

Animation Sequence

If creating an animation sequence, click on Animation Sequence. No media/audio file is required or requested for. The subsequent process is the same as in the Musical Sequence.

Open Sequence

To open an existing sequence, either use the Open Sequence icon, select Open Sequence from the File menu or press Ctrl O. You will be presented with the ‘Choose Sequence file to open’ window, with the directory defaulting to your show directory. You can select an xLights/Nutcracker (xml) sequence or an xLights/Nutcracker fseq file to open.

Save Sequence

To save an open sequence, either use the Save Sequence icon, select Save Sequence from the File menu or press Ctrl S. If the sequence has not been saved previously, you will be presented with the Save As dialogue window to enter the name for the sequence. If the Render on Save setting (under the Settings menu) is set (i.e. ticked) then all the effects on all the models will be rendered first before the sequence is saved in the fseq file. This is the default. Progress status messages are displayed on the last line of the window. When the sequence has completed saving, a message will be displayed on the last line indicating the name of the fseq file and how long the save process took.

Save As Sequence

To save an open sequence with a different name, either use the Save As Sequence icon or select Save As Sequence from the File menu. You will be presented with the Save As dialogue window to enter the name for the sequence. If the Render on Save setting (under the Settings menu) is set (i.e. ticked) then all the effects on all the models will be rendered first before the sequence is saved in the fseq file. This is the default.

Progress status messages are displayed on the last line of the window. When the sequence has completed saving, a message will be displayed on the last line indicating the name of the fseq file and how long the save process took.

Close Sequence

To close the currently open sequence, select Close Sequence from the File menu. If the sequence data has not been saved since the last change, you will be presented with warning.

If you click No, then you will be returned to the sequence. If you select and click Yes, then the sequence will be closed without any sequence changes being saved.

Select Show Folder

In order to change your show Directory, select Select Show Folder from the File menu, press F9 or click on the Change button against the Show Directory on the Setup tab.You will be prompted to navigate to and select a new directory folder to select.

Ensure that you have the correct xLights/Nutcracker xml files (xlights_keybindings.xml, xlights_networks.xml and xlights_rgbeffects.xml) in your new directory.