This is a side project I've been working on so RPAN Studio streamers can interact with their viewers in a more immersive way.
Using the script, you can:
- text-to-speech comments (either choose to tts all comments or only comments which contain
!ttsbefore them) - display tts-ed comments on one of your current text sources in RPAN Studio
- automatically respond with custom messages whenever someone comments
!help
I've done my best to design this project so even not-so-tech-savvy people can use it too. There is a very detailed guide on how to set everything up down below. I apologize in advance to any developers who might be disgusted by my code; I am not a developer, just a professional Googler.
If you have the time, I would appreciate if you could check out my Youtube Channel where I build robots. Other than that, please enjoy the script and let me know if you have any trouble.
Because OBS Studio does not support newer versions of Python, you'll have to install Python 3.6.1.
You can install it using this link -> https://www.python.org/downloads/release/python-361/
Run the exe file and follow the steps below:
- Check off "Install launcher for all users (recommended)"
- Click "Custom installation" to continue to the next screen
- You shouldn't need to change anything on this screen, just click "next" in the bottom right corner to continue to the next screen
- On this screen, you want to check off "Install for all users"
- Click "Install". Python should be good to go after it finishes loading
Download the code from Github and unzip the folder to wherever you to plan to store it
Double click "run_first.py" to run the file. Allow it to make changes to your device. If all goes right, it will automatically install the needed Python libraries for the main Python script.
Open RPAN Studio and follow the instructions below:
- Click on Tools -> Scripts from the main options
- Click "Python Settings" and paste
C:/Program Files/Python36into the python install path - Click "Scripts", click the "+" sign to add a new script, and then add "rpan_chat_commands.py" from wherever you stored it
- You will get an error that says something like
TypeError: change_button() takes 2 positional arguments but 3 were given. This only shows when you first add the script, so just ignore it and restart RPAN Studio. - The script is now ready to use
There are two menus, main menu and options.
main menu |
options |
|---|---|
|
|
Checking certain settings under options will change the layout of main menu
checking enable !help |
checking enable comment display |
|---|---|
|
|
To start processing comments, you need to:
- Start a stream
- Copy the stream URL by clicking the "Copy Link to Stream" button (found near the bottom right of the main RPAN Studio screen)
- Paste the stream URL into RPAN Chat Commands and then press the "start" button
- The "start" button will switch to say "stop". After a short second, the script will begin processing the comments
You can press the "stop" button to stop processing the comments. It is important to do this if you are exiting RPAN Studio, otherwise the script will continue to process comments in the background (you'll have to task manager it to end it).
When you press the "stop" button, there is a 5-10 second delay before the script stops processing comments, so make sure the script log says successfully stopped processing comments before you start processing comments again / exit the application.
After checking off enable !help in options, new options will appear under main menu.
There will be an area to enter the login information of a Reddit account.
The Reddit account you enter will automatically respond with the text entered in !help response whenever someone comments the !help command. This can be useful to link socials, give info about the stream, or any other information you might want to give your viewers.
There is currently no limit to the number of times this command can be used by an individual, so this command will likely be prone to spam. To prevent this, I'm going to add an alternate feature where the !help response will automatically be commented every X comments in the stream. This will make it so your viewers can still see that information as frequently as you want them to, but without them being able to spam the chat.
After checking off enable comment display under options, a drop down list containing all the current text sources will be added under main menu.
The text source you set as the comment display will constantly be updated with the most recent text-to-speeched comment. It's shown in the format: [reddit_username]: [comment]
If you aren't currently processing comments but still have enable comment display checked off, the text source will be updated to say your tts messages will appear here until you start processing comments.
Checking off enable !tts command under options causes the script to only text-to-speech comments which have the command !tts before them (as opposed to the every comment default)