Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 3.45 KB

README.md

File metadata and controls

89 lines (68 loc) · 3.45 KB

Downloads Java CI Codacy Badge Lines of Code

MikChanの Chat

A minimalistic chat plugin.

Supported Versions

Spigot/Paper/Bukkit 1.16.5+

Features

Global/Local/Private Messages

The plugin adds support of 3 types of messages: Global, Local and Private.

  • Global messages are visible to all players on the server.
  • Local messages are only visible to players within the certain radius from the sender.
  • Private messages are only visible to the specific player the sender specified.

If needed, local messages can be disabled by setting

enableLocal: false

If local messages are enabled, all messages by default become local messages. To send a global message, the text of the message has to start with specific prefix. By default it's !. E.g.

> Hello World!
[Local] Hello World!

> !Hello World!
[Global] Hello World!

To change the prefix for global messages, you need to change this setting

globalPrefix: "!"

To send a private message, you should use the command

/msg MikChan Hello, MikChan!

Also you can use this command to reply back to the last person who sent a message to you

/r Hello Back!

Formatting

The plugin also lets you change how messages look like by modifying these settings.

globalTemplate: '<:player:> :message:'
localTemplate: '<:player:> :message:'
privateTemplate: '<:player_from: to :player_to:> :message:'
consoleTemplate: '<CONSOLE to :player_to:> :message:'

As you can notice, there are some unusual looking placeholders.

  • :player: is replaced with the senders name.
  • :player_from: is replaced with the senders name. Works only in privateTemplate.
  • :player_to: is replaced with the recipients name. Works only in privateTemplate and consoleTemplate.
  • :message: is replaced with the text of the message.

If you wonder why consoleTemplate is needed: the private messages can be sent from the console, but since console has no username, it has to be formatted separately.

Placeholder API (PAPI)

This plugin supports PAPI placeholders. There are PAPI specific settings in the config.

playerTemplate: '%player_name%'
fromTemplate: '%player_name%'
toTemplate: '%player_name%'

If PAPI is present

  • :player: will be replaced with playerTemplate.
  • :player_from: will be replaced with fromTemplate.
  • :player_to: will be replaced with toTemplate.

If PAPI is not present in the plugin list, these settings will be simply ignored.

Support the creator

"Buy Me A Coffee"

Stats

bStats