Website/docs/customization/messages.md

217 lines
9.9 KiB
Markdown
Raw Normal View History

2022-02-01 05:49:02 +00:00
---
id: messages
title: Messages
---
2022-05-17 04:30:12 +00:00
# Messages
2022-02-01 05:49:02 +00:00
Almost all of the messages inside of Plex are fully customizable. This page will document how to change messages in the ```messages.yml``` file inside the Plex folder.
2022-02-04 22:26:27 +00:00
## Default file
2022-02-02 02:15:26 +00:00
The default `messages.yml` file is below.
2022-03-03 23:55:03 +00:00
```yaml title=/plugins/Plex/messages.yml
2022-03-03 23:52:55 +00:00
# Plex Messages File
2022-02-28 04:04:20 +00:00
# This file uses the MiniMessage system.
# Documentation available at https://docs.adventure.kyori.net/minimessage/format.html
2022-02-02 02:15:26 +00:00
2022-02-22 07:43:56 +00:00
# Messages in here will be placed in for certain commands, actions, etc.
# Warning: not all commands have customizable messages
2022-04-09 05:16:24 +00:00
# Variables {number} - these are code-defined replacements for things that should be inserted into messages. (e.g. names, statuses, numbers)
2022-02-28 04:04:20 +00:00
# If any of these variables are supposed to be used within a message, some documentation is provided to give more context to what the variables indicate.
# If you are wishing to change these messages it's recommended you use the same amount of variables as stated in the documentation, however it's not required.
2022-02-02 02:15:26 +00:00
2022-04-09 05:16:24 +00:00
# 0 - Appeal URL
# 1 - Reason
# 2 - Expiry
# 3 - Punisher
banMessage: "<red>You have been banned! You may appeal at <gold>{0}.\n<red>Reason: <gold>{1}\n<red>End date: <gold>{2}\n<red>Banned by: <gold>{3}"
# 0 - The type of indefinite ban
# 1 - Appeal URL
indefBanMessage: "<red>Your {0} is indefinitely banned! You may appeal at <gold>{1}."
2022-03-06 05:13:39 +00:00
playerNotFound: "<red>Player not found!"
2023-07-23 04:36:21 +00:00
specifyPlayer: "<red>You must specify a player!"
2022-03-06 05:13:39 +00:00
worldNotFound: "<red>World not found!"
2022-04-09 05:16:24 +00:00
# 0 - The world you have been teleported to
playerWorldTeleport: "<aqua>You have been teleported to {0}."
# 0 - The sender who opped everyone
oppedAllPlayers: "<aqua>{0} - Opped all players on the server"
# 0 - The sender who de-opped everyone
deoppedAllPlayers: "<aqua>{0} - De-opped all players on the server"
# 0 - The person who is opping
# 1 - The person who has been opped
oppedPlayer: "<aqua>{0} - Opped {1}"
# 0 - The person who is deopped
# 1 - The person who has been deopped
deoppedPlayer: "<red>{0} - Deopped {1}"
# 0 - The person who is freezing
# 1 - The person who has been frozen
frozePlayer: "<red>{0} - Froze {1}"
# 0 - The person who is unfreezing
# 1 - The person who has been unfrozen
unfrozePlayer: "<aqua>{0} - Unfroze {1}"
# 0 - The command sender
# 1 - The person who has been muted
mutedPlayer: "<red>{0} - Muted {1}"
# 0 - The command sender
# 1 - The person who has been unmuted
unmutedPlayer: "<aqua>{0} - Unmuted {1}"
# 0 - The person who is locking up
# 1 - The person who has been locked up
lockedUpPlayer: "<aqua>{0} - Locking up {1}"
# 0 - The person who is unlocking
# 1 - The person who has been unlocked
unlockedPlayer: "<aqua>{0} - Unlocking {1}"
# 0 - The rank required to use the command
noPermissionRank: "<red>You must be at least {0} <red>to use this command!"
# 0 - The permission node required to use the command
noPermissionNode: "<red>You must have the permission: {0} <red>to use this command!"
2022-02-28 04:04:20 +00:00
noPermissionInGame: "<red>You must be in console to use this command!"
noPermissionConsole: "<red>You must be in-game to use this command!"
2022-04-09 05:16:24 +00:00
# 0 - The username of the name history
nameHistoryTitle: "<gold>Name History of {0}"
2022-03-06 05:13:39 +00:00
nameHistorySeparator: "<gold><strikethrough>-----------------------------"
2022-04-09 05:16:24 +00:00
# 0 - The name
# 1 - The date and time of the name change
nameHistoryBody: "<gold>{0} <dark_gray>- <gold>{1}"
# 0 - The gamemode
gameModeSetTo: "<gray>Your gamemode has been set to {0}."
# 0 - The player's name
# 1 - The gamemode
setOtherPlayerGameModeTo: "<gray>You set {0}'s gamemode to {1}."
# 0 - The command sender
# 1 - The gamemode
playerSetOtherGameMode: "<gray>{0} set your gamemode to {1}."
# 0 - The command sender
# 1 - The gamemode
setEveryoneGameMode: "<aqua>{0} - Changing everyone's gamemode to {1}"
2022-03-06 05:13:39 +00:00
consoleMustDefinePlayer: "<red>You must define a player since you are running this command from console."
2022-04-09 05:16:24 +00:00
# 0 - The command sender
# 1 - The player
newAdminAdded: "<aqua>{0} - Adding {1} to the admin list"
# 0 - The command sender
# 1 - The player
# 2 - The rank name
adminReadded: "<aqua>{0} - Re-adding {1} to the admin list as rank: {2}"
# 0 - The command sender
# 1 - The player
adminRemoved: "<red>{0} - Removing {1} from the admin list"
# 0 - The command sender
# 1 - The player
# 2 - The rank
adminSetRank: "<aqua>{0} - Setting {1}'s rank to {2}"
# 0 - The world name
teleportedToWorld: "<aqua>You have been teleported to the {0}."
higherRankThanYou: "<red>This player is an admin or a higher rank than you."
2022-02-28 04:04:20 +00:00
playerNotAdmin: "<red>That player is not an admin."
playerIsAdmin: "<red>That player is already an admin."
rankNotFound: "<red>The rank you entered was not found."
rankMustBeHigherThanAdmin: "<red>The rank you entered must be higher than Admin."
consoleOnly: "<red>This command can only be executed by the console."
2022-04-09 05:16:24 +00:00
# 0 - Rank
yourRank: "<aqua>Your rank is: {0}"
# 0 - Player name
# 1 - Rank
otherRank: "<aqua>{0}'s rank is: {1}"
# 0 - The command sender
# 1 - The player
banningPlayer: "<red>{0} - Banning {1}"
# 0 - The command sender
# 1 - The player
unbanningPlayer: "<aqua>{0} - Unbanning {1}"
2022-02-28 04:04:20 +00:00
playerNotBanned: "<red>That player is not banned!"
playerNotFrozen: "<red>That player is not frozen!"
playerNotMuted: "<red>That player is not muted!"
playerBanned: "<red>That player is already banned!"
playerFrozen: "<red>That player is already frozen!"
playerMuted: "<red>That player is already muted!"
2022-03-03 23:52:55 +00:00
playerLockedUp: "<red>That player is already locked up!"
2022-02-28 04:04:20 +00:00
muted: "<red>You are currently muted - STFU!"
2022-04-09 05:16:24 +00:00
# 0 - The command sender
# 1 - The player
kickedPlayer: "<red>{0} - Kicking {1}"
2022-02-28 04:04:20 +00:00
teleportedToWorldSpawn: "<aqua>Teleporting to the local spawn"
2022-03-06 05:13:39 +00:00
toggleCommandSpy: "<gray>CommandSpy has been"
enabled: "<gray>enabled."
disabled: "<gray>disabled."
2022-04-09 05:16:24 +00:00
# 0 - The admin / staff member
# 1 - The message
adminChatFormat: '<dark_gray>[<blue>AdminChat<dark_gray>] <dark_red>{0} <gray>» <gold>{1}'
2023-07-23 04:36:21 +00:00
# 0 - Whether it was toggled on or off
adminChatToggled: '<gray>AdminChat was toggled {0}'
2022-04-09 05:16:24 +00:00
# 0 - Maximum length, configured in config.yml
maximumPrefixLength: "<red>The maximum length for a tag may only be {0}."
2022-02-28 04:04:20 +00:00
prefixCleared: "<aqua>Your prefix has been cleared."
2022-04-09 05:16:24 +00:00
# 0 - The player name
otherPrefixCleared: "<aqua>You have cleared {0}'s prefix."
# 0 - The new prefix
prefixSetTo: "<aqua>Your prefix has been set to {0}"
2022-05-29 03:47:21 +00:00
# 0 - The action (blocked / unblocked)
# 1 - The amount of players
blockeditSize: "<gray>{0} all block modification abilities for {1} players."
# The action (blocked or restored)
editsModified: "<gray>Your block modification abilities have been {0}."
listOfPlayersBlocked: "<gray>The following have block modification abilities restricted:"
# 0 - The player name
editsBlocked: "<gray>Blocked block modification abilities for {0}"
2022-04-09 05:16:24 +00:00
# 0 - The command sender
# 1 - The player name
2022-05-29 03:47:21 +00:00
blockingEdits: "<red>{0} - Blocking block modification abilities for {1}"
2022-04-09 05:16:24 +00:00
# 0 - The command sender
2022-05-29 03:47:21 +00:00
# 1 - The player
unblockingEdits: "<aqua>{0} - Unblocking block modification abilities for {1}"
2022-04-09 05:16:24 +00:00
# 0 - The player name
editsUnblocked: "<gray>Unblocked block modification abilities for {0}"
# 0 - The command sender
# 1 - Number of entities removed
removedEntities: "<red>{0} - Removed {1} entities"
# 0 - The command sender
# 1 - Number of entities removed
# 2 - Entity type(s) removed
removedEntitiesOfTypes: "<red>{0} - Removed {1} entities of type(s) {2}"
# 0 - The command sender
# 1 - Number of entities removed
# 2 - Entity type removed
removedEntitiesOfType: "<gray>Removed {1} {2}"
# 0 - Entity type that is invalid
invalidEntityType: "<gray>Notice: Entity type {0} is invalid!"
noRemovedEntities: "<gray>No entities were removed."
# 0 - The command sender
# 1 - Number of mobs removed
removedMobs: "<red>{0} - Removed {1} mobs"
autoWipeDisabled: "<gray>Item wiping is currently disabled in the config!"
2022-04-21 02:57:53 +00:00
commandBlocked: "<gray>That command is blocked."
# 0 - The command sender
# 1 - The message being said
sayMessage: "<blue>[Server: {0}] {1}"
# 0 - The command sender
# 1 - The message being said
consoleSayMessage: "<gray>[Console: {0}] <white>{1}"
# 0 - The number attempted to be parsed
unableToParseNumber: "<red>Unable to parse {0} as a number!"
2022-05-29 03:47:21 +00:00
noNotes: "<red>This player has no notes!"
noteAdded: "<green>Note added."
noteNotFound: "<red>A note with this ID could not be found."
# 0 - The ID of the note removed
removedNote: "<green>Removed note with ID: {0}"
# 0 - The number of notes cleared
clearedNotes: "<green>Cleared {0} notes."
invalidToggle: "<red>That is not a valid toggle."
2023-07-23 04:36:21 +00:00
specifyLoginMessage: "<red>Please specify a login message."
# 0 - The login message
setOwnLoginMessage: "<gray>Your login message is now:<newline><gray>> <reset>{0}"
# 0 - The player
# 1 - The login message
setOtherPlayersLoginMessage: "<gray>{0}'s login message is now:<newline><gray>> <reset>{1}"
removedOwnLoginMessage: "<gray>Your login message has been removed."
# 0 - The player
removedOtherLoginMessage: "<gray>You removed {0}'s login message."
nameRequired: "<red>Policy requires that you must state your player name in your login message. You can either do this by inserting your name or %player%."
rankRequired: "<red>Policy requires that you must state your rank in your login message. You can do this by using %rank% in your login message."
2022-02-02 02:15:26 +00:00
```
2022-02-28 04:04:20 +00:00
## MiniMessage
The `messages.yml` file uses MiniMessage for coloring messages. For example, writing `<aqua>`, will color the text aqua. This is not like HTML, and you should not close the tag (`</aqua>`). There are some special functions as well, such as `<rainbow>`. The default color will be gray. For a complete guide on using MiniMessage, visit: [https://docs.adventure.kyori.net/minimessage/format.html](https://docs.adventure.kyori.net/minimessage/format.html).
2022-02-04 22:26:27 +00:00
## Troubleshooting
2022-05-17 04:30:12 +00:00
If you receive `No message.` when executing a command, it is likely you need to regenerate your `messages.yml` file. The default configuration file is also available on [GitHub](https://raw.githubusercontent.com/PlexDevelopment/Plex/master/src/main/resources/messages.yml). As of Plex 0.6 (Beta 6), your `messages.yml` file should automatically update with new entries.