Installation

Requirements

• A Velocity 3.4.0 or newer proxy, or a BungeeCord proxy. On BungeeCord, use build 2016 or newer (tested with build 2111). Older builds work, but see command names. Waterfall is no longer maintained and is not tested.
• Java 17 or newer.
• A permission plugin such as LuckPerms is optional. You need one to give players the permissions used by placeholders and cooldowns, and to let staff run nshoutreload in game.

Nothing else is needed. The Discord and Redis libraries are bundled in the jar.

Install

Each download has two jars. Use the one for your proxy:

1. Download the jars from BuiltByBit.
2. Put the jar for your proxy in the proxy's plugins folder and start the proxy. NexusShout creates its plugin folder with config.yml, discord.yml, and a locales folder.
3. Edit config.yml to your liking. See configuration.
4. Run nshoutreload in the console.

With more than one proxy, install it on every proxy. To link them, see multi-proxy.

The rest of these docs write the plugin folder as plugins/nexusshout/. On BungeeCord, read it as plugins/NexusShout/.

Signed chat

Players on Minecraft 1.19.1 and newer sign their chat. The chat prefix (!hello) and toggle mode need SignedVelocity on Velocity, or AntiPopup on BungeeCord, for those players. Commands such as /gchat <message> work without them. See signed chat.

Check that it works

Join any server and run /gchat hello. Every player on the network should see something like:

Global | SkyBlock | Alex: hello

If nothing shows up, check the console for errors from NexusShout. Setting debug: true in config.yml and running nshoutreload prints more detail.

Usage statistics

NexusShout sends anonymous usage statistics to bStats:

• a random server ID
• the player count and the number of backend servers
• whether the proxy is in online mode
• the proxy, plugin, and Java versions
• the operating system and the number of CPU cores

bStats also works out an approximate country from the IP address the data comes from. No chat messages or player names are sent. To turn it off:

• Velocity: in plugins/bStats/config.txt, set enabled=false. Keep the server-uuid line, or bStats writes the file again with enabled=true.
• BungeeCord: in plugins/bStats/config.yml, set enabled: false.

Then restart the proxy. This turns bStats off for every plugin on that proxy.

Updating

Stop the proxy, replace the jar, and start it again. Your files are kept.

• New config.yml settings are added to your file on start, with their comments.
• New message keys are added to the bundled language files.
• discord.yml is not updated for you. Compare it with the default discord.yml after an update.

Check the changelog for what changed in each version.