OBSCraft

**Right now this is in active development and still in alpha, please report any bugs you find!** Connect Minecraft directly to OBS Studio using the OBS WebSocket plugin. Allows using command blocks, datapacks, and plugins to trigger various actions in OBS Studio. This works by listening for a specially formatted translatable chat message, which is decoded then acted upon. You can generate a tellraw command using the `/obscraft` command. ## Demo Video <iframe width="560" height="315" src="https://www.youtube.com/embed/iM5pzSq7dtU?si=CchAkCgFsPzkmhRx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> ## Features - Set the active scene from in-game! - Update a Text source's text. - Set a source's visibility in a given scene. - Set the visible status of a filter on a source. (Also works with plugin filters such as the Move plugin) Each of these options support both typing literal names as well as looking up names from a scoreboard objective. You can either search for the first player with a specific score or search for the score of a specific player. (Works with both dummy objectives and "real" scoreboards) **NOTE: To have the client "see" a scoreboard objective for use in this mod, the scoreboard must be attached to a display. It can be any display, even if it's not visible to the player, like a different teams's sidebar.** ## Commands - `/obscraft listConnections` - List all OBS connections by ID. Gives connection status for each one. - `/obscraft reconnect <id>` - Reconnect to an OBS connection by ID. - There are more commands to generate tellraw commands and save actions, but the in-game documentation is setup to show them all as you type. ## Setup ### OBS Studio First, we need to make sure the websocket server is enabled. In OBS go to `Tools -> WebSocket Server Settings`. Make sure of the following: - `Enable WebSocket Server` is checked. - `Enable Authentification` is checked. - Note down the `Server Port` and `Server Password` Press `Show Connect Info` to see it. ### Minecraft Note: The mod required the (https://modrinth.com/mod/architectury-api) installed to load. Launch the game once to generate the config file, it should be with other configuration files for you mods. It should look like this: ```json { "connections": , "savedActions": {}, "savedActionKeys": {} } ``` - `ID` is a unique identifier for the connection. You can have multiple connections to different OBS instances. - `host` is the IP address of the computer running OBS. If it's on the same computer, use `127.0.0.1` - `port` is the port number from the OBS WebSocket settings. - `password` is the password from the OBS WebSocket settings. For a simple setup just make sure port and password match the OBS settings. After that restart the game and you should be good to go! Make sure everything is connected by running `/obscraft listConnections` and `default` should show up under Available Connections.