Description

Setup

A default config file is autogenerated on first launch at config/matrix-minecraft-bridge.json.

Appservice mode

Edit the config:

change server_url to where the bridge can reach the homeserver,
and server_name to your Matrix server name.

Write an appservice registration.yaml like:

id: minecraft url: "http://localhost:37182" as_token: CHANGEME hs_token: CHANGEME sender_localpart: minecraftbot namespaces: users: - exclusive: true regex: "@minecraft_.*"

where as_token and hs_token should match what's in the .json file and url is where the homeserver can reach the bridge. Then register it: some examples here.

Bot mode (per-message profiles)

Edit the config:

set as_token to your bot's access token,
remove hs_token (the entire line),
set server_url and server_name as before.

Start the Minecraft server.

Usage

Invite @minecraftbot:example.org (or your bot's mxid) to a public unencrypted room.
Minecraft messages will be bridged to the Matrix room, and vice-versa.

Run /mxmsg "@username:example.org" <message> to send a message to someone on Matrix. (only in appservice mode)