Lucky Wheel

Create, modify and control your Lucky Wheel overlay in OBS straight from SAMMI! Very easy setup and use!

Set up your own wheel in a few easy steps! Supports multiple wheels.

Features

• Create wheels via a user-friendly interface in Bridge or SAMMI commands, including prepopulated wheels with equal chances from an array of all possible rewards
• Use plain text or images for wheel segments
• Show, spin, and stop the wheel, and get the winning reward in SAMMI
• Modify wheels and their rewards on the fly
• Duplicate an existing wheel
• Shuffle wheel rewards
• Balance wheel reward chances

Control your wheel directly from SAMMI Deck
You can load, spin and stop spinning the wheel with one press of a button in your SAMMI Deck or add your own chat triggers, so that your mods can control it too! The winning reward's name will be automatically saved into a variable in your SAMMI.

Customize it!
You can have a simple text based wheel with randomly generated segment colors each time you load it.

Or... you can choose a color for each segment.

And... you can use an image for each segment instead of text! There are also a few different animations available!

Give you viewers the power to increase the reward chances! Can be activated through chat or channel points redeems!

Setup

1. Install the extension. You can follow the Extension Install Guide.
2. Press the red SETUP button and follow all instructions while connected to OBS.
   • A new Lucky Wheel overlay should be added to your OBS.
   • A new 'Example Wheel' should be added to your SAMMI.
3. Modify the Example Wheel directly from Bridge in the Lucky Wheel tab or with Lucky Wheel commands in SAMMI. Add a new wheel or cycle through existing wheels and activate different ones from SAMMI using the arrows.
4. Press SHOW WHEEL in your SAMMI Deck.
5. Press SPIN WHEEL in your SAMMI Deck.

Each button includes comments explaining how it works. Please review them and adjust for your stream, such as customizing chat messages.

General Info

• The extension only supports OBS Websocket 5
• If you change your OBS connection name, type, port, or password, press the red SETUP button again.
• The OBS browser wheel overlay file is located at SAMMI/Ext/Lucky_Wheel/wheel.html.
• All your wheels are saved in SAMMI/Ext/Lucky_Wheel/luckywheel.ini.
• Segment images should be placed in SAMMI/Ext/Lucky_Wheel/img and resized as needed.

Adding a Wheel

1. From Bridge
   Go to Bridge - Lucky Wheel tab, click 'Add' and choose a new wheel name (avoid duplicates). Populate rewards by pressing 'Add Reward'.
   If using images, place them in the SAMMI/Ext/Lucky_Wheel/img folder before adding them in Bridge.
   Press 'Save' to store the wheel.

2. With a SAMMI Command
   Use the 'Lucky Wheel Add/Delete Wheel' command.

   Box Name	Explanation
   Wheel Name	Name for your new wheel (avoid duplicates)
   Reward Array Name	Optional. Provide an array of all rewards (will be equally distributed) to populate your wheel with. Leave empty to add rewards manually.
   Winning Animation	The animation to perform after the wheel stops. 'Blink Text' only works for text segments and 'Image To Mid' only works for image segments.
   Set As Active	Whether to set the newly created wheel as currently active wheel
   Type	Type of action to perform - select Add

Modifying a Wheel

1. From Bridge
   Go to Bridge - Lucky Wheel tab, select the wheel, and click 'Load'. You can modify its settings, rewards, chances, and segment colors.
   Place images in the SAMMI/Ext/Lucky_Wheel/img folder before adding them in Bridge. Press 'Save' to store changes.

