Puzzle Game

Unleash the fun with the Puzzle Game extension!
Transform any OBS source into an interactive game where your viewers swap pieces to solve the puzzle, right from the chat!

Whether you're away from your screen or want a fresh way to engage with your audience, this tool is perfect. Create a captivating puzzle from any scene or source instantly!

Features

Seamless Setup

Creating a new puzzle is as easy as 1-2-3! Select an OBS source, set the desired difficulty, and voila!

The extension automatically generates a new scene with all the pieces and their coordinates.

Just hit the Start button and let the fun begin! (Some adjustments to the size/position of the nested scene may be necessary.)

Unlimited Puzzle Scenes

Create puzzles for multiple sources or scenes! Switch between them based on your current scene.

Ultimate Customization

Customize the game to your taste! Choose the grid size for difficulty, adjust borders and margins, pick a font for coordinates, and select colors for every element.

Animated Fun and Sound Effects

Watch puzzle pieces shuffle and move with smooth animations! Enjoy optional sound effects or swap them with your favorites.

Automatic Winner Announcements

The game knows when the puzzle is solved and keeps track of which viewer placed the most pieces correctly!

Reshuffle and Surrender Commands

Mods and the streamer can reshuffle or auto-solve the puzzle at any time.

Leaderboard

Keep track of puzzle champions with an automatic leaderboard for current and past games.

Here's a sneak peek of the Puzzle Game extension in action, thanks to JimmyPotatoTV!

Setup

Getting Started

Check out a quick setup guide:

1. Ensure SAMMI is updated to the latest version and connected to OBS and Bridge.
2. Install these OBS plugins:
   • OBS Shader Filter: v1.21+ Download
   • Source Clone: v0.1.3+ Download
   • Move Transition: v2.4.4+ Download
3. Install the extension. You can follow the Extension Install Guide.
4. Configure the Puzzle Game Deck:
   • Modify the red INIT button and fill in the following fields:
     • OBSWS Name: The name of your OBS connection in SAMMI (default is 'Main').
     • OBSWS Port: The port number (default is 4455).
     • OBSWS Password: Your OBS password (if set).
   • Save changes and press the button.

Creating a New Puzzle

1. Modify the blue Create New Puzzle button:
   • Fill out required fields:
     • New Puzzle Scene Name: A name for your puzzle scene.
     • Source Name: The source for your puzzle.
     • Scene Name: The scene where your puzzle source is located.
     • Rows: Number of rows (max 26).
     • Columns: Number of columns.
   • Optionally, fill out additional customization fields:
     • 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 changes and press 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: Enable sound effects for shuffling/moving pieces.
   • Shuffle Pieces to Mid: Gather pieces in the center before shuffling them.
2. Start the game by pressing the button or add a chat trigger like !puzzle start.

Shuffling the Puzzle

Press the Shuffle Puzzle button during an active game.

Moving Puzzle Pieces

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 the Puzzle

Press the Solve Puzzle button to complete the current game instantly.

To reset all puzzle variables and the leaderboard, check Reset All inside the button, or manually press the Reset Puzzle button.

Resetting the Puzzle

Click the Reset Puzzle button to reset the puzzle and clear the leaderboard.

Viewing the Leaderboard

You can view the current leaderboard by 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.

Customizing Puzzle Sounds

You can customize the sound effects for shuffling, moving pieces, and solving puzzles inside the respective buttons.