Skip to content

light-devteam/closed-lightChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 

Repository files navigation

lightChat - Simple, convenient and functional minecraft chat.

Поддержка завершена. Плагин не имеет смысла. Все, что здесь есть и что планировалось сделать, уже есть в Chatty и реализовано более эффективно. Спасибо.

Плюсом к этому у автора руки из жопы и он не знает Java

Если Вам все же интересно, то описание чуть ниже.











Functional:

[1] Global Chat
[2] Local Chat
[3] World Chat
[4] Private Chat
[5] Player Mentions
[6] Custom join and quit messages
[7] JSON formatting

Global Chat - Messages are visible to all players on the server.
Local Chat - Messages are visible to all players within a specified number of blocks from the message sender.
World Chat - Messages are visible to players who are in the same dimension as the message sender.
Private Chat - Personal correspondence of two players.
Player Mentions - Highlighting the nickname of the mentioned player in the chat (only for him // for everyone), accompanied by a sound notification and text above the hot bar for the mentioned player.
Custom ... messages - Customizable player join and quit messages.
JSON formatting - Ability to insert JSON formatting into strings.

Requirements

  • SpigotMC 1.18.1 - Kernel.
  • Vault (optional) - Plugin.

Placeholders and Text formatting

Some of the lines have comments (# comment) above them indicating supported placeholders or other notes and possible values.

Placeholder Description
{message} Message sent by the player or config message.
{sender} Message sender nickname.
{senderPrefix} Message sender prefix.
‼️ Requires Vault.
{senderSuffix} Message sender suffix.
‼️ Requires Vault.
{recipient} Message recipient nickname.
{recipientPrefix} Message recipient prefix.
‼️ Requires Vault.
{recipientSuffix} Message recipient suffix.
‼️ Requires Vault.
{mentioned} Nickname of the mentioned player.
{mentionedPrefix} Prefix of the mentioned player.
‼️ Requires Vault.
{mentionedSuffix} Suffix of the mentioned player.
‼️ Requires Vault.
{player} The nickname of the player the event is associated with.
{playerPrefix} The prefix of the player the event is associated with.
‼️ Requires Vault.
{playerSuffix} The suffix of the player the event is associated with.
‼️ Requires Vault.
{globalChatPrefix} Global chat anchor symbol.
{localChatPrefix} Local chat anchor symbol.
{worldChatPrefix} World chat anchor symbol.
placeholder Without { and }. The key placeholder on which all others depend

Hereinafter, all placeholders will be framed like this: { and }, however, you can change this in the config.

They will also be described below.

By default in the config & (You can change this sign in the config) is replaced by §. Text can be formatted in the same way as regular text in minecraft.

Config setup

Сonfig

String Description Placeholders
placeholder Specifies how the placeholder should look like.
  • placeholder
DO NOT USE {placeholder} HERE. placeholder ONLY!
formatSymbol Specifies how the formatting mark should look like. Default &

Chats.globalChat, Chats.localChat, Chats.worldChat:

String Description Placeholders
enable Sets the chat mode. true - enabled, any other - disabled.
prefix Anchor symbol that determines the chat in which the player writes.
format General view of the message with placeholders.
  • {sender}
  • {senderPrefix}
  • {senderSuffix}
  • {message}
messageColor Message color.
ping Sets whether player mentions are enabled in this chat. true - enabled, any other - disabled.
chatDistantion The radius of the circle centered at the position of the player who sent the message, inside which the players will see the message sent to them.
Only for localChat.
prefixError Error text with placeholders that the player will see if they enter a non-existent prefix.
  • {sender}
  • {senderPrefix}
  • {senderSuffix}
  • {message}
  • {globalChatPrefix}
  • {localChatPrefix}
  • {worldChatPrefix}
noPerms The message that the sender of the message will see if they do not have the right to write to this chat.
Leave blank to disable.
  • {sender}
noPermsPing The message that the sender of the message with mention will see if they do not have permission to mention players.
Leave blank to disable.
  • {sender}

Ping:

String Description Placeholders
inFormat Mention input format. Mention will be determined by it. Must contain {mentioned} placeholder.
outFormat The output format of the mention with placeholders that will be displayed in the message instead of the input format.
  • {mentioned}
  • {mentionedPrefix}
  • {mentionedSuffix}
marker A special mention format for the mentioned player.
Leave blank to disable.
  • {mentioned}
  • {mentionedPrefix}
  • {mentionedSuffix}
message The message that the mentioned player will see above the hotbar if he is mentioned.
Leave blank to disable.
myself The message the player will see if they try to mention themselves.
Leave blank to disable.
sound.sound The sound the player will hear if mentioned.
Leave blank to turn off audio playback.
sound.volume The volume of the corresponding sound. The maximum value is 1, but more is possible. It will be heard the same at the playback point, but the more, the better it will be heard at a greater distance from the playback point. For example: 1 - weakly audible at a distance of 15 blocks, 10 - well audible even at a distance of 150 blocks.
sound.pitch Audio playback speed. 1 - normal. Less is slower, more is faster.

Private

String Description Placeholders
commands Commands for sending private messages. List them with commas.
Leave blank to disable private chats.
senderFormat The format of the message that the sender sees.
Leave blank to prevent the sender from seeing his message
  • {sender}
  • {recipient}
  • {recipientPrefix}
  • {recipientSuffix}
  • {message}
recipientFormat The format of the message that the recipient sees.
  • {recipient}
  • {sender}
  • {senderPrefix}
  • {senderSuffix}
  • {message}
message The message that the recipient of the message will see above the hotbar.
Leave blank to disable.
  • {sender}
  • {senderPrefix}
  • {senderSuffix}
myself The message that the player will see if they try to send a message to themselves.
Leave blank to disable.
  • {message}
error The message that the player will see if they fail to send a message to the specified player.
  • {recipient}
noPerms The message that the player will see if they do not have the right to send private messages.
sound.recipientSound The sound that the recipient of the message will hear.
Leave blank to disable.
sound.senderSound The sound that the sender of the message will hear.
Leave blank to disable.
sound.volume The volume of both sounds. The maximum value is 1, but more is possible. It will be heard the same at the playback point, but the more, the better it will be heard at a greater distance from the playback point. For example: 1 - weakly audible at a distance of 15 blocks, 10 - well audible even at a distance of 150 blocks.
sound.pitch The playback speed of both sounds. 1 - normal. Less is slower, more is faster.

Messages

↕️ - Items marked with this sign can have multiple lines. Each must be written on a new line, starting with "-".
For example:

 - 'message1'
 - 'message2'
 - 'message3'
 - 'message4'
 - 'message5'

Of all the entries, a random one will be chosen.

String Description Placeholders
join.format The format of the join message.
Leave blank to disable.
  • {message} - Server login message.
join.first Message when a player first joins the server. ↕️
  • {player}
  • {playerPrefix}
  • {playerSuffix}
join.main Message when a player joins the server. ↕️
  • {player}
  • {playerPrefix}
  • {playerSuffix}
join.nickname Where nickname is the nickname of the entered player. One of these messages will be displayed when a player with the nickname nickname logs in. There can be any number of such structures. ↕️
  • {player}
  • {playerPrefix}
  • {playerSuffix}
quit.format The format of the quit message.
Leave blank to disable.
  • {message} - Server logout message.
quit.main Message when a player quits the server. ↕️
  • {player}
  • {playerPrefix}
  • {playerSuffix}
quit.nickname Where nickname is the nickname of the entered player. One of these messages will be displayed when a player with the nickname nickname logs out. There can be any number of such structures. ↕️
  • {player}
  • {playerPrefix}
  • {playerSuffix}

Reload

String Description Placeholders
success The message that the sender of the command will see when the config is successfully reloaded.
Leave blank to disable.
  • {sender}
noPerms The message that the sender of the command will see if they do not have permission to use the command.
Leave blank to disable.
  • {sender}
error The message that the sender of the command will see if an error occurs while reloading the config.
Leave blank to disable.

JSON formatting

  • With JSON support, you can create interactive text in a message. If you are embedding JSON in plain text, then you need to highlight it like this: {json <json> }.
  • Where <json> is your json insert. Note that spaces are required after {json and before }. There may be more than one, but not less.
  • If there is an error in the text color, it will be replaced with the standard one. If there is an error in the action inside hoverEvent, then hoverEvent will not work. If there is another error in your JSON insert, then the insert will not be applied.
  • JSON inserts allow you to use hex codes to set the text color. To do this, use the &{<color>} construct, where <color> is any color supported by JSON.
  • The standard Minecraft formatting hasn't gone away and you can still use it. Moreover, JSON formatting has been set to standard. If you specify a color in the first JSON insert, but not specify in the one after it, then it will become the same as in the first one, and so on. This works not only with color, but also with underlined, strikethrough, italic, bold and obfuscated text.
  • In lines, line wrapping also works. To break a line, use the \n construct. If you want to insert the \n construct into your text without breaking the line, then use the \\n construct. More on this in the next paragraph.
  • The \ character cancels the formatting. For example, \&3text will return &3text instead of colored text. Here are all possible cancellations:
    • \&0 \&1 \&2 \&3 \&4 \&5 \&6 \&7 \&8 \&9 \&a \&b \&c \&d \&e \&f \&k \&l \&m \&n \&o \&r
    • \&{<color>}
    • \{json <json> }
    • \\n

Where { and } are characters that be before and after the placeholder in the config.placeholder configuration and & is character that be in the config.formatSymbol configuration.

If you don't specify anything in place of <color> or <json>, no formatting will be applied. It will also not apply if you insert invalid JSON instead of <json>. More about JSON

Preset Commands

Command Aliases Description
/lightchat <reload> lc, lightc, lchat Plugin configuration command.

Arguments:
  • reload - config reload

Permissions

  • lc.chat.<Chat>.write - Allows owner of the right to send <Chat> messages.
  • lc.chat.<Chat>.see - Allows owner of the right to receive <Chat> messages.
  • lc.chat.<Chat>.mention - Allows owner of the right to mention people in the <Chat>. The right does not apply to private chat.
  • lc.reload - Gives the right to reload the config.

Chats (What can be replaced by <Chats>): Global, Local, World, Private.

Useful links