General

• 1: Profiles
• 2: Import / Export
• 2.1: Sequence Export
• 2.2: Sequence Import
• 2.3: Falcon Pi Player
• 3: Zip Wizard

1 - Profiles

Vixen supports creating multiple profiles so that you can have different setups. One example of this is to allow for a Halloween setup in addition to a Christmas setup, where your elements and display setup are different. I also use it to manage multiple sites so they can be configured independently and keep this size of a profile to a reasonable size.

The Profile setup can be accessed from the main administration page under System -> Profiles.

Here you can add or delete profiles. Using the green plus button will add a new profile. The default folder is placed in your My Documents folder and is based on the name you give the profile. If you want to delete a profile you can select it in the drop down and click the red minus button. This will remove the profile from showing up in Vixen, but it will not actually delete the contents on your hard drive. You will need to manually remove it if you want to. This helps prevent accidental removal of a profile.

You can also map to an existing profile that someone has shared with you. Copy or extract their profile under your My Documents folder being careful not to overwrite any of your other profiles. Many people share their default profile which is named Vixen 3. But you will want to extract that to a temp location and rename it before copying to your My Documents so you do not overwrite your main profile. Once you have it copied in, you can create a new profile and navigate the data folder to point to it.

At the bottom of the form are options to manage how profiles are loaded. You can select a default profile to always load when Vixen starts up, or have it prompt you to pick one every time. Keep in mind that if you want to switch profiles often, the ask me overtime is the best choice. To change profiles, you need to exit Vixen and restart it with the option to ask you so you can select the profile you want to load.

Lastly at the bottom is a link to the Profile Zip Wizard where you can create a zip copy of your profile for sharing or backup. See the section on the Zip Wizard for more details.

2 - Import / Export

2.1 - Sequence Export

Overview

New in 3.6u1 is the ability to import/export a sequence package. This packages up all the necessary items to share sequence(s) from a profile with someone else, or another profile of your own with different elements. See the section on Importing.

Exporting

From the main admin window, select Tools -> Export Sequence Package menu. A wizard workflow will walk you through making an export package of the sequence(s) you want to share.

Step one is selecting the sequences you want to package. There is a file browser to choose individual sequences, or you can select the middle icon which will add all sequences in the sequence folder. The last icon is used to delete selected sequences from the list. The list supports multiple selection with the normal Shift/Ctrl click or drag select.

Step two allows you to choose the package name and location to save it. The extension for packages is .vpkg. The wizard will suggest a file and path name based on the profile name. The default location to save the package is in the Export folder of the current profile. You can choose the path that makes sense for you. The other option is whether to include the audio files that are used in the sequence. In some cases you may not want to share the audio files and they can be specifically excluded. The default is to include them.

The last step is a Summary confirmation window to validate what will occur. If the summary is correct you can click next and the export will occur. Progress bars will show the status of the export as it proceeds. If there are many sequences, it may take a while to export all of them.

Once finished you have a package file that can be shared. It is fully standalone and has all the information necessary for the import process to use.

Tutorial

2.2 - Sequence Import

Overview

New in 3.6u1 is the ability to import/export a sequence package. This packages up all the necessary items to share sequence(s) from a profile with someone else, or another profile of your own with different elements. See the section on Exporting.

Importing

From the main admin window, select Tools -> Import Sequence Package from the menu. A wizard workflow will walk you through making an export package of the sequence(s) you want to share.

Step one is selecting the package file to import. This is generated from the Export process described above and has a .vpkg extension. Use the file browser to browse to and select the file to use. The next section is about the mapping file to map the profile elements for the imported sequences to the current profile. If this is the first time importing from the package or profile, you will need to create the map file. If you have previously imported sequences from this package or the same profile the package came from, you can use the file browser to select an existing saved mapping.

Creating a mapping file

You must have a package file selected before you can create a mapping. When you choose to create a mapping file, you will be presented with a screen that has the two element trees. One from the incoming package showing the source tree the sequence(s) are based on. The other tree is the destination tree of the current profile. These are presented in two columns and drag drop is used to drag the element from the destination tree to element on the source tree you want effects to map to. Once you drag it across to map it, the source tree will reflect the mapping. To replace a mapping, drag another item to it. To delete a mapping, select the mapped item and use the delete key. You do not need to map every item if you do not plan to use the effects from that source item. You only need to map what you want or what fits to your display. Once you are happy with all the items you want to map, then you can click Ok. Once clicking ok, you will be prompted to save the map file. Choose an appropriate name and location and save it. Once saved, the wizard will autofill the path you saved the map to in the map file entry box.

Selecting Sequences

Step 2 is selecting the sequences you wish to import. The screen will show you the sequences included in the package file and you can check the ones you wish to import. Multi-select can be used to select the items to change. Pressing space will toggle the state of any selected items.

