Skip to content

RagingTech/NetworkJoinMessages

Repository files navigation

NetworkJoinMessages

GitHub release (latest by date) zlib license GitHub downloads SpigotMC downloads

A modern continuation of BungeeJoinMessages, this plugin handles customizable join, leave, and server-swap messages across proxy servers like BungeeCord and Velocity.

Features

Installation

  1. Download the latest release from SpigotMC
  2. Place the JAR file in the plugins directory of your proxy server
  3. Restart the proxy to generate the default configuration
  4. Edit the config.yml file in the plugin's directory to your liking following changes with /njoinreload
  5. Optionally, configure Discord messages in the discord.yml file also following changes with /njoinreload

Note

If you want the vanilla join/leave messages to go away, you can remove them with EssentialsX, or use this basic plugin.

Placeholders

Buit-in placeholders are described below. As mentioned before, PlaceholderAPI placeholders are supported given the PAPIProxyBridge plugin is on the proxy and backend servers. MiniPlaceholders are also supported given the MiniPlaceholders plugin is on the proxy.

Any of the three message types:

  • %player% Player username
  • %displayname% Custom name the player has according to the proxy
  • %player_prefix% Player prefix (requires LuckPerms on the proxy)
  • %player_suffix% Player suffix (requires LuckPerms on the proxy)

Swap server message:

  • %to% The server they are going to
  • %to_clean% ^ Same, but with color codes removed.
  • %from% The server they are coming from
  • %from_clean% ^ Same, but with color codes removed.
  • %playercount_to% The amount of players on the server they going to.
  • %playercount_from% The amount of players on the server they are coming from.
  • %playercount_network% The amount of players on the network.

Join & leave network messages:

  • %server_name% The name of the server they joined to or was last on when they left.
  • %server_name_clean% ^ Same, but with color codes removed.
  • %playercount_server% The amount of players on the server they connected to, or was last on when they left.
  • %playercount_network% The amount of players on their network.

Tip

Remember that the command /njoinreload can be used to reload the messages without having to restart the server. Requires the networkjoinmessages.reload permission.

Permissions

Permission Description
networkjoinmessages.silent No message is displayed on join, leave or swap for the holder. This permission is meant for those who often join while vanished.
networkjoinmessages.spoof Allows the use of the /njoinspoof command. The command will display a fake join/leave/swap message, based on the arguments given.
networkjoinmessages.reload Allows you to reload the configuration file with the /njoinreload command.
networkjoinmessages.toggle Allows the usage of the /njointoggle command, that lets users choose not to receive certain messages just for them.
networkjoinmessages.import Allows importing users from backend servers' usercache.json files with the /njoinimport command.

Commands

Required arguments are enclosed with angle brackets (i.e. <this>) and optional arguments are enclosed with square brackets (i.e. [this]). An ellipsis (...) indicates an argument can be specified several times separated by spaces.

Command Description
/njoinspoof <join | leave | swap | toggle> [<from> <to>] Displays a fake message using the issuer as the trigger player.
/njoinreload Reloads the configuration.
/njointoggle <all | join | leave | swap> <on | off> Toggles the issuers receiving of specific messages.
/njoinimport <pathtousercache.json> [pathtousercache.json...] Imports user's from backend servers' usercache.json files into the joined database so that they will not trigger first join messages. Useful for adding this plugin and using first join messages on an already running network.

Contributing

Contributions are encouraged!

  • Open issues for bug reports or suggestions
  • Submit pull requests for new features or fixes

License

Licensed under zlib License by the original author Tirco. You are free to use, modify, and redistribute this plugin, as long as credit is retained.

Support

  • Open an issue for bugs or feature requests
  • Join the discord server for help

About

A plugin handling join, leave and swap messages for proxy servers

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages