Skip to content
MoSadie edited this page Dec 9, 2023 · 6 revisions

Note

As of v2.0.0 there is now also a web page you can use to trigger effects, no Stream Deck required! You can access the page by going to http://localhost:3000 on the computer running Minecraft, or http://<your computer's local IP>:3000 on another device.

This is also compatible with Stream Deck Mobile, which is free to use with 6 buttons.

Installing the Stream Deck Plugin

In order to actually trigger any effects, you need to install and setup the Stream Deck plugin. You can download the plugin from the latest release. (It it the file ending in effectmc.streamDeckPlugin)

(WIP: I plan to submit the plugin to the Elgato Marketplace soon, which will make this a lot easier.)

Installing the plugin

  1. With the Stream Deck software open, run the plugin file you downloaded.
  2. When prompted in the Stream Deck software, approve the plugin.
  3. That's it for installing the plugin!

Configuring the actions

After dragging one of the actions to your Stream Deck, you may have a few question on how to configure the action. There is a detailed guide for each action here with what each configuration field means, but one is the most important: Minecraft IP

Minecraft IP represents the Minecraft client you want to send effects to. By default the Minecraft mod uses port 3000 on your computer to listen for effects. Here are some valid options for what to put in that field:

  • http://localhost:3000 for a Stream Deck attached to the computer running Minecraft with the default port.
  • http://xx.xx.xx.xx:3000 for a Stream Deck attached to a different computer than the one running the Minecraft mod with the default port. Replace the xx.xx.xx.xx with the local IP of the computer running the Minecraft mod. (Ex Stream Deck on a separate Streaming PC with Minecraft on the Gaming PC)

Some actions have the ability to use color formatting codes to adjust the text. You can do this using the § character and the standard Minecraft formatting codes. The actions that support this have a message telling you that they are supported.

For a detailed page for each action, there are a group of pages here with example configurations and an in-game gif of the effect like the one below.

https://github.com/MoSadie/EffectMC/raw/main/docs/img/join-server-in-world.gif

Next Step: Adding Trust