Skip to content

Narrate

MoSadie edited this page Feb 17, 2023 · 3 revisions

Description

Make the in-game narrator say anything. There are options to configure if the narrator can interrupt itself, otherwise the message will play after the previous message finishes. The narrator ignores the volume sliders when reading messages, so be aware!

A tip for those who read the wiki: An easy way to stop the narrator mid-sentence is to interrupt with a message with just a space.

Configuration Options

  • Title (optional): An optional title to display on the key. Customize location and font using the T icon to the right of the text box.
  • Minecraft IP (required): The address that the EffectMC mod is running on. (Example: http://localhost:3000)
  • Message: The message to have the narrator read.
  • Interrupt: If this message is allowed to interrupt what the narrator is currently saying.

Example Configuration

Screenshot of Elgato Stream Deck software with a title, Minecraft IP, message, and interrupt set for the Narrate action

In-Game Experience

YouTube video:

Youtube Video

Advanced: HTTP Request Information

  • Method: GET
  • Endpoint: /narrate
  • Parameters:
    • device: Device ID (String)
    • message: The message for the narrate to read. (String)
    • interrupt: (Optional) If this message interrupts what the narrator is saying. Accepted values: true, false (String) (defaults to false if invalid value or missing parameter)