2. With SAMMI Commands
   Use 'Lucky Wheel Modify Wheel' to adjust wheel names and settings.

   Box Name	Explanation
   Wheel Name	Name to modify (leave blank for currently active wheel)
   New Wheel Name	New name (optional)
   Winning Animation	The animation to perform after the wheel stops. 'Blink Text' only works for text segments and 'Image To Mid' only works for image segments.

   Use 'Lucky Wheel Add/Delete Reward' to add or remove rewards.

   Box Name	Explanation
   Wheel Name	Name to add/delete the reward (leave blank for currently active wheel)
   Reward Name	Reward name (no duplicates)
   Reward Chance	Percentage chance for the reward
   Color	Segment color (optional)
   Image	Image for the segment (optional)
   Type	Select 'Add' or 'Delete' for the reward (only wheel name and reward name required for deleting)

   Use 'Lucky Wheel Modify Reward' command to modify a single reward. Must already have an existing wheel.

   Box Name	Explanation
   Wheel Name	Wheel name (leave blank for currently active wheel)
   Reward Name	Reward name to modify
   New Reward Name	New reward name (leave empty to leave it unchanged)
   Chance	New percentage chance for the reward (leave empty to leave it unchanged)
   Chance Input	manual - manually set the chance to X % </br> - increase - increase the chance by X % </br> - decrease - decrease the chance by X %
   Color	Segment color
   Modify Color	Check if you want to modify the color
   Image	Image for the segment (leave blank to leave it unchanged), the image must be placed in your SAMMI/Ext/Lucky_Wheel/Img folder, else it will not display
   Remove Image	Check if you want to completely remove the image

Deleting a Wheel

1. From Bridge
   Go to Bridge - Lucky Wheel tab, select the wheel, and click 'Delete'. This action cannot be undone.

2. With SAMMI Commands
   Use 'Lucky Wheel Add/Delete Wheel' to remove a wheel.

   Box Name	Explanation
   Wheel Name	Wheel name to delete (must be specified)
   Type	Select 'Delete' to remove the wheel

Activating a Wheel

1. From Bridge
   Go to Bridge - Lucky Wheel tab, select a wheel, and click 'Activate'.

2. From Deck Hopper
   Cycle through wheels using arrows and select the wheel you want to activate.

3. With SAMMI Commands
   Use 'Lucky Wheel Activate' command to set an active wheel.

   Box Name	Explanation
   Wheel Name To Set	Name of the wheel to activate

Displaying a Wheel in OBS

Press SHOW WHEEL. If the wheel is nested in a scene, modify the SHOW WHEEL button to add the nested scene name.

Spinning and Stopping a Wheel in OBS

Press SPIN WHEEL to spin the wheel, which stops after a set time.
To stop it manually, remove the stop command from the SPIN WHEEL button and press STOP WHEEL manually.

Getting a Winning Result

When the wheel stops, the WINNER WHEEL button triggers, and the winning result is saved to the wheel_winner variable.

Modifying Reward Chances

Use the Modify Reward Chances button with the 'Lucky Wheel Modify Reward' command.

If you wish to change the channel point redeem name for modifying rewards (default is 'Lucky Wheel'), right click on the Modify rewards button - Edit Twitch Triggers. Scroll down using the big arrow and modify BOTH redeem names (one is for decreasing the reward chance and one is for increasing it).

• Chat Trigger:
  !wheel REWARD NAME +PERCENTAGE or !wheel REWARD NAME -PERCENTAGE
  (e.g., !wheel Sekiro +10 or !wheel Bloodborne -50)

• Channel Points Redeem Message:
  REWARD NAME +PERCENTAGE or REWARD NAME -PERCENTAGE
  (e.g., Sekiro +10 or Bloodborne -50)

Balancing Reward Chances

Use the Lucky Wheel Balance Rewards command to balance the chances for all rewards equally.
Press Show Wheel after executing the command to update the OBS overlay.

Shuffling the Wheel

Use the Lucky Wheel Shuffle Wheel command to shuffle the rewards.
Press Show Wheel after executing the command to update the OBS overlay.

Duplicating a Wheel

Use the Lucky Wheel Duplicate Wheel command to create a copy of an existing wheel, useful for removing claimed rewards while keeping the original intact.