Summary

Step 3 is a summary of what will be done. If the summary looks correct, then press next.

Final step is the actual import with progress showing the steps. This will take each sequence selected and map the effects in it to the current profile using the mapping file. It will copy in any audio and media files used in the sequences that are imported. When it is complete the newly imported sequences will be in the sequence folder and can be opened in the editor to play or further edit.

Hints and Tips

The import can map most everything including mark collections, layers, and media files like video and pictures that the effects use. One thing it cannot handle is Face mapping. If you map the Face elements from the imported sequences to Face elements in the destination that already have Face mappings created, they should generally just work. If the imported sequences used image mapping for faces, those will not be included. you may need to map those effects to your existing image maps, or create maps that are appropriate.

Tutorial

2.3 - Falcon Pi Player

Overview

The Falcon Player (FPP) is a lightweight, optimized, feature-rich sequence player designed to run on low-cost Single Board Computers (SBC). It was originally created to run on the $35 Raspberry Pi, hence the middle ‘P’ in the short name but now the FPP supports many more systems. It is still mostly commonly used on a Raspberry Pi (Zero, 2, 3, 4) or a Beagle Bone (Black, Green, Pocket).

The FPP shorthand is still used but it is now just called Falcon Player.

FPP aims to be controller agnostic, it can talk E1.31, DDP, DMX, Pixelnet, and Renard to hardware from multiple hardware vendors. Using various capes, FPP can also be a controller on P5 and P10 Matrixes, or strings of ws2811 pixels.

Useful Links:

• FPP Documentation in Github
• Falcon Christmas forums
• Falcon Player sub-forum
• Wiki

Vixen Support

Vixen can export FSEQ files to be played on the FPP player or FPP based controller. There are two ways to export. Sequence at a time from within the Sequencer and via an Export Wizard than can export multiple sequences at a time.

Export Wizard

The Export Wizard is the recommended way to export your sequences. It was added on to help automate the exporting of an entire shows worth of sequences instead of having to do them one at a time in the Sequencer.

Getting Started

The Export Wizard can be started from the main Admin window. Tools -> Export Wizard. This will start the process of configuring an export or using a prevouisly configured one. The first screen will ask if you want to create a new configuration or use an existing one. If this is the first time using, you will choose to Create new export configuration. IF you have used it before and saved a configuration, then you will choose to Use saved export configuration. If you are using an existing, once you choose that option, you will have a drop down to select the saved configuration to use. Choose next to move on.

Selecting Sequences

The next screen will aloow you to select or review the sequences to be exported. If you used a save configuration, this will be pre-populated with the sequences used before. You can edit to add or remove to get the list of sequences you need. The folder open icon will allow you to browse and select the sequences you want to add. The second multifolder icon will automatically add all sequences in the seuence folder for the current profile. The last option is the red X to remove any selected sequences from the list. Once you have the sequences you need in the list, you can choose next.

Configure Outputs

The next screen allows you to choose the controller blocks and the order they should be exported in. The check boxes on each controller determine if it is included in the export. You can drag and drop the controllers into any order desired. The channel ranges will be adjusted to match the new order. This will need to directly match the intended setup in FPP. Vixen can export the controller config for use in FPP, so that can be automated. In that case the controller order is not really important. All that matters is they match. If you are exporting from other sequencers, then you need to ensure they are configured the same. Once you have the proper controllers and order set, you can choose next.

Output Format and Destination

The next screen will be used to setup how to do the export. Here you can choose the output format and the timing to be used. The default of Falcon Player Sequence 2.6+ should be used for modern versions of FPP. There are other options to support legacy versions as well as exporting to older Vixen 2 formats and even CSV.

Once you have chosen a format, the next section will adapt for the format. For Falcon 2.6+, the main options here are as follows.

• Create Universe File This specifies if the universe configuration file should be genrated that reflects the controller and channel mapping. This is generated in the exact format that FPP uses. It can be directly uploaded to replace the existing configuration as part of the export in the wizard.
• Include Audio This specifies if the audio file should be included as part of the export. If enabled, the audio file will be named the same as the sequence file to ensure FPP can locate it automatically.
• Backup Universe File If the export location already has a universe file it will be renamed before it is replaced with the new one created when Create Universe File is enabled.
• Enable Conpression This enables the FSEQ file to be compressed. The default is enabled and recommended.

The last area is the output folder. This can be a file folder on your computer, or the shared location on the FFP device itself if Samba/CIFS file sharing is enabled in FPP. This was enabled by default on FPP versions 5 and older, but on 6+ it has to be enabled in the settings under FPP Settings -> System. You will need to ensure the advanced settings are enabled under FPP Settings -> UI -> User Interface Level in order to view the OS settings. In the section OS Settings, select Enable Samba/CIFS.

