Extensions

Setup

Getting Started

Check out a quick setup guide:

1. Ensure SAMMI is updated to the latest version. Make sure it’s connected to OBS and Bridge.
   Please note that this extension requires OBS Websocket 5.
2. Ensure the following OBS plugins are installed:
   • OBS Shader Filter: version 1.21^ Download
   • Source Clone: version 0.1.3^ Download
   • Move Transition: version 2.4.4^ Download
3. Install the extension. Follow the Extension Install Guide for help.
4. In the Puzzle Game premade deck (added after extension installation), modify the red INIT button:
   • OBSWS Name: The name of your OBS, to be used for this extension (matching the name in the SAMMI-OBS Connections menu). By default, it’s ‘Main’.
   • OBSWS Port: The OBS port for this extension (matching the one in the SAMMI-OBS Connections menu). Default is 4455.
   • OBSWS Password: Your OBS password, if set (matching the one in the SAMMI-OBS Connections menu).
5. Save the changes and click the button.

Creating a New Puzzle

1. Modify the blue ‘Create New Puzzle’ button:
   • Fill out all required boxes:
     • New Puzzle Scene Name: A new name for your puzzle scene.
     • Source Name: The source for your puzzle.
     • Scene Name: The scene where your puzzle source is located.
     • Rows: The number of rows your puzzle should have, with a maximum of 26.
     • Columns: The number of columns your puzzle should have.
   • (Optional) Fill out the optional boxes:
     • Border: If you want a border around every piece.
     • Border Thickness: Border thickness in pixels. Adjust this if your puzzle scene is resized.
     • Border Color: Border color. Choose from the color picker.
     • Text Size: Size of the puzzle text coordinates. Adjust this if your source is significantly resized.
     • Text Font: Font of the puzzle text coordinates. Example: Comic Sans MS.
     • Text Color: Color of the puzzle text coordinates. Choose from the color picker.
     • Outline: If you want to show a puzzle text outline.
     • Outline Thickness: Puzzle text outline thickness. Adjust this based on font size and scene size.
     • Outline Color: Puzzle text outline color. Choose from the color picker.
2. Save the changes and click the button.

Starting a New Puzzle Game

1. Modify the green ‘Start Game’ button:
   • Puzzle Scene Name: The puzzle scene you want to start the game on. This is the scene added with the ‘Create’ button.
   • Sounds Enabled: If you want to enable sounds when pieces are shuffled/moved.
   • Shuffle Pieces to Mid: If you want the pieces to first gather in the middle and then spread out when shuffling.
2. Click the button (or add a Twitch chat trigger to the button, like ‘!puzzle start’).
3. A new game begins! Your chosen OBS source for the puzzle scene will be hidden and replaced with the puzzle scene. The puzzle will shuffle instantly, ready for your viewers to start playing.

Shuffling Puzzle Game

Click the ‘Shuffle Puzzle’ button. It only works when a puzzle game is already in progress.

Moving Puzzle Piece

By default, the chat trigger to move a puzzle piece is ‘!Puzzle move * to *’.
You can customize the button trigger, but don’t forget to adjust the block inside the button that manages trigger data. Within the button, you can customize chat messages for when a piece is moved, an incorrect coordinate is given, or when the puzzle is solved.

Solving Puzzle

Press the ‘Solve Puzzle’ button to instantly complete the current puzzle game.
Inside the button, check Reset All if you want this command to also reset all puzzle variables and clear the current puzzle game’s leaderboard. Otherwise, you’ll need to manually press the ‘Reset Puzzle’ button afterwards.

Resetting Puzzle

Press the ‘Reset Puzzle’ button to reset the puzzle. This will reset all puzzle variables and clear the current puzzle game’s leaderboard.

Viewing Leaderboard

You can view the current leaderboard using the ‘Leaderboard’ button. Press it once to post the current leaderboard in your chat.
This is all managed automatically, including saving the user who made the most correct moves in the last puzzle game.
The leaderboard is saved into puzzle_leaderboard.csv file in your SAMMI/Ext/Puzzle_Game folder for each completed game, along with the username who made the most correct moves.
Please avoid manually editing the file.

Customizing Puzzle Sounds

Within this button, you can modify the puzzle sounds for when you shuffle the puzzle, move a piece, and when the puzzle game is solved.