mirror of
https://github.com/plexusorg/Website.git
synced 2025-07-01 07:36:42 +00:00
Huge documentation update
This commit is contained in:
@ -4,9 +4,12 @@ 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.
|
||||
|
||||
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
|
||||
@ -66,7 +69,7 @@ commands:
|
||||
- "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
|
||||
# These commands will be blocked when a player is muted or when chat is toggled off.
|
||||
block_on_mute:
|
||||
- me
|
||||
- say
|
||||
@ -76,10 +79,15 @@ block_on_mute:
|
||||
```
|
||||
|
||||
## 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 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`
|
||||
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`
|
||||
|
||||
@ -3,11 +3,15 @@ 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```.
|
||||
# Configuration
|
||||
|
||||
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
|
||||
@ -36,8 +40,8 @@ chat:
|
||||
# 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>'
|
||||
# The chat format can be customized here if the Plex chat system is enabled
|
||||
format: "{prefix} <white>{name} <gray>» <reset>{message}"
|
||||
|
||||
# You can define colors for each group which will appear in the tab list
|
||||
colors:
|
||||
@ -252,78 +256,129 @@ 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.
|
||||
|
||||
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
|
||||
### 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`.
|
||||
|
||||
## Punishments
|
||||
|
||||
### punishments.mute-timer
|
||||
|
||||
**Default:** `500`
|
||||
|
||||
The time in minutes for a mute to expire
|
||||
|
||||
### punishments.freeze-timer
|
||||
|
||||
**Default:** `500`
|
||||
|
||||
The time in minutes for a freeze to expire
|
||||
|
||||
## 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.
|
||||
|
||||
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.
|
||||
The maximum length a tag may be in game. This does not include MiniMessage tags, just characters
|
||||
|
||||
## System
|
||||
### system
|
||||
**Options:** `ranks` or `permissions`
|
||||
### chat.format
|
||||
|
||||
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.
|
||||
**Default:** `"{prefix} <white>{name} <gray>» <reset>{message}"`
|
||||
|
||||
This allows you to customize the chat format for Plex. The `{prefix}` placeholder will be replaced with whatever prefix
|
||||
the player has. The `{name}` prefix will be substituted with the player's display name. The `{message}` placeholder will
|
||||
be replaced by the actual message of the player.
|
||||
|
||||
## Colors
|
||||
|
||||
### colors.\<group\>
|
||||
|
||||
This allows you to define colors for your groups in your permission plugin. These colors will show up in tab. For
|
||||
example, if a person is in the admin group, their color will be aqua. This can be changed and customized based on your
|
||||
group names. You do not have to use the ones provided in the configuration.
|
||||
|
||||
## Login Messages
|
||||
|
||||
### loginmessages.name
|
||||
|
||||
**Default:** `true`
|
||||
|
||||
This enforces a requirement that players include their name when they set a login message.
|
||||
|
||||
## 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.
|
||||
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
|
||||
:::info
|
||||
The default port for MySQL/MariaDB is 3306. Ensure you change it to that if you are using MySQL/MariaDB.
|
||||
The default is 27017 which is the MongoDB default.
|
||||
:::
|
||||
|
||||
### 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.
|
||||
@ -333,61 +388,101 @@ 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.
|
||||
|
||||
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.
|
||||
|
||||
## Entity limits
|
||||
|
||||
### entity_limit.mob_limit_enabled
|
||||
|
||||
**Default:** `true`
|
||||
|
||||
This determines if the mob limiter is enabled
|
||||
|
||||
### entity_limit.max_mobs_per_chunk
|
||||
|
||||
**Default:** `50`
|
||||
|
||||
This allows you to set the maximum number of mobs allowed in a chunk
|
||||
|
||||
### entity_limit.mob_limit_ceiling
|
||||
|
||||
**Default:** `500`
|
||||
|
||||
This is the maximum amount of mobs allowed.
|
||||
|
||||
## 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:
|
||||
|
||||
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
|
||||
# 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
|
||||
# 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
|
||||
# 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
|
||||
# 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"
|
||||
@ -398,13 +493,19 @@ An infinite amount of worlds can be generated from the configuration file. A few
|
||||
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).
|
||||
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.
|
||||
|
||||
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`.
|
||||
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.
|
||||
|
||||
@ -412,6 +513,8 @@ 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.
|
||||
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.
|
||||
|
||||
@ -4,10 +4,14 @@ 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.
|
||||
|
||||
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.
|
||||
@ -244,7 +248,7 @@ 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"
|
||||
loginMessage: "<yellow><translate:multiplayer.player.joined:{0}>"
|
||||
# 0 - The string that wasn't a valid integer
|
||||
notANumber: "<red>{0} is not a valid number!"
|
||||
# 0 - Players currently online
|
||||
@ -294,7 +298,15 @@ 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).
|
||||
|
||||
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.
|
||||
|
||||
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