This will allow you to direcly export to the FPP folder over a network connection. You can use \ip\fpp by changing ip to either the ip addess of the FPP device, or the hostname if you have DNS. If you directly export to FPP, the export wizard can place all the files where they belong including the universe file, sequences, and audio. If you export to the file system, the output folder structure will mimic the structure on FPP. You can then manually upload the files for FPP. If you let the wizard export to FPP, you will need to restart the FPPD Daemon to pick up any configuration changes.

Summary

The last screen is the summary screen that details what will be done. There is also an option to save this configuration for future use. You can enter the name, or choose an existing configuiration to update. After you hit next, it will commence exporting. There will be progress bars showing the progress through the process.

Sequence Editor Export

Under File -> Export in the sequencer is the legacy export. It is very similar to the wizard, but much simplier in that it can only export the seuence you have open in the editor. You cannot save any setting in it either. This is retained for legacy purposes, but may be removed in the future, so the recomendation is to use the wizard.

3 - Zip Wizard

Introduction

The zip wizard screen is accessed from the profile System => Profiles menu on the main admin form. It can be used to create backups, copy a profile to another PC, provide a copy to developers to help debug, or share with others and has several options to configure it. Profiles are stored in the My Documents folder by default. This PC\Documents or c:\Users\bob\Documents where bob is the current logged in user. This shows up in various forms depending on the version of windows, but it is the traditional My Documents folder. Profiles generally start with Vixen 3 in the folder name if the defaults are used, but that is not mandatory.

Backups

The primary use of the zip wizard is to make a backup of your profile to restore in case something goes wrong, move it to another machine, or share with others. The settings above are the most common for this use. This will recreate the profile structure into a zip file and save it in the name and location specified. It will cover any changes to the Display Setup / Preview as well as sequences and audio files. This files in the zip archive will be relative to the profile location which is normally in the users My Documents folder.

Restoring Backup

If you need to restore a backup, it can be extracted into the users My Documents folder. This is typically in the form of c:\Users\bob\Documents where bob is the logged in user on the PC. If you are restoring on the same PC where the backup was made, then extracting it is all you should need to do. Your unzip utility should prompt you to overwrite the existing files. If you do not get that prompt, you are likely not extracting it to the same location it was backed up from.

Transfer to another PC

Copying a profile to another PC. In order to transfer the backup to another Vixen instance on another PC, you will extract the files to the users My Documents folder as described above. If you are not using multiple profiles in the source or destination, then that will likely just be the Vixen 3 folder inside My Documents and nothing further will be required. If you have multiple profiles, then the profile may need to be configured in the destination instance of Vixen if it is the first time you are copying it over.

Extracting a Foreign Profile

If you are using a Profile from another user, additional care should be taken to ensure the location of the profile they provided. If they are using a default profile, it may have a folder name of Vixen 3 which is the same as your default profile folder. You do not want to overwrite your default profile which is in My Documents Vixen 3, so when extracting make sure to change the name of the folder it is being extracted to under My Documents.

Profile Management

If this is the first time the profile has been copied to a PC you will need to establishing the the new profile for Vixen to find it. After extracting the profile, start Vixen up. To do this we want to open the Profile Editor. Depending on how you have it setup, you may see the profile selection screen at startup or not. If you see the profile selection screen at startup, the Profile Editor can be opened from there. Otherwise, it can be opened from the System => Profiles menu on the main screen.

In this screen (shown above) you need to add a new profile and give it a name. Ideally this would be the same name as you used in the source Vixen PC. Then you need to set the Data Folder to the path of where you extracted the profile you copied. This should be in your My Documents folder. In the example above, the path is C:\users\bob\Documents and the profile folder is Small Test. If you used the default path for the profile name on the source machine and named the profile the same on the destination, this may already be correct. Otherwise you can use the file explore to navigate to it. Choose the options to ask you which profile to load, or default to a specific profile and click ok. If you do not choose to ask, then you should select the new profile if you want it to load by default. Vixen will validate that the path entered is correct. If it asks you if you want to create the folder, you have misconfigured the path and should cancel and check the path. You will then need to restart Vixen once the path is correct. Once you restart, then you will either be prompted to choose the profile, or it will load the default profile you chose. You should only need to setup the profile the first time you copy a profile over to establish it. After that, just extracting the backup over the existing profile should work without any changes to the profile setup.

Diagnostics

The use shown above is for capturing the entire profile to provide when creating bug ticket that that has requested the profile to help debug the issue. This provides everything that a developer will need to recreate the profile in it; entirely including the logs which may not be in the affected profile if you are using multiple profiles.