LogoLogo
  • User Manual
  • Chapters
    • Welcome
      • Acknowledgments
      • History
      • Sisyphean Effort
    • Quick Start Guide
      • Installation
      • Defining a Show Directory
      • Controllers
      • Layout and Background Image definition
      • Model Definition
      • Model Group Definition
      • Creating a New Sequence
        • Adding Models to a View
      • Adding Effects
      • Saving the Sequence
      • Backup and Exit
      • Testing
    • Installation
      • Upgrade
      • Windows
      • Macintosh
      • Linux
    • Controllers Tab
      • Controllers
      • Show Directory
      • Controllers Settings
        • USB Controller
        • Ethernet Controller
        • NULL Controller
        • Controller Visualizer
    • Layout Tab
      • Layout
      • Models
        • Model Settings
          • Setting Start Channels
        • Arches Model
        • Channel Block Model
        • Candy Cane Model
        • Circle Model
        • Cube Model
        • Custom Model
        • DMX Model
          • DMX Moving Head Advance
        • Image Model
        • Icicles Model
        • Matrix Model
        • PolyLine Model
        • Single Line Model
        • Sphere Model
        • Spinner Model
        • Star Model
        • Tree Model
        • Window Frame Model
        • Wreath Model
      • Download/Import Models
      • Model Groups
      • Objects
      • Layout Preview
      • Editing Layout Preview
      • Moving Model/Objects
      • SubModels
    • Sequencer Tab
      • Sequencer
      • Rendering
      • Timeline and Waveform
      • Adding An Effect
      • Changing An Effect
        • Changing Color Settings
      • Layers
        • Layer Blending
        • Layer Settings
      • Timing Tracks
      • Render All
      • Windows
      • Value Curves
      • Effect Presets
      • Views
      • Models
      • Singing Faces
        • Adding Word to User Dictionary
      • Pixel Editor
      • Shortcuts
    • Menus
      • File
        • New Sequence
        • Preferences
          • Backup
          • View
          • Effects Grid
          • Sequences
          • Output
          • Colors
          • Other
        • Sequence Settings
        • Backup and Recovery
      • Edit
      • Tools
        • Test
        • Convert
        • Generate Custom Model
        • FPP Connect
      • View
        • Windows
        • Perspectives
      • Audio
      • Import
      • Help
    • Advanced Features
  • Effects
    • Built-in Effects
      • Off
      • On
      • Adjust
      • Bars
      • Butterfly
      • Candle
      • Circles
      • Color Wash
      • Curtain
      • DMX
      • Duplicate
      • Faces
      • Fan
      • Fill
      • Fire
      • Fireworks
      • Galaxy
      • Garlands
      • Glediator
      • Guitar
      • Kaleidoscope
      • Life
      • Lightning
      • Lines
      • Liquid
      • Marquee
      • Meteors
      • Morph
      • Moving Head
      • Music
      • Piano
      • Pictures
      • Pinwheel
      • Plasma
      • Ripple
      • Servo
      • Shader
      • Shape
      • Shimmer
      • Shockwave
      • Single Strand
      • Snowflakes
      • Snow Storm
      • Spirals
      • Spirograph
      • State
      • Strobe
      • Tendrils
      • Text
      • Tree
      • Twinkle
      • Video
      • VU Meter
      • Warp
      • Wave
  • Appendicies
    • Glossary
    • Keyboard Shortcuts
  • Tutorials
    • Configure Matrix Panels
    • Coming from LOR
    • Editing xLights_rgb.xml
Powered by GitBook
On this page
  • Backup
  • Backup On Save
  • Backup On Launch
  • Backup Subfolders
  • Purge Backups Older Than
  • Backup Directory
  • Alternative Backup Directory
Export as PDF
  1. Chapters
  2. Menus
  3. File
  4. Preferences

Backup

PreviousPreferencesNextView

Last updated 2 years ago

Backup

Backup On Save

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.

Backup On Launch

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.

Backup Subfolders

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).

Purge Backups Older Than

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.

Backup Directory

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.

Alternative Backup 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.