Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The File menu enables you to create a new xLights sequence, open an existing xLights sequence, Save, Save As or Close a sequence that is currently open, select a show directory, backup xLights sequences to another directory and quit the xLights application. These actions can also be done using shortcut keys and via icons on the top bar of the canvas.
Create a new sequence, either a musical or animation. See New Sequence Page for more information
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. Select the required xLights (XSQ or XML) sequence file to open. You can also select the FSEQ file and it will open the XSQ or XML file referenced within.
To open a recently used sequence, select any item from this list.
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. checked) 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 with a progress bar indicating the render progress.
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.
If you click on the green progress bar, a window opens and you can see the render progress of each model / model group.
One line is displayed for each model or Model group that is being rendered.
You can stretch and expand the window to see all the models.
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. checked) 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.
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.
Click on Save Changes if you want to save your changes. If you click Cancel then you will be returned to the sequence. If you select and click Discard Changes, then the sequence will be closed without any sequence changes being saved.
The Preferences Dialog allows the user to set all the global settings in xLights. These settings are stored in the system register and are persistent between show folders.
The Sequence Settings Dialog allows the user to edit all the settings for the currently open sequence. See Sequence Settings page for more information.
The Key bindings Dialog allows the user to manually edit the keyboards shortcuts in xLights.
The Export House Preview Video feature will "Play" the loaded sequence and create a video file of the House Preview Window. The video resolution of the resulting file is based on House Preview size. It is recommended you make the House Preview Window as large as possible before selecting this option.
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 XML files (xlights_keybindings.xml, xlights_networks.xml and xlights_rgbeffects.xml) in your new directory.
This option will display a list of previously selected show directories. If you select any of the items listed, your show directory will be changed to the selected directory.
The Backup Menu item allows you to manually trigger a backup of the show folder.
You will be presented will a message indicating where a backup will be created. Click Yes to proceed. Every time this step is executed, a copy will be created of all the ‘*xml’ files from your show directory into the Backup subdirectory of your show directory. A new subfolder is created each time a backup is executed.
By default xlights backs up the key files at the start of a session when xLights is launched.
Pressing F10 anytime, anywhere will backup your XML files for you and store them in a new folder with the date/time embedded in the name the backup was created. You can press F10 as many times as you like and should do this at least once per sequencing session. Keep in mind that you must have saved at least once in order for an updated XML file to be protected.
The Restore Backup dialog enables the user to select the backup folder recover files stored in the backup folder. The right list display basic data about the files found in the selected backup folder.
The left list displays the available backup folders, the middle list displays the files to restore. The right list display basic data about the files found in the selected backup folder.
The Alternate Backup function enables you to specify and use a different location to back your files up, other than the default location that the F10 backup functionality provides for.
Press F11 or select this function from the File menu. The first time you use this function, you will be prompted for the location that you wish to back the files to. Navigate to the required location and select the folder. The prompts after that are similar to the Backup functions.
Subsequently, Pressing F11 will save the files to the specified location. You can change this location via the Settings, Alt Backup Location menu.
The F11 function does not do an auto (in memory) backup of the current sequence if you have one open. It will backup the open sequence XML contents from when it was last saved.
To quit xLights, select Quit from the File menu or press ALT+F4.
If you have a sequence open and the sequence data has not been saved since the last change, you will be presented with the Save Sequence Dialog.
This function enables you to change the size (i.e. width of each band) of the sequencer grid.
Five options are available: Extra Small, Small, Medium, Large, Extra Large.
When an effect such as the Morph effect is placed between timing marks (as an example over several seconds long), a representation of the color changes over time for that effect.
If unchecked, then the effect on the sequencer grid will only show the generic effect icon and not the colors. Not all effects have this difference.
This function provides the ability to turn off the effect displaying colors at the node level.
Turning it off improves rendering performance and is recommended where effects are only being dropped at the model level. The value can be turned back on as required.
If checked, When moving or resizing an effect this will snap the effect beginning and/or endpoint to the closest timing make if you drag it close enough (approx 10 pixels on your monitor).
When "Play Timing" is selected, if you Double Click a timing mark, xLights will play the sequence for that timing mark interval. If "Edit Text" is selected, the Edit Label Dialog will appear. This Dialog allows you to input lyrics for singing faces or states for the state effect. The opposite option's functionality will works if you hold down shirt key then double click.
When Enabled, the audio waveform will appear smaller on the screen. This is designed for screens with lower resolutions.
If checked, color bars are display to represent transitions, like fade in or fade out.
Backup Preferences contains all the backup and restore settings.
View Preferences contains settings related to the scaling and size of items on the screen.
Effects Grid Preferences contains settings for the Sequencer Effects Grid.
Sequences Preferences contains settings for rendering and saving sequences.
Output Preferences are related to sending data to physical hardware.
The Random Effects tab allows the user to set which effects are used by the Generate Random Effects Right click menu option in the sequencer.
The Color Tab allows the user to change the colors options of xLights.
Output Preferences contains settings that did not fall under the other categories.
To create a new sequence, either use the New Sequence icon, select New Sequence from the File menu or press Ctrl N. The following screen is displayed:
If you do change your mind about creating a sequence, click on the Don’t Create Sequence button.
If creating a music sequence, click on Musical Sequence. A ‘Choose Audio File’ window will open, defaulting to your media directory.
You can select ‘FPP Audio files’ or ‘xLights Audio files’ to filter which file types can then be selected.
FPP Audio files: *.mp3;*.ogg;*.m4p;*.mp4
xLights Audio files: *.mp3;*.ogg;*.m4p;*.mp4;*.avi; *.wma;*.au;*.wav;*.m4a;*.mid;*. mkv;*.mov;*.mpg; *.asf; *.flv;*.mpeg.
If in doubt, select FPP Audio files.
The most common supported files on the FFP are .mp3 and .ogg. There is limited support for .mp4 and .m4p files for audio. Constant Bit Rate (CBR) audio works well. Variable Bit Rate(VBR) is quite uncommon.
Select the frames per second (fps) for your sequence.
The most common one used is 20fps (50ms).
On the Timing tab 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 intending to create an xLights sequence, on the next screen, select the View that you wish to use on the sequencer screen (use the Drop down if the View displayed is not what you require) and then press Quick Start.
The next screen displayed will be the sequencer grid and all the models from the selected View, will be displayed.
If you selected More options from the previous screen, then you are presented with this screen.
If creating an xLights 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.
Press either Skip or click on Done. If you pressed Skip then the following screen is displayed:
If you click on the Edit Metadata tab, this will lead to the Sequence Settings dialog box. You can Import a Timing Track or click on any of the tabs for the corresponding functionality.
Click on Done when complete.
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
Ensure that you save the sequence prior to exiting to save the work that has been done so far. By default though, the layout and sequencer changes are saved every 3 mins to a backup file i.e. ‘xxx.xbkp’ file in your show directory (where xxx is the name of the sequence).
If creating an animation sequence, click on Animation Sequence. No media/audio file is required or requested for.
This option enables you to create a timing track with marks at fixed intervals of your choice e.g every 1 second or every 5 secs. This is especially useful for animation sequences so that you don’t then have to go through and create timing marks manually.
Click on Timing and then from the drop down window , select the Metronome option.
In the popup window select the timing interval between each mark in milli secs ie 1000 for every 1 sec, 5000 for 5 every secs etc.
It must be a multiple of the base timing selected (ie 50 millisecs if 20fps was selected on the previous screen).
Click on Done when complete. xLights will create a Timing track with timing marks at the specified intervals.
The subsequent process is the same as in the Musical Sequence. By default, xLights will create an animated sequence that is 30 seconds in length. To change this , click on File, Sequence Settings and you can change the Sequence Duration.
To use ArtNET or E1.31 frame synchronization then you need to enable it using this option. When enabled xLights will emit at the end of the frame a sync packet which supported controllers will use to trigger light output. This can make your show look a lot sharper but very few controllers support these packets.
For ArtNET you just need to select this option.
For E1.31 you also need to set a universe number on the controller tab … this universe number needs to be a universe you are not otherwise using.
By default xLights automatically selects which network interface to send out network data on and sometimes it selects the wrong one. To force xLights to send to a particular adapter select this option and select the IP Address of the adapter you want to use. Select the top blank line to disable forced IP mode and return to the default option of auto.
This selection allows xLights to "skip" frames that contain the same data as the previous frame. This can help with lagging, as it will reduce network traffic. xSchedule will also use this setting when outputting data.
When using the Jukebox Panel with xFade or xSchedule, this determines which instance of xLight to select the effect from.
This settings allows the user to provide a contact email for when xLights submits a crash report. This is completely optional.
This setting allows xLights to use the computer's GPU to render video files. If you are having issues with video files's not displaying, it is recommended to disable this setting.
This setting allows xLights to compile shader effects on a background. This can help improve render times of shaders.
If selected, when a sequence is packaged with the Package Sequence option, all effects presets are stripped from the xlights_rgbeffects.xml file.
If selected, when a sequence is packaged the audio file is skipped as it is generally not legal to share audio files with other people. When the recipient opens the sequence they will need to point to where the audio file is on their computer.
If excluding the audio from a packaged sequence, it is necessary to provide the source of the audio file to those the package sequence is being sent to. This is best done by filling on the metadata on the sequence settings for the song, artist, album, and music URL (link for download).
Set the Video Codec and bitrate used by the Export House Preview Menu Dropdown. H.264 is recommended new Macs (M1, M1 Max, M2) with hardware video rendering. MPEG-4 is an older/slower standard that will create large video files.
This option will cause xLights to save both the Controller Settings and Layout Settings when either save button is clicked.
When Uploading Controller Inputs and Outputs, this will cause xLights to do both upload actions when Upload Output is clicked.
If enabled this will prompt the user of error during batch render. These errors could be related to missing models and missing effect files. If disables these errors will be ignored and render will be skipped for the models involved.
Force xLights to download the newest Vender Models on startup. It is recommended to enable this option on fast internet connections.
Set the 'Level' of tips of the day, you will receive. Off will disable Tip of the day.
This function enables you to change the size of the tool icons that are used to represent the effects on the effects ribbon.
Four options are available:
The OpenGL setting is used to define what version of the OpenGL API is being used for certain components of xLight rendering of 2D and 3D graphics.
This option does not have to be used unless you see issues with the waveform or icons not being displayed or the sequencer is jerky. In which case, starting with 3.x and working downwards , select an option and restart xLights and check the results. Advise the xLights team, as it could be that your video card drivers on your computer need updating.
In 3D mode, Model and Objects sometimes do not look correct in the house preview on all videocards. The Render Order 1-6 options use different render methods to generate the model layout. If you are having unwanted visual artifacts, try a different options and see if the models look better on your specific computer.
This option will adjust the size of the model handles in the Layout Tab.
There are three sizes available:
"Always On" will display the window in all cases, "Always Off" won’t display the window and "Auto Toggle" will display the window if the effect supports it, else won't display the window if the effect does not have this capability. Click on an effect in the sequencer grid and expand the Effect Assist window. If "Always on" is selected and the effect is not supported by this window, then you will see a red X in the window.
This Options will display Play, Pause, Stop, Scrub Bar to the House Preview to allow control of the sequence playback. They will only appear if the house preview window is larger than 400 wide by 300 high.
Automatically Show the House Preview Window when the sequence is playing and hide the House Preview when the sequence is stopped.
The default setting is to render all the effects of all the models and groups when saving the XML. If this setting is unchecked (i.e. to turn off), then it will only save the sequence XML file when you click Save/Save As, resulting in a very fast save operation. If unchecked, then Render All must be used to populate the render buffer. You must Render All and then File Save to create a up to date FSEQ file.
When Enabled model like matrixes and trees can be set to render at a smaller resolution to help lower render times during sequencing.
When enabled, the Model Blending option in the sequence settings dialog will be enabled when creating a new sequence.
Select a View to default as the Master View when creating a new sequence.
Render Cache allows xLights to render an effect or group of effects once and then save the individual frames in memory (and on disk) so it doesn't need to render the frames again. This can speed up render times, as xLights does not need to re-render unchanged effects.
This defines where the render cache files are saved on disk. If "Use Show Folder" is 'checked' xLights will use the current show folder. If 'unchecked' and a folder path is specified all the Render Cache data will be saved to that location. If this folder doesn't exist (move computers or remove a harddrive) the Render Cache directory will default back to the show directory.
There is a purge render cache option under Tools->Purge Render Cache.
The Auto Save functionality creates a copy of your working sequence xml, in your show directory. By default, the open sequence will be saved every 3 minutes and will create or override a file ‘XXX.xbkp’ where ‘XXX’ is the name of your sequence. You can use this menu to change the timeframe this occurs at or to disable it. The ‘*xml.xbkp’ files will also be included when you press F10 to back up your xml files from the show directory. It won’t be included if F11 is used to back files up to an alternate location.
In order to recover your sequence file from an unexpected error or corruption to the point when the last autosave executed: e nsure that xlights is not active. Then rename your existing sequence file (’xxx.xml’) to another name and rename the ‘xxx.xbkp. file to ‘xxx.xml’. Restart xLights, open the sequence and Click on Render All.
This defines where xLights will search for audio/picture/video files, This should only be set if the audio/picture/video files are not stored in the current show folder or a sub-directory of the current show folder. On Mac OS, adding folders in this section will give xLights the correct permissions to search them.
This will save the current rendered data to the FSEQ file on save. If this setting is disabled, the user will have to preform a Render All after opening a sequence. It is recommended that thus setting always remain checked (enabled).
Version 1 is the "original" FSEQ file format. V1 files contain all the channel data and can be very large file. xLights, FPP, and most controllers support V1. Version 2 of the FSEQ file format added compression and "skips" off channels to reduce file sizes. FPP 2.5 and lower do not support the V2 file format. ZSTD, ZLIB, Uncompressed are additional options to select which compression format to use. ZSTD is the default and is the preferred setting. These options can be changed in xLights to generate FSEQ files in the different file format for devices that require them. xLights 2019.64 and FPP 2.6+ support all the available file formats.
This defines where xLights will save FSEQ files. The FSEQ files are the raw sequence data for each sequence. If "Use Show Folder" is 'checked' xLights will use the current show folder. If 'unchecked' xLights will use the set folder path. If this folder doesn't exist (move computers or remove a harddrive) the FSEQ directory will default back to the show directory.
With this setting activated, xLights will perform an backup (similar to a user pressing F10 to manually backup) each time the sequence is saved - when the user clicks on Save or Save As.
The existing files, including the saved sequence XSQ, will be backed up to the Backup folder in your show directory prior to the render executing and FSEQ file being created.
With this setting activated, xLights will perform an backup (similar to a user pressing F10 to manually backup) each time xLights is launched. The existing files will be backed up to the Backup folder in your show directory, prior to the application launching and updating any xLights files when it is launched. The Backup sub directory created will have a suffix of ‘_OnStart’ added to the folder name.
When selected, backups are made of all relevant files both in the show directory as well as any sub-directories (excluding the backup folder itself).
This drop-down sets how long xLights will keep backup. With "Never" selected xLights will not delete any backups. 365, 90, 31, and 7 days will delete backup folder older than the selected length. This helps to clear out older files and free up space.
This defines the location where the backup folder(Backup on Save/Launch or F10) will be saved. If the 'Use Show Folder' Checkbox is selected (the default) the backup files will be saved in the current show folder. If this is unchecked and a folder path is specified all the backup files will be saved to that location. If this folder doesn't exist (move computers or remove a harddrive) the backup directory will default back to the show directory.
This is the location where the Alternative backups will be saved. This is manually triggered with F11 or the File Menu option. This Backup function is intended as a secondary backup location, like a external hardrive or NAS device. By default the location is not set and will prompt you if you attempt to do a Alternative Backup and no folder is set. To enable, set the desired folder or drive location.
The Color Tab allows the user to change the colors options of xLights. The First two Columns Relate to the colors in the Sequence Tab, while the third column changes Layout Colors.
These Colors are used for the Timing Tracks Header's background color in the Sequence Tab.
Changed the Timing Mark's Color.
Effects Changes the Color of the "Bounding Boxes" of the Effects
Selected Effect Color (When Mouse Click and Dragging to select multiple effects.)
Effect Referenced Color.(The Effect the Effect Settings Dialog is Currently Referencing)
Row Heading Background Color
Row Heading Text Color
Currently Selected Row Heading Color
Mouse Click and Drag Box Color
The color of the Gridlines between the rows and columns.(Red in the Picture Below)
Timing Track Label Background Color
Timing Track Label Outline Color
Singing Faces Phrases Background Color
Singing Faces Words Background Color
Singing Faces Phonemes Background Color
Timing Tracks that cannot be edited.
Selected Locked Effect (Click and Drag Select)
Locked Effect Referenced Color (The Effect the Effect Settings Dialog is Currently Referencing)
Audio Waveform Color
Audio Waveform Background Color
Audio Waveform Selected Color
Audio Waveform Selected Effect Interval Marker Color
Model Color
Model Selected Color
Color of other models with overlapping channels of the selected model. Overlap checks enabled must me active for this to appear.
Mouse Click and Drag Box Color
Import Color Settings from a .xtheme file saved on the computer.
Export Color Settings as a .xtheme file to use/import on other computers.
Reset Colors to the xLights Default colors
Cancel Color Changes and Close Preference Dialog
Save Color Changes and Close Preference Dialog
The test tab enables you to test anything from a single channel; all channels for a model, group, or universe; or all channels by sending test patterns to the physical lights.
The controllers and lights must be connected to the computer running xLights in order for the test feature to work. The connection may be wireless or wired, but a means of communication is required.
Testing from xLights, especially when using multicast may flood your network with data, and result in slower network connections. This is especially noticeable when using the Zoom Room for live assistance.
Ensure that output is enabled by selecting the "Output To Lights" button (it should be selected by default).
When you first access the Test Dialog, you will be presented with three tabs. The first tab is a view of all the channels configured against each ‘Controllers’, with output (Universe/Channel range) defined in the Controller Definition shown under the controller name. You can click against the Controller or Output to select or deselect all channels beneath.
Once you have selected a set of channels, you can save this individual set up as a test configuration for future repeat testing by clicking on the Save button and specifying a name for that group of channels. You can load a previously saved test configuration by clicking on the Load button.
If you click on the second tab labeled 'Model Groups', the view with display all the Model Groups. You can then select one or more Model group to test.
You can also click against a Model Group which will then display all the models under the group. This is quite useful to test a model or group of models at a time.
The third Tab, will display a list of all 'Models'. You can test individual models or expand the model, by clicking the down arrow, and test the individual nodes.
Different test functions are available for RGB, non RGB lights. You can also select the options to execute different test cycles. You can also select and change background as well as highlight colors and control the speed of the function using the controls provided.
The 'Standard' Tab will test the individual channels. This is intended for AC lights. The 'Highlight Intensity' is the "High" channel value, while the 'Background Intensity' is the "Low" intensity. At value off 255 is 100% ON while 0 is OFF. By default, the Highlight Intensity is 255 and the Background Intensity is 0. 'Case' will set one channel at a time to the 'Highlight Intensity' and proceed thought all the enabled channels. 'Alternate' will set every-other channel to the 'Highlight' and 'Background' Intensity. 'Background Only' with set all the channels to the 'Background Intensity'.
The 'RGB' Tab will test the individual Pixel or Dumb RGB strands. Similarly to above, the 'Highlight Intensity' is the "High" channel value, while the 'Background Intensity' is the "Low" intensity. At value off 255 is 100% ON while 0 is OFF. By default, the Highlight Intensity is 255 and the Background Intensity is 0. The three sliders will set the Output Color. For Model with RGB color order, the first sliders would be Red, 2nd is Green and the third is Blue. For all color orders the the first sliders controls the first color, the second sliders the second color, and third sliders the third color. 'Case' will set one Pixel or group of three channels, at a time to the 'Highlight Intensity' and proceed thought all the enabled channels. 'Alternate' will set every-other Pixel or group of three channels to the 'Highlight' and 'Background' Intensity. 'Background Only' with set all the Pixel to the 'Background Intensity'.
The 'RGB Cycle' Tab will test the individual colors in a Smart(Pixel) or Dumb RGB strands. The 'A-B-C' option will turn on each individual colors of the selected output. For Model with RGB color order, this would be Red, then Green and then Blue. For all color orders 'A' the first color, 'B's the second color, and 'C' is the third color. The 'A-B-C-All' will cycle the color and add an all colors on state. 'A-B-C-All-None' additionally adds an all colors off state. 'R-G-B-W' with cycle four channel RGBW lights.
Output from the test tab is, in most cases, always in RGB sequence. It actually turns on every 3rd channel, i.e. 1,4,7,10 etc for red and 2,5,6,11, etc for green, etc and then all channels for white. A quick way to test your lights to ensure the correct RGB, BRG, GRB etc. is set properly, is to turn on channel 1. That should turn on RED. Next would be to turn on channel 2, that should be Green and finally Channel 3 should turn on Blue. Go to the first light of the string . Select the first 3 channels in the setup i.e 97,98, 99. Check that Model is defined as RGB. Use background color and move the first (Red) bar only up. Green turned on for first light. Move first bar down and move the second (Green) bar only up. Blue turned on for first light. Move second bar down and move the third (Blue) bar only up. Red turned on for first light. So the controller should be set to GBR.
If you wish that the ‘RGB definition’ of your model be used instead, then select the R-G-B-W option instead.
This will use the model definition and turn on the color that corresponds to the channel as defined in the model. So if the model definition is GBR, then the colors turned on will be Green, Blue, and Red respectively.
Select the Sequence Settings option from the File menu. This screen can also be accessed by clicking on the button of the toolbar. The Sequence Settings screen has four tabs.
The Info/Media tab displays information about the sequence including the xLights release that was used to create the sequence, the number of models saved, the Sequence Type (i.e. Media or Animated), if media has been specified then the name and location of the media file. The sequence duration, the sequence timing and whether the media tags should be overwritten.
The sequence type, media file name or location, the sequence duration and whether media tags can be overwritten can be changed from this tab after the sequence has been created.
Sequence Duration determines the playback length of the sequence in seconds. For Media sequence types this is fixed to the media/audio file length used and cannot be changed. Animated Sequence duration defaults to 30 seconds and can be changed to the new length from this dialog.
Sequence Timing dictates the playback speed of the sequence. A Sequence Timing of 50 milliseconds would have a playback speed of 20 frames per second. Click the Question Mark to change the Sequence Timing.
Allow Blending Between Models determines if effects from the model groups blend with model level effects. If enabled the model groups effect data will be merged with the model effect data. If disabled models lower in the render order with override effect data of models higher in the render order.
Changes to the length of sequence duration, Sequence Timing, and Allow Blending Between Models require a "Render All" for the change to take effect in the current open sequence.
The Metadata tab enables the media metadata to be entered or updated. The attributes supported are the author, email, website, song, artist, album, music url and a comment.
This information does not drive any functionality in xLights.
xLights will parse and retrieve the information from the media file. It won't update any information entered on the media/info screen unless the Overwrite Media Tags setting on the Media/Info screen is ticked.
After updating any data Click on Done to Update.
The Timings tab enables you to create or import one or more sets of timing marks on timing tracks for the audio of your sequence.
This screen is part of the flow when creating a new sequence or can be accessed via this tab at any time after creating a sequence to add additional timing tracks.
Clicking on New will present you with a list of options. You can either select a fixed value such as 50 or 100 ms or select from one of the options in the list.
This component uses the VAMP plugins to generate the timing marks.
Selecting one of the options then presents a window where you can either select the defaults or change the timing name or any of the plug-in settings.
Click Ok and the audio track will be analysed and a timing track will be created. You can then click New again to select another timing track (‘Beats’) to be created.
Click Done when complete.
The Import button enables you to import timing marks created externally for example using Audacity or where you have created a timing track manually or wish to import one from another sequencer in a supported format.
You will be presented with a window to navigate to and select a file containing the timing marks to import to the timing grid. This can be a text file (.txt), a LOR .LMS/.LAS file, Papagayo .PGO file, LSP File, or, xLights .XML/.xsq/.xtiming file.
You can repeat this process to import another timing grid from the same file or from another file. Click Done when complete.
If the Render Mode is set to Erase (which is the default value), then the fseq file is erased before every render. If set to Canvas Mode, then the data in the fseq is not cleared before a render, rendering is done over the old data.
If set to Canvas mode, deleting an effect will still show when played until it is overridden with a new effect. Imagine a 6 foot painting in which you paint over a 4 foot section. The 2 foot original section is still visible. This is the how canvas mode works.
When should you use the data layer to import effects?
Typically if you have sequences from other sequencers such as LSP, LOR, Vixen, HLS that you wish to use within xLights. The imported sequence is mapped very efficiently as a data image rather than individual effects. After importing the sequencer you can:
Save it ( an .fseq file is created) and run it within xLights or via the Falcon Player
Add xLights effects to new models via the sequencer
Selectively override some of the effects from the imported models within xLights.
You cannot however ‘edit’ any of the imported effects directly. In order to do that see the Import Effects function. The data layer embeds the CONVERT tab into the sequence. The process is used to convert an incoming file from another sequencer into an *.iseq file. Therefore, Vix, Lms, Seq, and Hls data into an ISEQ file.
This conversion is done in two places.
When you a import a data layer
When you press the ‘Render All’ button
The purpose of ‘Render All’ is to render all the effects and data layers to the sequence object without saving to disk. The already imported ISEQ file data is used. If the source (‘LMS’, ‘SEQ’, ‘HLS’ etc) file is changed, then you need to go to the Data Layer tab, click on that layer and select the Re-Import function.
Before using this function, a new sequence should have been created or an existing sequence opened.
From the Main Menu tab, select Sequence Settings and then Data Layers.
Click on Import, navigate to where your input file (‘LMS’, ‘LSP’ etc) is, change the file type as required and select the file to be imported. Click ok.
On completion of the import, the Data layer details and the number of channels imported to the data later will be displayed. The file has been imported/converted and stored in an .iseq file.
The normal (and default) option is for the xLights ‘layer’ to be on the top and the imported sequence data represented below it. When rendered, the data is rendered from the lowest layer upwards, so the xLights effects will be rendered last. (Refer to discussion under Move Up/Move Down).
On the Main Menu, click on the ‘Render All’ button, after which the sequence can be played. Click on the ‘Save’ or ‘Save All’ buttons to save the sequence.
You must click Render All or Save the file after the Import function is complete, the data is not automatically rendered.
To view the details of the data that has been imported, double-click on the model's row title to reveal the strands and then the nodes. The imported effects are at the node level.
Use this function if you wish to delete a data layer that has been created via the import function. Select on the layer and delete.
While the most common use of this function is to import effects from a previous sequencer once per sequence, you can import multiple layers to be rendered at the same time. An example of this is where you may have two purchased LOR (or other) sequences for a mega tree singing faces. Or you may have xLights effects on a whole house model which you then want to be ‘overridden’ by the imported data layer.
Using the Up/Down buttons allow you to determine which layer will take precedence over the others. The highest layer will render last i.e. on top of the others and so forth.
Use this function, if you wish to re-import and overwrite an imported data layer. Normally required if the source i.e. LSP, LOR sequence has been amended in any way and you wish to overwrite the previous import without affecting any other effects that may have been added to the sequence within xLights. Select the data layer and click on the re-import function, after which, functionality is the same as the Import function.
Backing up your critical files and sequences should be done regularly – as good practice.
What should be backed up ? Anything you require to run your show, but in particular your XML sequences, your media files and your user specific xLights configuration files.
The xLights configuration files are located in your show directory and are: xlights_keybindings.xml, xlights_networks.xml and xlights_rgbeffects.xml
By default xlights backs up the key files at the start of a session when xLights is launched.
The files are saved in a subfolder with a timestamp and ‘_onstart’ suffix.
It will also create a backup when the show directory is changed. If you have enabled Backup on Save, it will also take a snapshot after every Save operation.
Pressing F10 anytime, anywhere will backup your XML files for you and store them in a new folder with the date/time embedded in the name the backup was created. You can press F10 as many times as you like and should do this at least once per sequencing session. Keep in mind that you must have saved at least once in order for an updated XML file to be protected.
Alternatively, from the File menu, select Backup.
You will be presented will a message indicating where a backup will be created. Click Yes to proceed. Every time this step is executed, a copy will be created of all the ‘*xml’ files from your show directory into the Backup subdirectory of your show directory. A new subfolder is created each time a backup is executed.
The F11 function does not do an auto (in memory) backup of the current sequence if you have one open. It will backup the open sequence XML contents from when it was last saved.
It is a good practice to also separately backup any files that you may have used as inputs to your sequences such as LSP, LOR, Papagayo files that you imported, media files that may have amended with audacity, GIF or JPEGs etc. You may also wish to backup any FSEQ files, though this can be recreated by saving the sequence again.
Backing up the show directory (and media directory if it is different) to an alternate location is the simplest way to ensure that you have the files required.
To summarise the backup functionality:
When xlIghts starts up - a folder timestamp_OnStart is created and the XML and XBKP files in the show directory are backed up there.
When F10 / F11 is pressed , a folder (timestamp) is created in the show/alt location and the above files are backed up there (referred to as an on demand save).
Every x (3,10,15,30) minutes , the current open XML file (i.e xxx.xml) is backed up (overwrite) to xxx.xbkp or __.xbkp (for a new unnamed sequence) in the show directory. This will occur if there have been any changes since the last auto save or on demand (F10/F11) save.
Every x minutes (same value as set above), the xlights_rgbeffects.xml is backed up to xlights_rgbeffects.xbkp in the show directory. This includes the layout as well. This will occur if there have been any changes since the last auto save or on demand (F10/F11) save.
If you need to recover, File -> Restore Backup
Select the backup folder from the left list and "check" which files to restore. The right list display basic data about the files found in the selected backup folder.
xlights_networks.xml file contains the controller tab data.
xlights_rgbeffects.xml file contains the layout, model, preview and preset data .
xlights_keybindings.xml files contains the keyboard shortcut settings.
The Sequence Tab can be used to backup sequence files.
Click the "Restore Files" button to start the restore process.
The Convert function is commonly used to convert a sequence file from one sequencer format to the format of another sequencer or to the format (.fseq) required to run via Falcon Player on a Raspberry Pi or BeagleBone Black controller.
It is not to be used to convert into an xLights sequence – use the Data Layer or Import, Import Effects options to achieve that.
Supported input/output formats are:
Click on Choose Files, and on the subsequent window, change the file type to the type of file that you wish to convert and navigate to where your input file (i.e. LOR LMS file etc) is located. Select the file and Click Open or Double click to select the file.
Select the output Format to convert to. Supported output formats are:
Specify whether all channels should be turned off at the end of the sequence. (Tick if unsure)
Select the Show Verbose Channel Map. This option will display messages pertaining to the input sequencer channel mapping for some inputs and is useful to identify missing or misaligned channel information.
Select the options specific to LOR conversion.
Specify the time resolution i.e. (25ms, 50ms, 100ms). These correspond to (40 fps, 20 fps, and 10 fps respectively). Select 50ms if not sure.
Click on Start Conversion.
Conversion messages are displayed. If successfully converted, a file of the same name but with a different extension (i.e. as specified for the Output Format) will be created in your show directory.
With the ‘Show Verbose Channel Map’ selected, the conversion messages display which channels have been converted to equivalent xLights channels. This information can then be used to amend the channel mapping and/or define additional LOR controllers as required.
From the Edit menu , you can select the Undo, Cut, Copy and Paste functions and apply them where where applicable. As an example, when on the sequencer grid, you can highlight an effect, click Edit and then click on Copy (to copy the data to the clipboard). Move your cursor to where you want the effect to be duplicated and then click File and Paste.
You can also use the associated Ctrl keys instead i.e. Ctrl+C and Ctrl+V in this case. The functionality of each option is self explanatory.
These Options allow the user to shift or move the effects in a sequence. This is useful if the effects are not lining up with the music. This may be due to using a slightly different audio file or looking different on the actual physical lights as compared to that in xLights.
Note that the value entered is in milliseconds. 1 second is equal to 1000 milliseconds.
To shift the effects to the right, enter the number as a positive value. To shift the effects to the left, enter the number as a negative value.
Shifting effects works on both timing and effects.
The Generate Custom Model function enables you to generate an xLights custom model using a picture or video of the physical item. You should have defined your controller and need to know which channel the model will start on and how many channels.
Select the Generate Custom Model option from the Tools menu.
There are three type of models for which custom models can be generated:
A static model - such as a wireframe silhouette (reindeer or similar) where a row of lights can be turned off or on. You can use the video process described here or even use a photograph of the image.
Pixel based effects where each node is three channels.
Single Channel such as Singing faces where several LED nodes turn on and off for a single channel.
The video or photograph should be done with the model in front of a plain dark background with the lights on. There should not be too much of bright light (otherwise the bulbs as they light up cannot be clearly distinguished), neither should it be completed dark, else this will cause a scattered flash effect.
Click on the Prepare tab to generate the lights that you need to record a video for.
If the model is a pixel based model, select Type-Nodes. If the model is a single channel, select Type-Single Channels.
The Node/Channels counts refers to the number of Pixel nodes (Type =Nodes) or Channels (Type = channels). A face with 7 channels would have 7 specified as the Channel count. A star with 100 nodes - would have 100 specified as the count.
Set Type = Nodes. The start channel corresponds to the start channel of the model definition.
Leave the intensity bar setting in the position that it has defaulted to.
Click on the Run Capture Program. The following prompt will be displayed.
When your camera is ready, steady and in position, click on OK. The software will flash the lights twice, then run through the model definition, lighting each bulb in turn. When complete the following message will be displayed to stop the video recording. The recording has now been completed.
Upload/Copy the video from the camera onto your PC directory.
Click on the Process tab. Select the Type of lights and press Next.
When prompted for the location of the video file, browse to and select the video file that was recorded in the earlier Prepare step. Then click on Next.
The red dots are the lights that have been found and retained. The blue dots are the lights that have been found , but have been discarded because they are too close to a red dot. If the dots are too close, then the model generated becomes too big.
There are three areas in the image where the lights have not been detected (the yellow boxes have been added for illustration in the manual only ). Increase the sensitivity (move slider to the right). The window at the bottom of the screen indicates how many nodes have been detected, the number of bulbs detected, how many nodes are missing, which nodes have more than one bulb and the size of the model.
Click Next and the model that is generated is displayed.
Use the ‘-’ and ‘+’ keys to zoom out and zoom in to see the model.
Click on Save to name and save the custom model.
Then use the Import Custom model function on the Layout screen to import the model that has just been created.
Select Type = Nodes and repeat the same process as described under the Static Lights example (Prepare).
Similarly, when your camera is ready, steady and in position, click on OK. The software will flash the lights twice, then run through the model definition, lighting each bulb in turn. When complete a message will be displayed to stop the video recording.
Then using the Process screen, browse to and select the video that has been generated and uploaded to your PC.
Click on Next.
The software will examine the first fifteen seconds on the video to identify the start point (ie when the first of two flashes occurred and will then check that it can determine the pathway of the lights). A ‘Looks ok’ message will be displayed along with the start position on the video (2.95 secs in the example) if this is detected. If it does not work ( a ‘Looks wrong’ message will be displayed) , or the start position does does not look right , you can use the four frame buttons to move the video back or forward.
Click on Next to proceed to the next step. You can adjust the controls if required. The blur can be used (increased) to remove any dead spots, the sensitivity adjusted (right if some bulbs are not detected and left if too many are detected).
If the ‘Video is steady’ is selected, then the software will attempt to filter out some of the background to get a better image. Otherwise it will retain much of the background and try and compensate of an unsteady video camera , but this may generate additional pixels.
If Manual update is selected, then moving the sliders won’t do anything unless the Update button in then pressed. The Restore Default button is used to restore the sliders and options to the default option.
The image shows the pixels generated (red dots). The two yellow boxes (that have been added in the manual only) illustrates spurious pixels.
The window displays the number of nodes, how many bulbs were detected, missing nodes and a list of nodes where more than one bulb has been detected. You want the number of bulbs to match the number of nodes or be as close to it as possible.
Use the Trim bars (i.e. drag them towards the image) to eliminate the pixels around the image. The number of bulbs should decrease as this occurs. Increasing the sensitivity can also be used to try and filter out others nodes.
Click Next and the model that is generated is displayed.
Use the ‘-’ and ‘+’ keys to zoom out and zoom in to see the model.
Click on Save to name and save the custom model.
Then use the Import Custom model function on the Layout screen to import the model that has just been created.
This function enables you to to play the audio during sequencing at normal (Full) speed or to adjust the audio to faster or slower speeds as shown below. Slower speeds are useful for fine tuning timings to the audio, especially on fast paced songs. Higher speeds are useful for seeings all the effects used without having to listen to the entire song.
Click in the waveform and then select one of the speed options. Click Play. The audio will then be played at the selected speed and the vertical visual indicator will move along at the speed being played.
As the speed is slowed the pitch of the song will get lower.
To return to normal speed, select Play Full Speed.
The volume of the audio can also be adjusted to 4 preset options at the lower portion of the Audio Menu. This can be used in addition to or instead of the audio volume controls on your computer.
If joining the Zoom help meetings and screen sharing, set the Audio to "Very Quiet" as the volume controls on your computer do not change the volume of the audio that is being shared with others in the meeting.
There are a number of windows that enable simultaneous display of different views in xLights. When xLights first loads, a default set of windows are displayed. Which windows are open can be controlled via the Windows menu by selecting View, Windows and then clicking on the required window to open it. The window is dropped by default on the left side of the screen, however each window can be moved and docked to alternate locations on the same screen or moved to an alternate display screen if connected to your PC/ MAC.
The Display Elements window enables views, Timings as well as models to be defined and updated. Functionality for these functions is described in the Views, Timings and Models section of this document.
The Model Preview window displays the effects on a model as the sequence is playing. With the window open, right click on the model name when on the sequencer tab and select Play model. It can also be opened/closed by clicking on the icon on the toolbar.
The House Preview window displays the effects of your entire display where the model or model group has been assigned to the currently selected Preview window. Refer to explanations of multiple Preview windows in the Layout section. It can also be opened/closed by clicking on the icon on the toolbar.
The Effect Settings window displays the current or last effect that is being worked with. If an effect on the grid is selected or a new effect dragged to the grid, then this window gets updated with the ‘current’ effect.
Use the window to modify the attributes of the effect as required. The results of the change are displayed in the model window when selected and in the House Preview window when the sequence is played.
The Value Curves functionality in this window has been covered under a separate topic entitled Value Curves.
It is possible to select a group of the same effects and change the settings of all of them all at once. For example you wish to increase 5 instances of the Circle effect to have the Number of Circles = 10. Select multiple instances of the effect by holding down control when you click on them. Change the Number of Circles setting to 10 , then click on the Update (F5) button in the Effect Settings window. The window can also be opened/closed by clicking on the icon in the toolbar.
The Effect Colors window enables the user to change the colors of the current effect that is being worked with. If an effect on the grid is selected or a new effect dragged to the grid, then this window uses the ‘current’ color.
Use the window to modify the colors of the effect as required. The results of the change are displayed in the model window when selected and in the House Preview window when the sequence is played.
The Value Curves functionality in this window has been covered under a separate topic entitled Value Curves
It is possible to select a group of the same effect type and change the color of all of them all at once. For example 5, spiral effects that are all on different models and need to be changed to the same color. Select multiple effects by holding down control when you click on them. Change the color palette then hit the Update button beside the colors. The window can also be opened/closed by clicking on the icon in the toolbar.
By clicking on one of the colors, the color box will appear allowing you to choose or create any color you desire. To create a custom color, click on the Define Custom Colors >> button.
The first option of Morph is used with two or more layers. If selected, effect #1 will morph/blend/fade into Effect #2 midway through the timing interval in which the effects are placed.
The Layer Settings menu has two tabs. The first tab (Buffer) defines how the effect will be adjusted during the render process in the buffer for the Model or Model Group. The second tab (Roto-Zoom) is used to apply the Roto-Zoom functionality to the model effect.
The Effects Dropper window displays all the supported effects and enables you to select a required effect and drag it to the sequence grid.
The same functionality can also be obtained using the effects from the effects toolbar as below:
The size on the icons on the Effects Toolbar can be adjusted by going to Settings/Tool Icon Size. There are 4 different sized icons are available for use.
The Value Curves Dialog allows the user to drag and drop their saved values curves onto the desired effect setting.
The Color Dropper Dialog allows the user to drag and drop their saved colors/color curves onto the color palette.
The Effect Assist Window is an additional window that helps you determine how an effects is being drawn via a panel view.
For example, if you open this window against a morph effect, the windows will display a grid corresponding to the x,y coordinates. If you then grab a slider for the morph effect and move it, the Effect Assist window shows exactly where the coordinate is being moved to, making it easier to determine what is being done to the effect.
You can also grab a corner of the image in the Effect Assist window and move it and have the slider values update in real time.
If you want single line morphs instead of area morphs then it's easier to just click with the left mouse button to establish the start points and click with the right mouse button to establish the endpoints. For areas you can either click and drag with either button or drag the handles.
The Select Effects Window allows the user to select effects based on type, model, and time. Based on the these selection, multiple effects can be selected and then bulk edit can be used to adjust the settings. This allows the user to, for example, select all the pinwheel effects on there mini trees and change the number of arms with bulk edit.
The "Effect Type" allows the user to select which effect type to select. The Model List allows the user to select which models to filter selection on. Only highlighted model names, will have their effects selected. The Time Fields allows the user to effect filter selection by time. The Effects by Time List displays all the effects found based on the other options and will select the highlighted items.
The Video Preview Window allows the user to preview the video file, they are using while sequencing it as the audio track.
The Jukebox Window allows the user to "link" an effect or multiple effects to one of it's 50 buttons. These buttons can then be used for realtime playback i.e in a DJ or theater environment. This mapping can also be used by xFade.
The Perspectives Window enables you to save your current window positions and retrieve and use them later.
The Reset Toolbar option, when selected will reset the Windows and Toolbars to the default locations.This option should be used if you are missing an window or toolbar from the sequence window.
The Test Dialog enables you to test anything from a single channel, all channels for a model or all channels by sending different test patterns to your physical lights.
The Check Sequence option runs a series of verification routines against the currently loaded setup, layout and sequence. This process will generate a text file containing information on the controller outputs, channel mappings and model information as well as identify any potential issues which could cause problems within xLights. Selecting the option will open up a text file using the default text file editor on your computer.
ERRORS in a check sequence file indicate there is something wrong with your setup, layout, or sequence and the show will not run correctly. Errors should be fixed before trying to run the sequence from your controllers.
WARNINGS are indications that something is not typical, but the show will still run. Verifying that the warnings are intended, or correcting their cause is recommended before running the sequence from your controllers.
Cleanup File Locations will move all the files currently used by xLights (audio, videos, pictures, etc) into the Show directory. This is useful when backing up or packaging your sequence for sharing, so that all of the needed files and paths are retained.
This option will take the currently open sequence and packages it up neatly into a zip file with all the images, audio and other files necessary to open and re-render this sequence on another computer. If you plan on sharing a sequence with another person then this is the best way to ensure you grab everything the recipient will need to open and use your sequence.
The Download Sequences/Lyrics Dialog provides a list of free sequences available on the Google Drive. You can select a Sequence to download and xLights will open the download link in your default web browser.
This Dialog also contains links to the Singing Faces Project Lyric tracks. You must be a member of the singing faces project to access these files.
Batch Render allows the user to re-render multiple sequence files. This is useful if a Layout change was made and all the FSEQ files need to be updated. The "Filter" drop-down allows the user to select which folders to search for the sequence XSQ/XML files in.
Recursive Search - No Backups
Search the show folders and sub-folder not including backup folders.
Recursive Search
Search the show folder and sub-folder including backups folders.
Only Show Directory
Search Only the root show folder.
If "Recursive Search" or "Recursive Search - No Backups" is selected the "Folder" drop-down allows the user to select a sub-folder to limit the search too.
Place a check-mark next to the sequence XSQ/XML file name you plan to batch render. There is a right click menu to Select All or Select None.
Click OK to render all the Sequence XML file.
If a Error is found during batch rendering, xLights will display a popup and will stop rendering. Monitor batch rendering to verify all the FSEQ files are created correctly.
FPP Connect is used to upload to a Falcon Pi Player that is playing the role as a show player the channel and model configurations and one or more sequences (including associated audio).
Bulk Controller Upload allows the user to upload the E1.31 Universe Inputs, and Controller String port Settings. Check the controllers you would like to upload and click upload.
Right Click to enable options to Select Controllers based on Active, Auto Config or FPP Proxy
HinksPix Export dialog is used to generate the required SD card files to use the HinksPix controllers in standalone mode. The selected sequences files will be generated for the selected controllers.
This dialog allows the user to run Lua scripts to automate xLights functions.
The Export Models functionality creates a Spreadsheet (.xlsx) file with the details of all your models. Click on the Export Models menu item. You will be prompted for a filename and location to create the file in. Specify the filename and click OK.
The Export Effects functionality creates a CSV file with the details of all the effects in the open sequence. Click on the Export Effects menu item. You will be prompted for a filename and location to create the file in. Specify the filename and click OK.
A CSV file will be created with a row for each effect defined listing all the key attributes. In addition summary rows are created showing the number of times each sequence is used as well as the total duration of each effect.
The Export Controller Connections option creates a Spreadsheet with all the controller to model wiring information. This is meant to be used as a prop "hookup" list.
The View Log option, enables a user to view the information / debug log that xLights maintains, if required to troubleshoot any problems and provide information when posting questions. Selecting the option will open up a text file using the default text file editor on your computer. Scroll to the bottom to view the latest messages that have been written to the log.
The Package Log Files option, provides functionality to package the required xLights XML/XSQ and log files into a ZIP file which can then be provided for analysis. It is similar in content to the ZIP file created when a system crash occurs.
From the Tools menu, with the sequence that needs to be investigated open, select the Package Log Files option. The required files will be zipped into a file ‘xLightsProblem.zip’ and you will be prompted to save it in the show directory.
You can change either the ZIP file name and/or the location before saving the file.
The zip file will contain the xLights network, rgbeffects, the sequence XSQ (if open is open) and a log file. The zip file can then be provided to the xLights team for analysis.
To speed up loading, xLights caches(saves) the download items(Vender Model List, Free Sequence List) for up to 5 days. Purge Download Cache deletes the cached files and forces xLights to downloaded the newest version. This is needed when there are updated to the files available for download, but xLights is not seeing the newest list.
The Render Cache is used to save rendered effects data to speed up render times. This option deletes the cache and forces xLights to re-render all the effects.
This 2D Path Generate Tool allows you to create X and Y value curve "paths" that can then be used by effects like the shape effect.
Click and Drag the endpoint Dots, to move them. Double Click to add a new Line Segment. The Browse button allows the user to load a image to trace if needed. The slider will adjust the image brightness. Load will allow you to edit previously generated files. The Generate Button will save the path to two value curves files (X & Y Direction) to be loaded by an effect.
The Generate Custom Model function enables you to generate an xLights custom model using a picture or video of the physical item. You should have defined your controller and need to know which channel the model will start on and how many channels.
This tool is used to take a model with valid/useful face definitions, state definitions and submodels and remap them onto a model with a reordered wiring layout. The two models must be identically dimensioned custom model with pixels in all the same positions.
The Generate Lyrics From Data allows xLights to generate Lyric Timing Tracks with Phonemes from channel data. This data can be a LOR LMS or LAS file, that has been imported as a data layer first. Select the start channel of the channel data and the offset for each mouth movement channel. xLights will then generate the Phonemes Track from this data.
The Convert function is commonly used to convert a sequence file from one sequencer format to the format of another sequencer or to the format (.fseq) required to run via Falcon Player on a Raspberry Pi or BeagleBone Black controller.
This is not to be used to convert files into an xLights sequence – use the Data Layer or Import, Import Effects options to achieve that.
Prepare Audio allows xLights to load an audio "Cut List" file and edit an audio file to remove sections of a song or combine multiple songs. Reaper project files(.rpp) and xAudio Files (.xAudio) Files are supported.
The User Lyric Dictionary Dialog allows the user to manually add word phonemes breakdowns to the user dictionary file in the current show folder. This list will be used in addition to the standard and extended library, to breakdown works when creating lyric tracks. Enter your new work into the first text box. The second text box will auto search the current word list and find similar words and display their phonemes. The second box supports multiple words separated by a space. Once you are happy with the phonemes breakdown you can add it to the library.
Windows and Linux - This menu option will launch the xLights scheduler/player xSchedule.
Windows and Linux - This menu option will launch the xCapture E131 Recording Tool.
Windows and Linux - This menu option will launch the xScanner, which can be used to discover controllers located on the network.
MacOS - This menu option will launch the second instance of xLights that can be used for mapping sequences.
The import effects dialog allows the user to import effects from other sequences in the currently open sequence. This option should be used when importing purchased sequences from different vendors.
The Import Effect dialog supports multiple sequence file formats. xLights, Light-o-rama S4, S5, SuperStar, Vixen 2, Vixen 3(limited), HLS, LSP, VSA File formats are all supported.
The following example describes how to use this function to import an effects from an xLights XSQ/XML sequence.
First ensure that you have created or opened an existing sequence that has the models added to the sequencer that you wish to import to. Note you must select a View first. If there are no models or groups displayed on the Sequencer, then you won’t be presented with any models to import to.
This process can be used to
Import effects from a xLights sequence from another user
Import effects from another of your (e.g. older) xLights sequence into an existing xLights sequence
Create a new directory and unzip the sequence files to that directory. It is recommended to create this directory within your show folder. The zip file should contain the xlights_rgbeffects.xml, the sequence.xsq or sequence.xml and any other required files(image, shader, etc files). Change the show folder in xLights to point to the new directory. Copy the music file to the new folder if missing.
Open the sequence, click on Render All and Save the sequence. You should be able to see how the lights flow in the layout window. Study the sequence and determine which models you wish to copy to your own models.
Print out the model names from the shared sequence as you will need to know those when you import.
Look for the correct quantity of elements in the donor sequence that will match your elements. For example If you have 4 windows but the donor sequence has 8, pick the 4 windows that you want to copy.
Make a note of the names of each donor model you want to copy to a model of your own layout. Watch the sequence several times.
Make sure you have the appropriate music file in your own media show directory. Close the sequence you were watching, go to the controller tab and change the show folder back to your own directories.
If importing into a new sequence, then
Create a new musical sequence, select timings and add your display elements or select a view.
Save the sequence.
Else
Open the sequence you want to import into, add your display elements or select a view.
Ensure that your models are in your sequencer view before you start the import , else you won’t have any models to import into.
Select Import, Import Effects
Select the donor sequence xLights XSQ/XML or the Zip File.
A model mapping window is displayed. On the top left is a list containing the timing tracks to import. On the left are the models and model groups from YOUR layout/sequencer tab("Model"). 'Blue' items are Model Groups. On the right is a list of models/groups/submodels ("Available") that contain effects from the sequence being imported. Click and drag a model name from the right list to the ‘Map To’ column in the row that you want to import the model to. You may also highlight the "Map To" cell and double click on a "Available" model to map it or highlight a "Available" model and double click the "Map To" cell.
Models in the "Available" list will turn gray when used. These items can still be used multiple times even when grayed out.
When done, select "Save Mapping", and save the XMAP file. This XMAP file can then be loaded in the future when mapping another sequence from the same layout.
Click OK when done.
Change the File Type drop-down to SUP. Then select the SuperStar Sequence File.
The SuperStar Import Dialog will then appear. Select the xlights model to import the SuperStar file onto.
xLights will create pictures from the SuperStar files. The next dialog asks the user to select a folder to save these pictures files too. In the file name field set the 'base' file name. This 'base' name is used as the file name root of all the saved image files. In most cases just set the 'base' name to the SUP file name.
The SUP file will then be imported to the specified model as picture and morph effects.
Importing a LOR sequence follows the same steps as described above. However, depending on the LOR hardware setup, channel definitions in LOR and correspondingly in xLights need to align. See discussion within Tutorials Section, Coming Over from LOR.
The Perspectives Window enables you to save your current window positions and retrieve and use them later. So you can have a set of windows open for a single monitor , a different set when you have two monitors etc.
You can specify a name for each Perspective (Single Window Perspective, Dual Monitor Perspective etc). In order to do so, with the windows arranged as required, Click on Save as New. You will be prompted to specify a name. Click on Save to save it.
The solid circle to the left of the Perspective name indicates which Perspective you are using. To overwrite it, click on Save Current. You will be prompted to confirm that you wish to override the current perspective. Click on Save to save the Perspective.
Select a saved perspective and double click to load the required windows.
To load and use a different perspective or change/remove one, click on Edit/Load. Select the perspective and use the ‘-’ button to delete it or Click on Rename to Rename it.
Double Click to load and use the perspective. You can also do this by selecting the perspective directly by clicking on its name in the previous window. To revert to the default perspective, click on Default Perspective in the previous window.
There are a number of windows on the left of the Sequencer Canvas (Model Preview, House Preview, Effect Assist, Effect Settings) and on the top of the Canvas (Effects, Color, Layer Blending and Layer Settings). This is currently the Default Perspective.
If you have a single monitor, you can close the windows that you may not use straight away or if you have multiple displays , then you can drag and rearrange them.
The next image shows the common windows kept open, moved to the left, and the less common ones have been closed.
You can however arrange the windows in any fashion.
The rearranged windows must be saved as the default perspective so that it is loaded in that fashion whenever you open xLights.
Click on View, Perspective and then Save Current.
To Open and select Windows, click on View, Windows and select the Window(s) that you wish to have open.
The view menu enables you to zoom in or out on the sequencer view, define and use Perspectives and nominate which windows you want to have open.
Selecting this option while on the sequencer tab will zoom in on the details on the sequencer grid. Use this for fine tuning timing marks or effects.
Zooming in can be performed by:
Selecting View/Zoom In from the Menu Bar
Using the + (plus) key on the keyboard
Selecting this option while on the sequencer tab will zoom out of the details on the sequencer grid. Use this for seeing more of the sequence.
Zooming in can be performed by:
Selecting View/Zoom Out from the Menu Bar
Using the - (minus) key on the keyboard
The Reset Toolbar option, when selected, will reset the Toolbars to the default locations the next time xLights is started. A restart of xLights is required for it to take effect.
The AC Lights Toolbar allows you to add On, Off, Shimmer, Twinkle, and Ramp effect in bulk, similar to LOR.
Select an Effect, using the On effect in this example, then click and drag on the desired rows to populated.
The Effects will be places in the selected area.
Show Start and End Intensity for effects, similar to LOR.
Perspectives saves the location and size of the "windows" you use.
Particularly for dual monitor setups, it lets you move and size the Preview and Color windows away, giving you a bigger program area. Going to View / Perspectives / Save Current will store your settings to the currently selected perspective.
You can have multiple perspective saved and easily recall them by selecting the perspective desired from the Perspectives window.
The FPP Connect Dialog is used to upload files to a Falcon Player(FPP) that is being used as a show player, remote player, or in bridge mode. The channel inputs, channel outputs, model configurations and one or more sequences (including associated audio) can be uploaded to one or more FPP instances. FPP Connect only supports FPP 2.0 and newer.
On startup, xLights will attempt to auto-discover all the FPP instances on your network. If none are found, Click the Add FPP button to manually add a device by its IP Address.
The Upload Checkbox Column will "Enable" the FPP instances for xLights to upload data to it. If unchecked xLights will not upload any data to that device.
The Location Column will display the DNS host name and IP address. The Description Column DNS Host description value. The Version Column is the FPP software version installed on the device.
The FSEQ Type Column allows the user to select which FSEQ file version to upload to each FPP device. V1 FSEQ files are required for FPP 2.5 and lower. The V2 FSEQ file format is a compressed files format that only works with FPP 2.6 and newer. The V2 FSEQ Sparse file format is the same a V2 but limits the channel range to what is required for that FPP instances output devices. If using FPP 2.6 or newer, it is recommended to use the V2 file format on the Standalone/Master FPP devices and the V2 Sparse file format on FPP remote devices. For FPP 2.5 and lower, V1 file format must be used. xLights will select a default FSEQ version based on the FPP version and if a Pixel Hat/Cap is attached or if a LED matrix is set up. This can be changed by the user if needed.
If the Media checkbox is selected, xLights will upload the Media Files.
If the Model checkbox is selected, xLights will upload the Model Data for the display testing page.
The UDP Out dropdown will enable xLights to upload The E1.31 and DDP Channel Output definitions from the Setup Tab in xLights. 'All' should be selected on Player FPP Devices that will send E1.31, DDP, or Artnet data to another controller and 'Proxied' should be used for any FPP Devices that act as a proxy tunnel to other controllers like a F16v3.
The Playlist drop allows the user to select a predefined Playlist in FPP to add the uploaded Sequences too.
The Pixel Hat/Cap Column will display if a Output device is attached and configured. Devices like PiCaps, Matrix PiHat, F8-B, etc will appear if they are configured in FPP. If the Checkbox is selected the input channels will be configure. For Matrix PiHat the panel start channel will also be configured.
You can then select one or more sequences to upload. The sequence FSEQ files are listed here. If the sequence is an audio sequence then the media file will also be uploaded if the media checkbox is selected.
There is a Right Click Menu to Select All Sequences, Clear Selections, Select Highlighted, or Deselect Highlighted.
When the upload button is clicked all selected items will be uploaded to the FPP instances with the Upload Option checked and the dialog will close. Cancel will close the dialog without uploading any changes.
The Spreadsheet file will be created with a row for each model defined listing all the key attributes. Additional sheets are added with group attributes and global Channel/pixel counts. Spreadsheet programs such as Microsoft Excel or are used to view the .xlsx files.
Clicking on the Zoom In Icon on the Tool Bar
Clicking on the Zoom Out Icon on the Tool Bar
A link to this Manual.
This opens the default web-browser with a link to the xLights Zoom Meeting Room. This is a online meeting room with audio and video, where users can meet for technical support. Participants can share their computers desktop for remote assistance. It is Recommended to have a microphone to help other participants talk you through the issue. It is also possible to use your phone and call in for audio only assistance. There is a "Official" US meeting at every Wednesday 8pm EST , and Australian meeting every Friday, 8pm AEST. The Zoom Room is open 24/7 and can be used anytime for tech support questions.
View a list of the current keyboard shortcuts.
Basic About Page with information about the tab the user is currently on.
Link to the http://nutcracker123.com xLight Help forums.
Link to http://videos.xlights.org/ which contains many HowTo videos.
Link to http://xlights.org to download the newest release.
Opens the xLights Software Release Notes.
Opens the Default Web-browser with a link to the xLights Issue Tracker.
Link to the Offical xLights Support Group Facebook Page
Link to the Offical xLights PayPal Donation web page.
Checks for new version of xLights. This is also done automatically on program startup.
The About option display a window containing xLights release information, the official website, copyright and acknowledgements.
