miniGIMR

miniGIMR is a python GUI written to help SSBM streamers manage OBS and their overlay. It is currently in pre-alpha (though it technically works). Planned and/or current features include

• Control over Stock Head Icons, Tags, Prefixes, etc.
• HTML, CSS and customization options
• Automatic Scene Switching
• Setup Wizard for easy configuration
• Virtual Webcam management
• Keeping various player statistics though stat collection/management tools.
• Autonomous scene switching and overlay control based on fizzi's stat technology or autoGIMR
• JSON formatted objects and save files for Matches, Tounaments, and Players
• VoD tools for generating video titles, thumbnails, and timestamps

NOTE: Please understand that as this is an (relatively) untested work-in-progress, and no funcationality or features are guaranteed to work at any point in time. That being said, the master branch should almost never recieve an update that breaks any prior functionality. Windows compatibility is in progress

Todo:

• Cross-platform Support
• Autofill and player database implementation
• Robust HTML Controls
• Character vs Character Stinger Transitions

Setting up the application (Unix)

First things first, you'll need to have python3 installed. You can check if you have python3 installed by typing

$ which python3

..into a terminal window. If you see something like

$ /usr/bin/python3

Then it's already installed. If you don't see anything, then you need python3. You can download it from the link below:

Download Python Here

Once you've got python installed, you need to install ssbm-py. Open a terminal in the directory you want the program's main folder to be located in, and type

$ git clone https://github.com/jpodolski/ssbm-py.git

Once everything has downloaded, navigate to the new main folder named ssbm-py and type

$ python3 main.py

to get started.

Application and executable bundles coming soon!

Configuring with OBS

All generated files OBS needs output by the program are saved to the ssbm-py/obs/ directory, and your media in OBS should be linked to these files. Text files are generated for player tags, sponsors, and ports, and images for character icons and team names. Follow the examples below for adding a text and image source to your broadcast. Note the file paths.

Example 1

Example 2

Authors

Primary authorship and documentation was done by Jeffrey Podolski and is licensed under the terms below.

Legal

This software is licensed under the

Attribution-NonCommercial-ShareAlike 4.0 License

This license allows you to remix, tweak, and build upon this work non-commercially, as long as you credit this project & its authors, and license new creations under the identical terms.