Installation

Installation

Requirements

Required:

• Java 21 or later for the supported 1.21.x server line. Use the Java version required by your Minecraft/server build.
• A Bukkit/Paper/Spigot-compatible server
• Permission to install a JAR in the server plugins/ directory

Optional integrations:

• BlueMap — embed chat directly in the map UI
• DiscordSRV — Discord bridging
• ImageEmojis-Bero — render matching emoji tokens in Minecraft with a resource pack
• ImageEmojis Picker client mod — optional F8/searchable emoji picker for players
• Caddy or Nginx — recommended for public HTTPS access

New installation

1. Put BlueMapWebChat-4.6.1.jar in plugins/.
2. Start the server once.
3. Confirm that this file was created:

plugins/BlueMapWebChat/config.yml

4. A new config starts safely with the plugin disabled:

config-version: "4.6.1"
enabled: false

update-check:
  enabled: true

5. Review web exposure, storage/retention, login policy, guest access, upload limits, and private-chat settings.
6. Enable the plugin:

enabled: true

7. Restart the server, or run:

/bmchat reload

If BlueMap web assets do not refresh, also run:

/bluemap reload

Verify the installation

Direct HTTP API, with default settings:

http://SERVER:8899/api

Standalone page, when enabled:

http://SERVER:8899/chat

For BlueMap addon mode, open the BlueMap page and verify that the BlueMapWebChat panel loads.

Standalone only

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

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

Upgrading

BlueMapWebChat never overwrites an existing config.yml. When config-version is missing or differs from the running version, it creates a migration fragment such as:

plugins/BlueMapWebChat/config-migration-4.6.1.yml

See Updates and Migration.

Build from source

mvn clean package

Expected output:

target/BlueMapWebChat-4.6.1.jar