Prerequisites

Prepare MSI for deployment

1. Read the checklist
   
2. Update the SITE_URL, enable the relevant channels and enter the auth codes in the MSI.
   

Sample MSI commands

Main settings only (using defaults for the rest)

Example with all switches

If no switch is specified (i.e. SS_WAIT_MIN="5"), the default values shown in the list below will be applied.

MSI Switches

Use these MSI switches as needed. Troubleshooting Note: Switch names are case sensitive and must be in all capital letters, while Switch values are not case sensitive.

Vibe.fyi player app

1. SITE_URL (required) - Enter the unique Vibe.fyi Screensaver URL provided by your Vibe support team.
   
2. RANDOM_START: To ensure variety and prevent the same slide (e.g. Slide 1) from always appearing first, the Wallpaper Background and Screensaver slides can start at a random position. This setting can be enabled or disabled (Yes/No). Default = Yes
3. SYNC_INTERVAL_MIN: The number of minutes between synchronising slide updates for screensaver, desktop wallpaper and lock screen. Default = 30 
   
4. HIDE_SETTINGS: Enter Yes or No to show or hide your Desktop Player Settings. Default =Yes
   
5. DISABLE_APP_CLOSE: Enter Yes or No to disable/enable the ability to close the Desktop Player app. Default = No
6. AUTO_LOAD: Enter Yes or No to load the app upon startup of your device. Default = Yes
   
7. OVERWRITE_USER_SETTINGS  (optional) - Used for upgrades only. This parameter determines whether any user settings, which have been manually changed by the user, will be overwritten. Default = Yes
   

Windows Screen Saver Settings

1. SS_WAIT_MIN: Set the wait time in minutes before the screensaver will activate. Default = 5 
2. SS_ON_RESUME: Enter Yes or No to configure whether the "On resume, display logon screen" setting is enabled. Default = Yes
   
   
3. Power Options - The Console Lock Display Off Timeout in Advanced Power Options determines how long the display stays on after the computer is locked, with a default of 1 minute. To ensure the screensaver activates while the lock screen is active, set the WAIT_ times longer than SS_WAIT_MIN. The difference between these times controls how long the screensaver displays before the screen turns off. 
1. CONSOLE_LOCK_TIMEOUT: Enter Yes or No to show or hide your Vibe.fyi Screensaver content when the lock screen is activated. Default = Yes
2. WAIT_PLUG: Set the display to turn off after 'X' seconds when plugged in. Default =1800
   
3. WAIT_PLUG_LOCK: Set the display to turn off when the screen is locked after 'X' seconds when plugged in. Default = 1800
   
4. WAIT_BATT: Set the display to turn off after 'X' seconds on battery. Default = 600 
   
5. WAIT_BATT_LOCK: Set the display to turn off when the screen is locked after 'X' seconds on battery. Default = 600
   

Screensaver

1. ENABLE_SS (optional): Yes/No to Enable/Disable the screensaver. Default = No
2. SS_LOGO (optional): The Vibe.fyi logo displays briefly when the Screensaver starts. To customise the logo, provide a secure public URL to your desired logo (e.g., https://public_website_address/logo_file_name.png). The logo must be in PNG format. When the Screensaver runs for the first time, the logo is downloaded from the public URL and saved locally at: C:\Users\[username]\AppData\Roaming\VibeScreensaver\custom\logo_remote.png. 
   To update the logo, delete logo_remote.png from the local folder, and a new version will be downloaded automatically.
3. SS_AUTHCODE: Enter your unique Screensaver AUTH CODE.
   
4. DISABLE_SS_INFOBAR: Whether the information bar is disabled or not (Yes/No). Default = No
5. SS_INFOBAR_SYNC_SEC: The number of seconds between information bar syncs. Default = 30
   

Background Wallpaper

1. ENABLE_BG: Enter Yes/No to Enable/Disable the Background Wallpaper. Default = No
   
2. BG_AUTHCODE: Enter your unique Background Wallpaper AUTH CODE.
3. BG_IMAGE_INTERVAL_SEC: The number of seconds between the background image changing. Default = 30
   

Lock Screen

1. ENABLE_LS: Enter Yes/No to Enable/Disable the lock screen functionality. Default = No
   
2. LS_AUTHCODE: The AUTH code for the Lock screen images
   
3. LS_TIMEOUT_MIN: The number of minutes that the lock screen will display for before the PC goes to sleep. Default = 60
   

Custom Logo

To use a custom logo, apply the SS_Logo switch during MSI deployment, or follow the manual steps outlined below after installation.

Logo Design Guidelines

Create your logo as a transparent PNG file and save it as logo.png.

1. The custom logo should be a square PNG file with a maximum size of 567 x 567 px and a transparent background.
   
2. For reference, the default Vibe logo measures 567 x 158 px.

Adding Your Logo

Option 1: Default Folder

Manually copy the logo.png file to the following directory:

C:\Users\<username>\AppData\Roaming\VibeScreensaver\custom\

Option 2: Custom Folder Location

If you prefer a custom location for the logo, set it using the following registry value:

HKEY_CURRENT_USER\SOFTWARE\VibeScreenSaver\CustomLogo

This can be done either manually or via Group Policy.

---