Quick Start

Quick Start

BlueMap addon only

Keep the addon installer enabled and leave standalone disabled:

enabled: true

web-addon:
  auto-install: true
  auto-patch-webapp-conf: true

standalone-web:
  enabled: false

Standalone only

enabled: true

web-addon:
  auto-install: false
  auto-patch-webapp-conf: false

standalone-web:
  enabled: true
  path: "/chat"

BlueMap and standalone together

enabled: true

web-addon:
  auto-install: true
  auto-patch-webapp-conf: true

standalone-web:
  enabled: true
  path: "/chat"

Recommended public HTTPS layout

Run BlueMap and BlueMapWebChat internally over HTTP and expose them through a reverse proxy:

http:
  host: "127.0.0.1"
  port: 8899
  path-prefix: "/api"
  cors-origin: "https://map.example.com"

web-addon:
  api-base-url: "/bmwc/api"

See Caddy Example or Nginx Example.

Login

Minecraft account linking uses:

/bmchat auth <code>

A linked player can set a web password with:

/bmchat password <newPassword>

Enable DMs only after choosing a retention policy

direct-message:
  enabled: true

For cross-server DMs, read the compatibility warning in Direct Messages and Server Relay.

Apply changes

• Config-only changes: /bmchat reload
• JAR replacement: full server restart
• BlueMap web addon changes: /bluemap reload if necessary
• Browser JS/CSS: hard refresh if an old asset is cached