OBSCraft - Minecraft Integration with OBS Studio

OBSCraft - Minecraft Integration with OBS Studio

Note: This modification is currently in active development and alpha testing stage. Please report any bugs you encounter!

OBSCraft unlocks new possibilities for streamers and content creators by enabling direct interaction with OBS Studio from within Minecraft. Using command blocks, datapacks, and plugins, you can automate various actions in OBS while playing the game.

The technical implementation is based on processing special translatable chat messages that get decoded and execute corresponding commands. For convenience, you can generate tellraw commands directly through the console command /obscraft.

Demonstration Video

Main Features

• Switch active scenes directly from the game!
• Update text content of text sources
• Manage visibility of sources in specific scenes
• Enable and disable filters on sources (works with plugin filters such as Move as well)

All these functions support both direct name specification and value lookup through scoreboards. You can search for the first player with a specific score or view the score of a specific player (works with all types of scoreboards).

Important note: For the client to "see" a scoreboard for use in this mod, the scoreboard must be attached to some display. This can be any display, even if invisible to the player, such as a different team's sidebar.

Available Commands

• /obscraft listConnections - Shows a list of all OBS connections with ID and connection status
• /obscraft reconnect <id> - Reconnect to OBS using the specified ID
• There are additional commands for generating tellraw commands and saving actions, which are detailed in the in-game help when entering commands

Connection Setup

OBS Studio Configuration

First, you need to activate the web socket server in OBS.

Go to Tools -> WebSocket Server Settings in the OBS program.

Make sure of the following:

• The Enable WebSocket Server checkbox is checked
• The Use Authentication option is activated
• Write down the Server Port and Server Password values by clicking the Show Connection Info button

Minecraft Configuration

Remember: To work, the mod requires installed Architectury API.

Launch the game once to generate the configuration file, which gets created among other mod settings files.

Example configuration structure:

{
  "connections": [
    {
      "ID": "default",
      "host": "127.0.0.1",
      "port": 4455,
      "password": "password"
    }
  ],
  "savedActions": {},
  "savedActionKeys": {}
}

• ID - unique connection identifier. You can set up multiple connections to different OBS instances
• host - IP address of the computer running OBS. For local computer use 127.0.0.1
• port - port number from OBS web socket settings
• password - password from OBS web socket settings

With simple setup, make sure the port and password match the OBS settings.

After this, restart the game and check the connection with the /obscraft listConnections command - the default entry should appear in the list of available connections.