--- id: messages title: Messages --- # Messages Almost all 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. ## Default file The default `messages.yml` file is below. ```yaml title=/plugins/Plex/messages.yml # Plex Messages File # This file uses the MiniMessage system. # Documentation available at https://docs.adventure.kyori.net/minimessage/format.html # Messages in here will be placed in for certain commands, actions, etc. # Warning: not all commands have customizable messages # Variables {number} - these are code-defined replacements for things that should be inserted into messages. (e.g. names, statuses, numbers) # 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. # 0 - Appeal URL # 1 - Reason # 2 - Expiry # 3 - Punisher banMessage: "You have been banned! You may appeal at {0}.\nReason: {1}\nEnd date: {2}\nBanned by: {3}" # 0 - Reason # 1 - Punisher kickMessage: "You have been kicked! \nReason: {0}\nKicked by: {1}" # 0 - The type of indefinite ban # 1 - Appeal URL indefBanMessage: "Your {0} is indefinitely banned! You may appeal at {1}." # 0 - The type of indefinite ban # 1 - Appeal URL # 2 - The reason indefBanMessageReason: "Your {0} is indefinitely banned! You may appeal at {1}.\nReason: {2}" playerNotFound: "Player not found!" specifyPlayer: "You must specify a player!" worldNotFound: "World not found!" # This will always be used for punishments where the sanctioning administrator has not provided a reason. Will ignore MiniMessage tags. noReasonProvided: "No reason provided." # 0 - The world you have been teleported to playerWorldTeleport: "You have been teleported to {0}." # 0 - The person who is freezing # 1 - The person who has been frozen frozePlayer: "{0} - Froze {1}" # 0 - The person who is unfreezing # 1 - The person who has been unfrozen unfrozePlayer: "{0} - Unfroze {1}" # 0 - The command sender # 1 - The person who has been muted mutedPlayer: "{0} - Muted {1}" # 0 - The command sender # 1 - The person who has been unmuted unmutedPlayer: "{0} - Unmuted {1}" invalidTimeFormat: "Invalid time format. Use s, m, h, d, w, mo, or y (e.g., 1h30m)." timeMustBeFuture: "The specified time must be in the future." # 0 - The command sender # 1 - The person who has been muted # 2 - The time that the person is muted for tempMutedPlayer: "{0} - Muted {1} for {2}" maxTimeExceeded: "The specified time must be under a week." # 0 - The person who is locking up # 1 - The person who has been locked up lockedUpPlayer: "{0} - Locking up {1}" # 0 - The person who is unlocking # 1 - The person who has been unlocked unlockedPlayer: "{0} - Unlocking {1}" # 0 - The permission node required to use the command noPermissionNode: "You must have the permission: {0} to use this command!" noPermissionInGame: "You must be in console to use this command!" noPermissionConsole: "You must be in-game to use this command!" # 0 - The username of the name history nameHistoryTitle: "Name History of {0}" nameHistorySeparator: "-----------------------------" # 0 - The name # 1 - The date and time of the name change nameHistoryBody: "{0} - {1}" # 0 - The gamemode gameModeSetTo: "Your gamemode has been set to {0}." # 0 - The player's name # 1 - The gamemode setOtherPlayerGameModeTo: "You set {0}'s gamemode to {1}." # 0 - The command sender # 1 - The gamemode playerSetOtherGameMode: "{0} set your gamemode to {1}." # 0 - The command sender # 1 - The gamemode setEveryoneGameMode: "{0} - Changing everyone's gamemode to {1}" consoleMustDefinePlayer: "You must define a player since you are running this command from console." # 0 - The command sender # 1 - The player newAdminAdded: "{0} - Adding {1} to the admin list" # 0 - The command sender # 1 - The player # 2 - The rank name adminReadded: "{0} - Re-adding {1} to the admin list as rank: {2}" # 0 - The command sender # 1 - The player adminRemoved: "{0} - Removing {1} from the admin list" # 0 - The command sender # 1 - The player # 2 - The rank adminSetRank: "{0} - Setting {1}'s rank to {2}" # 0 - The world name teleportedToWorld: "You have been teleported to the {0}." higherRankThanYou: "This player is an admin or a higher rank than you." playerNotAdmin: "That player is not an admin." playerIsAdmin: "That player is already an admin." rankNotFound: "The rank you entered was not found." rankMustBeHigherThanAdmin: "The rank you entered must be higher than Admin." consoleOnly: "This command can only be executed by the console." # 0 - Rank yourRank: "Your rank is: {0}" # 0 - Player name # 1 - Rank otherRank: "{0}'s rank is: {1}" # 0 - The command sender # 1 - The player banningPlayer: "{0} - Banning {1}" # 0 - The command sender # 1 - The player unbanningPlayer: "{0} - Unbanning {1}" playerNotBanned: "That player is not banned!" playerNotFrozen: "That player is not frozen!" playerNotMuted: "That player is not muted!" playerBanned: "That player is already banned!" playerFrozen: "That player is already frozen!" playerMuted: "That player is already muted!" playerLockedUp: "That player is already locked up!" muted: "You are currently muted - STFU!" pvpDisabled: "PVP has been disabled!" chatIsOff: "Chat is currently toggled off!" # 0 - The command sender # 1 - The set value of the chat toggle chatToggled: "{0} - Toggled chat {1}" # 0 - The command sender # 1 - The player kickedPlayer: "{0} - Kicking {1}" teleportedToWorldSpawn: "Teleporting to the local spawn" toggleCommandSpy: "CommandSpy has been" enabled: "enabled." disabled: "disabled." # 0 - The admin / staff member # 1 - The player's group's prefix if any # 2 - The message adminChatFormat: '[AdminChat] {0} {1} ยป {2}' # 0 - Whether it was toggled on or off adminChatToggled: 'AdminChat was toggled {0}' # 0 - Maximum length, configured in config.yml maximumPrefixLength: "The maximum length for a tag may only be {0}." prefixCleared: "Your prefix has been cleared." # 0 - The player name otherPrefixCleared: "You have cleared {0}'s prefix." # 0 - The new prefix prefixSetTo: "Your prefix has been set to {0}" # 0 - The action (blocked / unblocked) # 1 - The amount of players blockeditSize: "{0} all block modification abilities for {1} players." # The action (blocked or restored) editsModified: "Your block modification abilities have been {0}." listOfPlayersBlocked: "The following have block modification abilities restricted:" # 0 - The player name editsBlocked: "Blocked block modification abilities for {0}" # 0 - The command sender # 1 - The player name blockingEdits: "{0} - Blocking block modification abilities for {1}" # 0 - The command sender # 1 - The player unblockingEdits: "{0} - Unblocking block modification abilities for {1}" # 0 - The player name editsUnblocked: "Unblocked block modification abilities for {0}" # 0 - The command sender # 1 - Number of entities removed removedEntities: "{0} - Removed {1} entities" # 0 - The command sender # 1 - Number of entities removed # 2 - Entity type(s) removed removedEntitiesOfTypes: "{0} - Removed {1} entities of type(s) {2}" # 0 - The command sender # 1 - Number of entities removed # 2 - Entity type removed removedEntitiesOfType: "Removed {1} {2}" # 0 - Entity type that is invalid invalidEntityType: "Notice: Entity type {0} is invalid!" noRemovedEntities: "No entities were removed." # 0 - Number of mobs removed # 1 - Type of mob removed amountOfMobsRemoved: "{0} {1} removed." notAValidMob: "That is not a valid mob." notAValidMobButValidEntity: "That is a valid entity, but is not a valid mob." # 0 - The command sender # 1 - Number of mobs removed removedMobs: "{0} - Removed {1} mobs" autoWipeDisabled: "Item wiping is currently disabled in the config!" # 0 - The boolean for whether the limit is enabled or disabled mobLimitToggle: "The mob limit has been {0}" # 0 - The amount that the mob limit has been set to mobLimitSet: "The mob limit has been set to: {0}" # 0 - The boolean for whether the limit is enabled or disabled # 1 - The current amount of mobs in the world # 2 - The current set mob limit # 3 - Chunk x value # 4 - Chunk z value mobLimitStatus: "({0}) {1} / {2} per chunk (Chunk: {3}, {4})" # 0 - The max set limit in config mobLimitCeiling: "The limit you have entered is too high. Defaulting to the ceiling value from config" commandBlocked: "That command is blocked." # 0 - The command sender # 1 - The message being said sayMessage: "[Server: {0}] {1}" # 0 - The command sender # 1 - The message being said consoleSayMessage: "[Console: {0}] {1}" # 0 - The number attempted to be parsed unableToParseNumber: "Unable to parse {0} as a number!" noNotes: "This player has no notes!" noteAdded: "Note added." noteNotFound: "A note with this ID could not be found." # 0 - The ID of the note removed removedNote: "Removed note with ID: {0}" # 0 - The number of notes cleared clearedNotes: "Cleared {0} notes." invalidToggle: "That is not a valid toggle." specifyLoginMessage: "Please specify a login message." # 0 - The login message setOwnLoginMessage: "Your login message is now:> {0}" # 0 - The player # 1 - The login message setOtherPlayersLoginMessage: "{0}'s login message is now:> {1}" removedOwnLoginMessage: "Your login message has been removed." # 0 - The player removedOtherLoginMessage: "You removed {0}'s login message." nameRequired: "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: "Policy requires that you must state your rank in your login message. You can do this by using %rank% in your login message." # 0 - The material name # 1 - The players who have the material in their inventory playersWithMaterial: "Players with {0} in their inventory: {1}" # 0 - The material name # 1 - The players who have the material in their inventory playersMaterialCleared: "{0} has been removed from the following players: {1}" nobodyHasThatMaterial: "No one online has that in their inventory." # 0 - The attempted material name materialNotFound: "{0} is not a valid item/block name." # 0 - The players name loginMessage: "" # 0 - The string that wasn't a valid integer notANumber: "{0} is not a valid number!" # 0 - Players currently online # 1 - Max players listHeader: "There is currently {0} player online out of {1} players." # 0 - Players currently online # 1 - Max players listHeaderPlural: "There are currently {0} players online out of {1} players." # 0 - Player who is having their notes fetched notesHeader: "Player notes for: {0}" # 0 - Note ID # 1 - Author of the note # 2 - Timestamp notePrefix: "{0} - Written by: {1} on {2}" # 0 - The content of the note noteLine: "# {0}" # 0 - The player # 1 - The number of notes logged for said player playerNoteAlert: "{0} has {1} note. Click here to view their note." # 0 - The player # 1 - The number of notes logged for said player playerNoteAlertPlural: "{0} has {1} notes. Click here to view their notes." smiteTitleHeader: "You've been smitten." # 0 - The reason for the smite. Will default to noReasonProvided if no reason is specified. # 1 - The admin / staff member smiteTitleMessage: "Be sure to follow the rules!" # 0 - The player # 1 - The reason for the smite. Will default to noReasonProvided if no reason is specified. # 2 - The admin / staff member smiteBroadcast: "{0} has been a naughty, naughty boy. - Reason: {1} - Smitten by: {2}" # 0 - The player smittenQuietly: "Smitten {0} quietly." # 0 - The reason for being smitten smitten: "You've been smitten. Reason: {0}" nukerKickMessage: "Please turn off your nuker!" antiSpamMessage: "Please refrain from spamming messages." # 0 - The player banExpiredBroadcast: "Plex - Automatically unbanning {0}" # 0 - The player redisResetSuccessful: "Successfuly reset {0}'s Redis punishments!" redisResetPlayerNotFound: "Couldn't find player in Redis punishments." reappliedGamerules: "All game rules have been re-applied!" commandNotFound: "That command could not be found!" # 0 - The command # 1 - A list of aliases found commandAliases: "Aliases for {0} are: {1}" ``` ## MiniMessage The `messages.yml` file uses MiniMessage for coloring messages. For example, writing ``, will color the text aqua. This is not like HTML, and you should not close the tag (``). There are some special functions as well, such as ``. The default color will be gray. For a complete guide on using MiniMessage, visit: [https://docs.advntr.dev/minimessage/format.html](https://docs.advntr.dev/minimessage/format.html). ## Troubleshooting 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.