Hello! There was a request to port this mod to Paper, so consider this my first attempt. As far as I can tell, it is working, but if you run into any issues please let me know!
Setup guide
Video setup guide: (coming soon)
Step 1: Install the plugin
You can download the latest version of the plugin from Modrinth.
Step 2: Set up Streamer.bot
This plugin is designed to work with the stream automation tool Streamer.bot. Download the program and unzip it.
The settings needed to connect Streamer.bot to the plugin are as follows:
- Under the "Servers/Clients" tab, click "HTTP Server" and check Start Server (I'd also recommend checking "Auto Start" so the server starts automatically with Streamer.bot)
Take note of the IP and port listed in that menu, if those are changed from the defaults you may need to update the plugin's config file.
To connect to a Twitch or YouTube chat, sign in to your account in the Platforms tab.
To connect to OBS, follow these steps to enable OBS's websocket server and add it to Streamer.bot
Step 3: Update Plugin Configuration
Depending on your setup, you may need to do one of the following sections:
If Streamer.bot and Paper are running on the same computer.
If you are using the default settings in Streamer.bot, no changes should be needed in the config file, and you should be able to run /streamercraft list and see the list of actions.
If you changed the port, change the numbers in the config file to match.
If Streamer.bot and Paper are on different computers on the SAME NETWORK.
You will need to update the plugin's config file.
Get the local IP of the computer running Streamer.bot and replace the http://localhost:7474 with http://<IP>:7474 (if you changed the port used, update that as well)
If Streamer.bot and Paper are on different computers on DIFFERENT NETWORKS. (Ex Paper hosted by a hosting company)
You will need to update the plugin's config file.
If you are comfortable port forwarding, you can forward the port used by Streamer.bot (7474 by default) to the computer running Streamer.bot. Then, replace http://localhost:7474 with http://<Your Public IP>:7474 (if you changed the port used, update that as well)
Otherwise, I would recommend using ngrok on the computer running Streamer.bot to create a unique address you can put in the config file. They have a quickstart guide here to walk you through setup. (Just make sure to use the port you have configured in Streamer.bot, 7474 by default) You will get a link like https://f4655f832540.ngrok-free.app that you set as the entire option in the config, no port or anything else required.
Step 4: Make sure it is all working
Once you have Streamer.bot set up, start the program and make sure the HTTP server is running. Then, start Minecraft with the plugin installed.
You'll also want to create at least one Action in Streamer.bot.
Load a world and type /streamercraft list in the chat. If everything works, you should see a list of Streamer.bot Actions in the chat.
Try pressing the "Click to manually trigger" to make sure you can trigger actions as well.
All Commands
/streamercraft list- List all available actions/streamercraft list <filter>- List all available actions that contain the filter/streamercraft do <action-id>- Trigger a specific action (This can also be a command block)/streamercraft refresh- Refresh the list of actions
Updated to Minecraft 1.21.4
Hello! Thanks for checking out this new mod.
In case you missed it, the main page has everything you need to get started with this mod & Streamer.bot as a whole. Including a fancy new tutorial video! https://youtu.be/-GzuuOlfyGE
If you run into any issues or have any suggestions or questions please reach out! Best place to get help is the issue tracker.
Note that the mod requires the Architectury API and the Fabric version requires the Fabric API