Skip to content
Voxlytics
Log in with Discord
Log in with Discord

Docs

Guides for setting up Voxlytics in your server.

Guild Chat

Bridge your guild's in-game chat with a Discord channel: what members say in guild chat shows up in the channel with their head, level, and name, and what people type in the channel goes to guild chat.

1. Before you start

  • Only the guild's owner can set it up. You don't need /link: Voxlytics finds you through the Discord account you connected to Voxyl in-game.
  • You need your Voxyl API key. Use /api get in-game to see it (or /api new for a new one).
  • Voxyl only passes on the in-game messages of players the owner allows. Add each member in-game with /api grants add <player>; until then, their guild chat messages don't show up in Discord. Messages from Discord always reach guild chat.
  • In the channel you pick, Voxlytics needs View Channel, Send Messages, Manage Webhooks, and Add Reactions, and you need to be able to see and post there yourself.

2. Set it up

  1. Run /guildchat setup in your server.
  2. Pick the channel in Pick the guild chat channel.
  3. Press Connect API key and paste your key. It's only ever stored encrypted.
  4. Voxlytics checks the key belongs to you by sending one line to guild chat. If Voxyl doesn't show it back, you're asked to type a short code (like vox-1234) in guild chat within 3 minutes.
  5. Voxlytics creates a webhook in the channel and the bridge starts. Press Send test to see a message arrive.

3. How it works

  • In-game messages appear in the channel with the player's head, level, and name, for every player you added with /api grants add <player>. Messages from one player in a row may be joined into one post when chat is busy.
  • Messages typed in the channel go to guild chat as IGN: message, sent with your key. The IGN is the Minecraft name of the Discord account connected to Voxyl in-game; anyone who hasn't connected one shows with their Discord name.
  • Messages from Discord go out one per second, in order. If one person has more than 3 waiting, the extra one gets an hourglass reaction and isn't sent; a red cross means Voxyl didn't accept it.
  • Several servers can bridge the same guild. Each gets the same chat, and setting up a new one never interrupts the others.

Messages sent in-game while Voxlytics restarts (a few seconds during updates) can't be fetched afterwards, so they don't show up in the channel.

4. Pause, change, or remove

Run /guildchat setup again: Pause and Resume the bridge, pick another channel, Change API key, or Remove it after confirming (its webhook is deleted too).

  • If you make a new key with /api new, the bridge stops and you get a DM. Connect the new key with Change API key.
  • If someone deletes the webhook, Voxlytics makes a new one by itself.
  • If the guild gets a new owner, the bridge stops; the new owner can set it up again.