mirror of
https://github.com/plexusorg/Website.git
synced 2025-07-01 07:36:42 +00:00
Revamp website with new Docusaurus version
This commit is contained in:
85
docs/customization/commandblocker.md
Normal file
85
docs/customization/commandblocker.md
Normal file
@ -0,0 +1,85 @@
|
||||
---
|
||||
id: commandblocker
|
||||
title: Command Blocker
|
||||
---
|
||||
|
||||
# Command Blocker
|
||||
Plex features an advanced command blocker with support for matching and RegEx statements. It is recommended that you use this only in conjunction with ranks. If you are using permissions, there is not as much of a need for a command blocker.
|
||||
|
||||
## Default file
|
||||
The default `commands.yml` file is below.
|
||||
|
||||
```yaml title=/plugins/Plex/commands.yml
|
||||
#
|
||||
# Command Blocker
|
||||
#
|
||||
# Format:
|
||||
# - "<regex or match>:<rank>:command name no slash:Block message"
|
||||
#
|
||||
# Symbols to use:
|
||||
# - r for RegEx
|
||||
# - m for matching
|
||||
# - The ranks are "e" for everyone, "s" for senior admin, and "a" for admin
|
||||
# - MATCHING MODE: The command is just the command without slashes. Optional arguments are specified as well. It also accepts full plugins via specifying the plugin name followed by a ":" (e.g. "viaversion:")
|
||||
# - REGEX MODE: The command is regex that matches the desired command. It matches case insensitively.
|
||||
# - Finally the block message MUST NOT CONTAIN ":". Use _ to use the default command blocked message as specified in messages.yml, or you can optionally put your own in
|
||||
#
|
||||
# So these would be valid:
|
||||
# - "m:e:mail sendall:You cannot send messages to everyone on the server"
|
||||
# - "r:e:^[A-z]*:[A-z]*::Plugin specific commands are disabled"
|
||||
commands:
|
||||
- "m:a:break:_"
|
||||
- "m:a:delchunks:_"
|
||||
- "m:a:kickall:_"
|
||||
- "m:a:locatebiome:_"
|
||||
- "m:a:playsound:_"
|
||||
- "m:a:setspawn:_"
|
||||
- "m:a:socialspy:_"
|
||||
- "m:a:tpall:_"
|
||||
- "m:e:/eval:_"
|
||||
- "m:e:advancement:_"
|
||||
- "m:e:antioch:_"
|
||||
- "m:e:backup:_"
|
||||
- "m:e:ban-ip:_"
|
||||
- "m:e:co purge:_"
|
||||
- "m:e:d minecart_command:_"
|
||||
- "m:e:debug:_"
|
||||
- "m:e:defaultgamemode:<gray>The default gamemode should not be changed."
|
||||
- "m:e:deljail:_"
|
||||
- "m:e:disguiseradius:_"
|
||||
- "m:e:fill:_"
|
||||
- "m:e:jails:_"
|
||||
- "m:e:mail sendall:<red>You cannot send messages to everyone on the server."
|
||||
- "m:e:mail sendtempall:<red>You cannot send messages to everyone on the server."
|
||||
- "m:e:paper:_"
|
||||
- "m:e:pardon-ip:_"
|
||||
- "m:e:pardon:_"
|
||||
- "m:e:save-off:_"
|
||||
- "m:e:save-on:_"
|
||||
- "m:e:setjail:_"
|
||||
- "m:e:spigot reload:_"
|
||||
- "m:e:time:<gray>Server-side time changing is disabled. Please use /ptime to set your own personal time."
|
||||
- "m:e:togglejail:_"
|
||||
- "m:e:undisguiseradius:_"
|
||||
- "m:e:weather:_"
|
||||
- "m:e:worldborder:<gray>The worldborder does not need to be changed. This command is disabled."
|
||||
- "r:a:^(co|core|coreprotect) (rb|rollback|l|lookup|rl|reload):_"
|
||||
- "r:e:^[A-z]*:[A-z]*::<gray>Plugin specific commands are disabled."
|
||||
|
||||
# These commands will be blocked when a player is muted
|
||||
block_on_mute:
|
||||
- me
|
||||
- say
|
||||
- msg
|
||||
- reply
|
||||
- mail
|
||||
```
|
||||
|
||||
## The symbols
|
||||
- `r` represents RegEx and `m` represents matching.
|
||||
- The ranks are `e` to block for everyone, `a` to block for admins and above, and `s` to block for senior admins and above.
|
||||
|
||||
## The format
|
||||
An example formatted entry in the `commands.yml` file would look like this:
|
||||
`"m:e:mail sendall:You cannot send messages to everyone on the server"`
|
||||
The `m` will match the `mail sendall` command. The `e` stands for everyone, so it will block this command for everyone. The last part is the message. If you use `_` as the blocked message, it will use the default message specified in `messages.yml`
|
||||
417
docs/customization/config.md
Normal file
417
docs/customization/config.md
Normal file
@ -0,0 +1,417 @@
|
||||
---
|
||||
id: config
|
||||
title: Configuration
|
||||
---
|
||||
|
||||
# Config
|
||||
This page will show you how to modify the configuration file. The configuration file is located at: ```/plugins/Plex/config.yml```.
|
||||
|
||||
## Default configuration
|
||||
Below is the default `config.yml` file when Plex is loaded for the first time.
|
||||
```yaml title=/plugins/Plex/config.yml
|
||||
# Plex Configuration File
|
||||
# For documentation, please visit: https://plex.us.org
|
||||
|
||||
server:
|
||||
name: "Plexus"
|
||||
motd: "%servername% - Minecraft %mcversion%"
|
||||
colorize_motd: true
|
||||
sample:
|
||||
- "&cForums: https://forum.plex.us.org"
|
||||
# What timezone should various messages appear in (e.g. ban message end date)
|
||||
timezone: Etc/UTC
|
||||
|
||||
# Ban message is customized in the messages.yml file. The URL to appeal at is below.
|
||||
banning:
|
||||
ban_url: "https://forum.plex.us.org"
|
||||
|
||||
punishments:
|
||||
mute-timer: 300
|
||||
freeze-timer: 300
|
||||
|
||||
chat:
|
||||
# Should the server use Plex's chat system? It is recommended to keep this on if you are using ranks.
|
||||
# If you are using permissions, you should turn this off and use Vault to handle prefixes with a different chat plugin
|
||||
enabled: true
|
||||
# The maximum amount of characters a player can have for their tag
|
||||
# This does not include color tags such as <red> or <rainbow>
|
||||
max-tag-length: 64
|
||||
# Color tag for name color
|
||||
name-color: '<white>'
|
||||
|
||||
# You can define colors for each group which will appear in the tab list
|
||||
colors:
|
||||
admin: '<aqua>'
|
||||
senior: '<light_purple>'
|
||||
executive: '<blue>'
|
||||
masterbuilder: '<dark_aqua>'
|
||||
|
||||
# Login Messages
|
||||
loginmessages:
|
||||
# Should the player be required to put their name in the login message?
|
||||
name: true
|
||||
|
||||
data:
|
||||
central:
|
||||
storage: sqlite # Use mariadb, or sqlite here
|
||||
user: ""
|
||||
password: ""
|
||||
hostname: 127.0.0.1
|
||||
port: 27017
|
||||
db: "plex"
|
||||
side: # This is Redis, leave password blank if auth is false
|
||||
enabled: false
|
||||
auth: true
|
||||
hostname: 127.0.0.1
|
||||
port: 6379
|
||||
password: ""
|
||||
|
||||
# Mob limiter / Entity wiping config
|
||||
# All entities listed here will NOT be wiped upon wiping entities
|
||||
# By default this includes all mobs, as the mobpurge command can be used to purge mobs.
|
||||
entitywipe_list:
|
||||
- "ITEM_FRAME"
|
||||
- "AXOLOTL"
|
||||
- "BAT"
|
||||
- "BEE"
|
||||
- "BLAZE"
|
||||
- "CAT"
|
||||
- "CAVE_SPIDER"
|
||||
- "CHICKEN"
|
||||
- "COD"
|
||||
- "COW"
|
||||
- "CREEPER"
|
||||
- "DOLPHIN"
|
||||
- "DONKEY"
|
||||
- "DROWNED"
|
||||
- "ELDER_GUARDIAN"
|
||||
- "ENDER_DRAGON"
|
||||
- "ENDERMAN"
|
||||
- "ENDERMITE"
|
||||
- "EVOKER"
|
||||
- "FOX"
|
||||
- "GHAST"
|
||||
- "GIANT"
|
||||
- "GLOW_SQUID"
|
||||
- "GOAT"
|
||||
- "GUARDIAN"
|
||||
- "HOGLIN"
|
||||
- "HORSE"
|
||||
- "HUSK"
|
||||
- "ILLUSIONER"
|
||||
- "IRON_GOLEM"
|
||||
- "LLAMA"
|
||||
- "MAGMA_CUBE"
|
||||
- "MULE"
|
||||
- "MUSHROOM_COW"
|
||||
- "OCELOT"
|
||||
- "PANDA"
|
||||
- "PARROT"
|
||||
- "PHANTOM"
|
||||
- "PIG"
|
||||
- "PIGLIN"
|
||||
- "PIGLIN_BRUTE"
|
||||
- "PILLAGER"
|
||||
- "POLAR_BEAR"
|
||||
- "RABBIT"
|
||||
- "RAVAGER"
|
||||
- "SALMON"
|
||||
- "SHEEP"
|
||||
- "SHULKER"
|
||||
- "SILVERFISH"
|
||||
- "SKELETON"
|
||||
- "SKELETON_HORSE"
|
||||
- "SLIME"
|
||||
- "SNOWMAN"
|
||||
- "SPIDER"
|
||||
- "SQUID"
|
||||
- "STRAY"
|
||||
- "STRIDER"
|
||||
- "TRADER_LLAMA"
|
||||
- "TROPICAL_FISH"
|
||||
- "TURTLE"
|
||||
- "VEX"
|
||||
- "VILLAGER"
|
||||
- "VINDICATOR"
|
||||
- "WANDERING_TRADER"
|
||||
- "WITCH"
|
||||
- "WITHER"
|
||||
- "WITHER_SKELETON"
|
||||
- "WOLF"
|
||||
- "ZOGLIN"
|
||||
- "ZOMBIE"
|
||||
- "ZOMBIE_HORSE"
|
||||
- "ZOMBIE_VILLAGER"
|
||||
- "ZOMBIFIED_PIGLIN"
|
||||
- "PUFFERFISH"
|
||||
|
||||
# Automatically wipe the specified entities
|
||||
autowipe:
|
||||
# Should we automatically wipe entities?
|
||||
enabled: true
|
||||
# How often, in seconds, to automatically wipe entities. Default is 5 minutes.
|
||||
interval: 300
|
||||
# Entities to automatically wipe
|
||||
entities:
|
||||
- "DROPPED_ITEM"
|
||||
|
||||
# What blocks should be blocked?
|
||||
blocked_blocks:
|
||||
- "SPAWNER"
|
||||
- "STRUCTURE_BLOCK"
|
||||
- "JIGSAW"
|
||||
|
||||
# What entities should be blocked?
|
||||
blocked_entities:
|
||||
- "WITHER"
|
||||
- "ENDER_DRAGON"
|
||||
- "MINECART_TNT"
|
||||
|
||||
# Limit entities per chunk
|
||||
entity_limit:
|
||||
# Is the mob limit enabled?
|
||||
mob_limit_enabled: true
|
||||
# The maximum number of mobs allowed in a chunk
|
||||
max_mobs_per_chunk: 50
|
||||
# The available ceiling for the maximum number of mobs
|
||||
mob_limit_ceiling: 500
|
||||
|
||||
# See https://docs.plex.us.org/docs/customization/config#worlds for documentation
|
||||
# These gamerules apply to all worlds on the server
|
||||
global_gamerules:
|
||||
- "doWeatherCycle;true"
|
||||
- "doDaylightCycle;true"
|
||||
- "doMobSpawning;false"
|
||||
- "keepInventory;true"
|
||||
- "doFireTick;false"
|
||||
- "doMobLoot;false"
|
||||
- "mobGriefing;false"
|
||||
- "doTileDrops;false"
|
||||
- "commandBlockOutput;false"
|
||||
- "naturalRegeneration;true"
|
||||
- "announceAdvancements;false"
|
||||
- "showDeathMessages;false"
|
||||
- "sendCommandFeedback;false"
|
||||
|
||||
worlds:
|
||||
flatlands:
|
||||
name: "Flatlands"
|
||||
modification:
|
||||
permission: "plex.world.flatlands.modify"
|
||||
message: "<red>You do not have permission to modify this world."
|
||||
gameRules:
|
||||
# The gamerules here override the global gamerules
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
stone: 16
|
||||
bedrock: 1
|
||||
adminworld:
|
||||
name: "Admin World"
|
||||
entry:
|
||||
permission: "plex.world.adminworld.enter"
|
||||
message: "<red>You do not have permission to enter this world."
|
||||
modification:
|
||||
permission: "plex.world.adminworld.modify"
|
||||
message: "<red>You do not have permission to modify this world."
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
stone: 16
|
||||
bedrock: 1
|
||||
masterbuilderworld:
|
||||
name: "MasterBuilder World"
|
||||
entry:
|
||||
permission: "plex.world.masterbuilderworld.enter"
|
||||
message: "<red>You do not have permission to enter this world."
|
||||
modification:
|
||||
permission: "plex.world.masterbuilderworld.modify"
|
||||
message: "<red>You do not have permission to modify this world."
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
stone: 16
|
||||
bedrock: 1
|
||||
|
||||
# If you are running a custom fork of Plex, you may wish to check for updates from a different repository.
|
||||
update_repo: "plexusorg/Plex"
|
||||
|
||||
# What branch should Plex fetch updates from?
|
||||
update_branch: "master"
|
||||
|
||||
# Additional logging for debugging
|
||||
debug: false
|
||||
```
|
||||
|
||||
## Server
|
||||
### server.name
|
||||
The name of your server goes here and is used throughout Plex.
|
||||
|
||||
### server.motd
|
||||
The text here will appear on the server list.
|
||||
|
||||
### server.colorize_motd
|
||||
This determines if the message of the day should randomly be colorized. You can disable this option and manually colorize your MOTD.
|
||||
|
||||
### server.sample
|
||||
This lets you specify a custom message under the player count in the server list.
|
||||
|
||||
## server.timezone
|
||||
This lets you customize which timezone various messages appear in (e.g. ban message end date)
|
||||
|
||||
## Titles
|
||||
### titles.masterbuilders
|
||||
A list of players who will show up as a masterbuilder.
|
||||
|
||||
### titles.owners
|
||||
A list of players who will show up as an owner.
|
||||
|
||||
## Banning
|
||||
### banning.ban_url
|
||||
The URL to be used when a player sees the ban message. The full ban message can be changed in `messages.yml`.
|
||||
|
||||
## Chat
|
||||
### chat.enabled
|
||||
**Default:** `true`
|
||||
Determines if the chat system should be enabled. It's useful to turn this off if you're using permissions and want to use prefixes from another plugin instead.
|
||||
|
||||
### chat.max_tag_length
|
||||
**Default:** `64`
|
||||
The maximum length a tag may be in game.
|
||||
|
||||
### chat.name-color
|
||||
**Default:** `<white>`
|
||||
The default color a tag should be if a player doesn't specify any colors.
|
||||
|
||||
## System
|
||||
### system
|
||||
**Options:** `ranks` or `permissions`
|
||||
|
||||
This determines how Plex's command system works. If `ranks` is selected, Plex will use a ranking system and give all players operator status. If `permissions` is selected, no players are given operator. Instead, every command will have a permission attached to it which can be assigned in any permission system. It is **highly** recommended to use permissions if you are running Plex behind a proxy such as BungeeCord or Velocity. These proxies **rely** on permissions to give proper commands to players. On some misconfigured instances, if a player is opped, they may inherit *all* available permissions from the proxy.
|
||||
|
||||
## Data
|
||||
### data.central.storage
|
||||
**Options:** `sqlite`, `mariadb`, `mongodb`
|
||||
|
||||
Select which database software you would like to use. `sqlite` is the default. Note that if you change which data storage you use, no data will be transferred.
|
||||
|
||||
### data.central.user
|
||||
This is the username for whichever database software you use. Note that `sqlite` does not require a username.
|
||||
|
||||
### data.central.password
|
||||
This is the password for whichever database software you use. Note that `sqlite` does not require a password.
|
||||
|
||||
### data.central.hostname
|
||||
This is the hostname for whichever database software you use. Note that `sqlite` does not require a hostname.
|
||||
|
||||
### data.central.port
|
||||
This is the port for whichever database software you use. Note that `sqlite` does not require a port.
|
||||
|
||||
### data.central.db
|
||||
This is the name for whichever database software you use. Note that `sqlite` does not require a name.
|
||||
|
||||
### data.side.enabled
|
||||
**Options:** `true` / `false`
|
||||
|
||||
This will enable Plex's Redis functionality.
|
||||
|
||||
### data.side.auth
|
||||
**Options:** `true` / `false`
|
||||
|
||||
This is whether authentication mode for Redis is turned on or not.
|
||||
|
||||
:::info
|
||||
It is highly recommended to have Redis authentication turned on.
|
||||
:::
|
||||
|
||||
### data.side.hostnane
|
||||
This is the hostname for Redis. This is required for Redis to work.
|
||||
|
||||
### data.side.port
|
||||
This is the port that Redis is listening on. This is requird for Redis to work.
|
||||
|
||||
### data.side.password
|
||||
This is the password for your Redis instance. Note that this can be left blank if authentication is turned off.
|
||||
|
||||
## Entity wiping
|
||||
### entitywipe_list
|
||||
All items in the list will not be wiped. By default, this includes all mobs as these can be purged with the `mobpurge` command.
|
||||
|
||||
## Autowiping
|
||||
### autowipe.enabled
|
||||
**Options:** `true` / `false`
|
||||
Should autowiping be enabled?
|
||||
|
||||
### autowipe.interval
|
||||
**Default:** 300
|
||||
How often, in seconds, to automatically wipe entities. Default is 5 minutes.
|
||||
|
||||
### autowipe.entities
|
||||
A list of entities to automatically wipe.
|
||||
|
||||
## Blocking
|
||||
### blocked_blocks
|
||||
A list of blocks that should be blocked.
|
||||
|
||||
### blocked_entities
|
||||
A list of entities that should be blocked.
|
||||
|
||||
## Global gamerules
|
||||
### global_gamerules
|
||||
These gamerules apply to all worlds on the server. Gamerules in the generated worlds will override the global gamerules.
|
||||
|
||||
## Worlds
|
||||
An infinite amount of worlds can be generated from the configuration file. A few are automatically generated by default. The format for generating new worlds is as follows:
|
||||
```yaml title=/plugins/Plex/config.yml
|
||||
<world name>:
|
||||
name: "Human readable world name"
|
||||
entry:
|
||||
# The permission required to enter the world, optional
|
||||
permission: "plex.world.worldname.enter"
|
||||
# Minimum rank requirement, optional
|
||||
requiredLevels:
|
||||
- "Rank.ADMIN"
|
||||
# The message to be shown if a player does not have permission, optional
|
||||
message: "<red>You do not have permission to enter this world."
|
||||
modification:
|
||||
# The permission required to modify the world, optional
|
||||
permission: "plex.world.worldname.modify"
|
||||
# Minimum rank requirement, optional
|
||||
requiredLevels:
|
||||
- "Rank.ADMIN"
|
||||
# The message to be shown if a player does not have permission, optional
|
||||
message: "<red>You do not have permission to modify this world."
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
stone: 16
|
||||
bedrock: 1
|
||||
```
|
||||
Note that in the `parameters` section, this is how the world should actually be generated. The order is from top to bottom. In the example above, a world will generate with one grass layer, 32 layers of dirt, 16 layers of stone, and one layer of bedrock.
|
||||
|
||||
For a list of Ranks and Titles, you can refer to the Javadocs: [Ranks](https://docs.plex.us.org/javadoc/server/dev/plex/rank/enums/Rank.html), [Title](https://docs.plex.us.org/javadoc/server/dev/plex/rank/enums/Title.html).
|
||||
|
||||
The gamerule section is what gamerules are set for the world by default. The syntax is the official gamerule name, a semicolon, and either `true` or `false`.
|
||||
|
||||
## Updates
|
||||
update_repo
|
||||
The repo to use for update checking.
|
||||
|
||||
update_branch
|
||||
The branch to use for update checking.
|
||||
|
||||
## Debugging
|
||||
**Options:** `true` / `false`
|
||||
|
||||
The `debug` option is standalone and enables additional logging. This may be useful for diagnosing issues as more information will be displayed in the console. It is recommended to keep this option turned off.
|
||||
300
docs/customization/messages.md
Normal file
300
docs/customization/messages.md
Normal file
@ -0,0 +1,300 @@
|
||||
---
|
||||
id: messages
|
||||
title: Messages
|
||||
---
|
||||
|
||||
# Messages
|
||||
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.
|
||||
|
||||
## 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: "<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 - Reason
|
||||
# 1 - Punisher
|
||||
kickMessage: "<red>You have been kicked! \n<red>Reason: <gold>{0}\n<red>Kicked by: <gold>{1}"
|
||||
# 0 - The type of indefinite ban
|
||||
# 1 - Appeal URL
|
||||
indefBanMessage: "<red>Your {0} is indefinitely banned! You may appeal at <gold>{1}."
|
||||
# 0 - The type of indefinite ban
|
||||
# 1 - Appeal URL
|
||||
# 2 - The reason
|
||||
indefBanMessageReason: "<red>Your {0} is indefinitely banned! You may appeal at <gold>{1}.\n<red>Reason: <gold>{2}"
|
||||
playerNotFound: "<red>Player not found!"
|
||||
specifyPlayer: "<red>You must specify a player!"
|
||||
worldNotFound: "<red>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: "<aqua>You have been teleported to {0}."
|
||||
# 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}"
|
||||
invalidTimeFormat: "<red>Invalid time format. Use s, m, h, d, w, mo, or y (e.g., 1h30m)."
|
||||
timeMustBeFuture: "<red>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: "<red>{0} - Muted {1} for {2}"
|
||||
maxTimeExceeded: "<red>The specified time must be under a week."
|
||||
# 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 permission node required to use the command
|
||||
noPermissionNode: "<red>You must have the permission: {0} <red>to use this command!"
|
||||
noPermissionInGame: "<red>You must be in console to use this command!"
|
||||
noPermissionConsole: "<red>You must be in-game to use this command!"
|
||||
# 0 - The username of the name history
|
||||
nameHistoryTitle: "<gold>Name History of {0}"
|
||||
nameHistorySeparator: "<gold><strikethrough>-----------------------------"
|
||||
# 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}"
|
||||
consoleMustDefinePlayer: "<red>You must define a player since you are running this command from console."
|
||||
# 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."
|
||||
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."
|
||||
# 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}"
|
||||
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!"
|
||||
playerLockedUp: "<red>That player is already locked up!"
|
||||
muted: "<red>You are currently muted - STFU!"
|
||||
pvpDisabled: "<red>PVP has been disabled!"
|
||||
chatIsOff: "<red>Chat is currently toggled off!"
|
||||
# 0 - The command sender
|
||||
# 1 - The set value of the chat toggle
|
||||
chatToggled: "<red>{0} - Toggled chat {1}"
|
||||
# 0 - The command sender
|
||||
# 1 - The player
|
||||
kickedPlayer: "<red>{0} - Kicking {1}"
|
||||
teleportedToWorldSpawn: "<aqua>Teleporting to the local spawn"
|
||||
toggleCommandSpy: "<gray>CommandSpy has been"
|
||||
enabled: "<gray>enabled."
|
||||
disabled: "<gray>disabled."
|
||||
# 0 - The admin / staff member
|
||||
# 1 - The player's group's prefix if any
|
||||
# 2 - The message
|
||||
adminChatFormat: '<dark_gray>[<blue>AdminChat<dark_gray>] <dark_red>{0} {1} <gray>» <gold>{2}'
|
||||
# 0 - Whether it was toggled on or off
|
||||
adminChatToggled: '<gray>AdminChat was toggled {0}'
|
||||
# 0 - Maximum length, configured in config.yml
|
||||
maximumPrefixLength: "<red>The maximum length for a tag may only be {0}."
|
||||
prefixCleared: "<aqua>Your prefix has been cleared."
|
||||
# 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}"
|
||||
# 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}"
|
||||
# 0 - The command sender
|
||||
# 1 - The player name
|
||||
blockingEdits: "<red>{0} - Blocking block modification abilities for {1}"
|
||||
# 0 - The command sender
|
||||
# 1 - The player
|
||||
unblockingEdits: "<aqua>{0} - Unblocking block modification abilities for {1}"
|
||||
# 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 - Number of mobs removed
|
||||
# 1 - Type of mob removed
|
||||
amountOfMobsRemoved: "<gray>{0} {1} removed."
|
||||
notAValidMob: "<red>That is not a valid mob."
|
||||
notAValidMobButValidEntity: "<red>That is a valid entity, but is not a valid mob."
|
||||
# 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!"
|
||||
# 0 - The boolean for whether the limit is enabled or disabled
|
||||
mobLimitToggle: "<gray>The mob limit has been {0}"
|
||||
# 0 - The amount that the mob limit has been set to
|
||||
mobLimitSet: "<gray>The mob limit has been set to: <em><white>{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: "<gray>({0}<gray>) <em><white>{1} <reset><gray>/ <em><white>{2} <reset><gray>per chunk (<em><white>Chunk<gray>: <reset>{3}, {4}<gray>)"
|
||||
# 0 - The max set limit in config
|
||||
mobLimitCeiling: "<gray>The limit you have entered is too high. Defaulting to the ceiling value from config"
|
||||
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!"
|
||||
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."
|
||||
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."
|
||||
# 0 - The material name
|
||||
# 1 - The players who have the material in their inventory
|
||||
playersWithMaterial: "<gray>Players with {0} in their inventory: {1}"
|
||||
# 0 - The material name
|
||||
# 1 - The players who have the material in their inventory
|
||||
playersMaterialCleared: "<gray>{0} has been removed from the following players: {1}"
|
||||
nobodyHasThatMaterial: "<gray>No one online has that in their inventory."
|
||||
# 0 - The attempted material name
|
||||
materialNotFound: "<red>{0} is not a valid item/block name."
|
||||
# 0 - The players name
|
||||
loginMessage: "<yellow>{0} joined the game"
|
||||
# 0 - The string that wasn't a valid integer
|
||||
notANumber: "<red>{0} is not a valid number!"
|
||||
# 0 - Players currently online
|
||||
# 1 - Max players
|
||||
listHeader: "<gray>There is currently <yellow>{0}<gray> player online out of <yellow>{1}<gray> players."
|
||||
# 0 - Players currently online
|
||||
# 1 - Max players
|
||||
listHeaderPlural: "<gray>There are currently <yellow>{0}<gray> players online out of <yellow>{1}<gray> players."
|
||||
# 0 - Player who is having their notes fetched
|
||||
notesHeader: "Player notes for: <green>{0}"
|
||||
# 0 - Note ID
|
||||
# 1 - Author of the note
|
||||
# 2 - Timestamp
|
||||
notePrefix: "<gold><!italic>{0} - Written by: {1} on {2}"
|
||||
# 0 - The content of the note
|
||||
noteLine: "<newline><yellow># {0}"
|
||||
# 0 - The player
|
||||
# 1 - The number of notes logged for said player
|
||||
playerNoteAlert: "<gold>{0} has {1} note. <click:run_command:/notes {0} list><underlined>Click here to view their note."
|
||||
# 0 - The player
|
||||
# 1 - The number of notes logged for said player
|
||||
playerNoteAlertPlural: "<gold>{0} has {1} notes. <click:run_command:/notes {0} list><underlined>Click here to view their notes."
|
||||
smiteTitleHeader: "<red>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: "<yellow>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: "<red>{0} has been a naughty, naughty boy.<newline><red> - Reason: <yellow>{1}<newline><red> - Smitten by: <yellow>{2}"
|
||||
# 0 - The player
|
||||
smittenQuietly: "<gray>Smitten {0} quietly."
|
||||
# 0 - The reason for being smitten
|
||||
smitten: "<red>You've been smitten. Reason: <yellow>{0}"
|
||||
nukerKickMessage: "Please turn off your nuker!"
|
||||
antiSpamMessage: "<gray>Please refrain from spamming messages."
|
||||
# 0 - The player
|
||||
banExpiredBroadcast: "Plex - Automatically unbanning {0}"
|
||||
# 0 - The player
|
||||
redisResetSuccessful: "<yellow>Successfuly reset {0}'s Redis punishments!"
|
||||
redisResetPlayerNotFound: "Couldn't find player in Redis punishments."
|
||||
reappliedGamerules: "<aqua>All game rules have been re-applied!"
|
||||
commandNotFound: "<red>That command could not be found!"
|
||||
# 0 - The command
|
||||
# 1 - A list of aliases found
|
||||
commandAliases: "<aqua>Aliases for {0} are: {1}"
|
||||
```
|
||||
|
||||
## 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).
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user