This project hooks into the Tiltify API to look for new donations to a Tiltify campaign, displays new donation data in an OBS scene, and sends an alert to the Twitch chat. Created for use in Gaming For Global Change events.
Before following the instructions below, make sure you download the project here and un-zip it.
tiltify_obs_demo.mp4
- Ensure OBS is updated to the most recent version.
- Download and install the Source Copy plugin.
- Restart OBS and make sure the scene collection you want to use is open.
- Go to
Tools > Source Copy > Load Scene, and select the corresponding file for your operating system:- On Windows: Select
donation_bar_scene_windows.jsoninside thewindowsfolder. - On macOS/Linux: Select
donation_bar_scene_macos_linux.jsoninside themacos_linuxfolder.
- On Windows: Select
- Add the
Donation Barscene to the scene you want the overlay to appear on. - Go to
Tools > WebSocket Server Settingsand ensureEnable WebSocket Serveris toggled. - Keep this window open as you will need to enter the server password and port to your credentials file during installation.
⚠️ The default font for the text sources is Arial. If your system does not have Arial installed, you must change their font for them to show up on your stream preview. You may customize the overlay however you like in theDonation Barscene, but do not rename any of the sources.
Install Python if it's not already on your system. The minimum version is Python 3.7.
If you don't already have it, you can download it from the Python website. If you're installing it on Windows, you must select the Add to PATH option in the installer.
Then, proceed with the following steps for your operating system.
Go to the windows folder and open (double-click) the following files:
install_windows.batrun_windows.bat
Open the macos_linux folder in your terminal and run the following commands:
sh install_macos_linux.shsh run_macos_linux.sh
If you're familiar with Python and don't want to use any of the included scripts, proceed with the following steps:
- Open the
appfolder in your terminal. - Install required modules from
requirements.txt. - Edit
credentials-example.jsonwith your credentials, and rename it tocredentials.jsonwhen you're done. - Run
main.py.
If you need to update your credentials at any point (ie. change the Tiltify campaign you want alerts for), the credentials file is located in the app folder. Just edit credentials.json with a text editor like Notepad or TextEdit and save it when you're done.