mirror of
https://github.com/plexusorg/Website.git
synced 2025-07-01 07:36:42 +00:00
We finally have a logo
This commit is contained in:
@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Introduction
|
||||
Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle``` file.
|
||||
Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle``` file. Note that you can download an already compiled version of Plex from the [CI Server](https://ci.plex.us.org).
|
||||
|
||||
## Prerequisites
|
||||
Please ensure that you have Java 17 installed on your computer, as Plex requires JDK 17 to compile. You will get an error if you try to use an older version.
|
||||
@ -53,3 +53,6 @@ Gradle is already included in the folder with Plex. Run the following command be
|
||||
You should receive a message indicating the compilation was successful. The JAR file is located at ```build/libs/Plex.jar```
|
||||
|
||||
Plex has no external dependencies and can be used right away after compilation. Plex works on Minecraft versions 1.16.5 to 1.18.1. You also must be running Java 17 on the server itself.
|
||||
|
||||
## Troubleshooting
|
||||
If you receive an error that says Permission denied, run `chmod a+x gradlew`. Note that this only applies to macOS / Linux users.
|
||||
@ -10,7 +10,7 @@ This page will show you how to modify the configuration file. The 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://docs.plex.us.org
|
||||
# For documentation, please visit: https://plex.us.org
|
||||
|
||||
server:
|
||||
name: "Plexus"
|
||||
@ -20,7 +20,7 @@ server:
|
||||
- "&cForums: https://forum.plex.us.org"
|
||||
|
||||
titles:
|
||||
masterbuilders: []
|
||||
masterbuilders: [ ]
|
||||
owners:
|
||||
- Telesphoreo
|
||||
|
||||
@ -30,7 +30,8 @@ banning:
|
||||
|
||||
chat:
|
||||
max-tag-length: 16
|
||||
name-color: 'f' #Color code for name color
|
||||
# Color code for name color
|
||||
name-color: 'f'
|
||||
|
||||
# Settings for commands relating to Plex
|
||||
commands:
|
||||
@ -52,12 +53,26 @@ data:
|
||||
port: 6379
|
||||
password: ""
|
||||
|
||||
# requiredLevel if permissions are ranks, else permissions
|
||||
# See https://plex.us.org/docs/customization/config#worlds for documentation
|
||||
worlds:
|
||||
flatlands:
|
||||
name: "Flatlands"
|
||||
permission: "plex.world.flatlands"
|
||||
noEdit: "&cYou can't edit this world!"
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
- "doMobSpawning;false"
|
||||
- "keepInventory;true"
|
||||
- "doFireTick;false"
|
||||
- "doMobLoot;false"
|
||||
- "mobGriefing;false"
|
||||
- "doTileDrops;false"
|
||||
- "commandBlockOutput;false"
|
||||
- "naturalRegeneration;true"
|
||||
- "announceAdvancements;false"
|
||||
- "showDeathMessages;false"
|
||||
- "sendCommandFeedback;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
@ -69,6 +84,20 @@ worlds:
|
||||
requiredLevels:
|
||||
- "Rank.ADMIN" # Minimum rank requirement
|
||||
noEdit: "&cYou can't edit this world!"
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
- "doMobSpawning;false"
|
||||
- "keepInventory;true"
|
||||
- "doFireTick;false"
|
||||
- "doMobLoot;false"
|
||||
- "mobGriefing;false"
|
||||
- "doTileDrops;false"
|
||||
- "commandBlockOutput;false"
|
||||
- "naturalRegeneration;true"
|
||||
- "announceAdvancements;false"
|
||||
- "showDeathMessages;false"
|
||||
- "sendCommandFeedback;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
@ -80,6 +109,20 @@ worlds:
|
||||
requiredLevels:
|
||||
- "Title.MASTER_BUILDER" # Title has no "minimum", so this will have to be their title
|
||||
noEdit: "&cYou can't edit this world!"
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
- "doMobSpawning;false"
|
||||
- "keepInventory;true"
|
||||
- "doFireTick;false"
|
||||
- "doMobLoot;false"
|
||||
- "mobGriefing;false"
|
||||
- "doTileDrops;false"
|
||||
- "commandBlockOutput;false"
|
||||
- "naturalRegeneration;true"
|
||||
- "announceAdvancements;false"
|
||||
- "showDeathMessages;false"
|
||||
- "sendCommandFeedback;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
@ -180,6 +223,20 @@ An infinite amount of worlds can be generated from the configuration file. A few
|
||||
requiredLevels:
|
||||
- "Rank.ADMIN" # The minimum rank required to edit the world
|
||||
noEdit: "&cThis message will display if a player doesn't have permission to edit a world."
|
||||
gameRules:
|
||||
- "doWeatherCycle;false"
|
||||
- "doDaylightCycle;false"
|
||||
- "doMobSpawning;false"
|
||||
- "keepInventory;true"
|
||||
- "doFireTick;false"
|
||||
- "doMobLoot;false"
|
||||
- "mobGriefing;false"
|
||||
- "doTileDrops;false"
|
||||
- "commandBlockOutput;false"
|
||||
- "naturalRegeneration;true"
|
||||
- "announceAdvancements;false"
|
||||
- "showDeathMessages;false"
|
||||
- "sendCommandFeedback;false"
|
||||
parameters:
|
||||
grass_block: 1
|
||||
dirt: 32
|
||||
@ -190,6 +247,8 @@ Note that in the `parameters` section, this is how the world should actually be
|
||||
|
||||
For a list of Ranks and Titles, you can refer to the Javadocs: [Ranks](https://docs.plex.us.org/javadocs/dev/plex/rank/enums/Rank.html), [Title](https://docs.plex.us.org/javadocs/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`.
|
||||
|
||||
## Debugging
|
||||
**Options:** `true` / `false`
|
||||
|
||||
|
||||
@ -8,82 +8,127 @@ Almost all of the messages inside of Plex are fully customizable. This page will
|
||||
|
||||
## Default file
|
||||
The default `messages.yml` file is below.
|
||||
```yaml title=/plugins/Plex/messages.yml
|
||||
# Plex Messages File
|
||||
```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
|
||||
|
||||
# Base color - the main color prefix; will be used following each of the messages below
|
||||
# Broadcast color - the color used when broadcasting a message
|
||||
# Error color - the color of an error; will be used when an error is thrown from a command
|
||||
baseColor: "7"
|
||||
broadcastColor: "b"
|
||||
errorColor: "c"
|
||||
# Variables <v> - 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.
|
||||
# You are unable to change the order the variables are used due to it being a code-side functionality.
|
||||
# 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.
|
||||
|
||||
# 1: Appeal URL
|
||||
# 2: Reason
|
||||
# 3: Expiry
|
||||
# 4: Punisher
|
||||
banMessage: "&cYou have been banned! You may appeal at &6<v>.\n&cReason: &6<v>\n&cEnd date: &6<v>\n&cBanned by: &6<v>"
|
||||
# 1. Appeal URL
|
||||
# 2. Reason
|
||||
# 3. Expiry
|
||||
# 4. Punisher
|
||||
banMessage: "<red>You have been banned! You may appeal at <gold><v>.\n<red>Reason: <gold><v>\n<red>End date: <gold><v>\n<red>Banned by: <gold><v>"
|
||||
test: "this is a test message!"
|
||||
# 1: the command sender's username
|
||||
# 1. The command sender's username
|
||||
variableTest: "variable test with <v>!"
|
||||
playerNotFound: "Player not found!"
|
||||
worldNotFound: "World not found!"
|
||||
|
||||
# 1: the world you have been teleported to
|
||||
# 1. The world you have been teleported to
|
||||
playerWorldTeleport: "You have been teleported to <v>."
|
||||
# 1: the command sender who opped everyone
|
||||
oppedAllPlayers: "<b><v> - Opped all players on the server"
|
||||
deoppedAllPlayers: "<b><v> - De-opped all players on the server"
|
||||
# 1: the person who is opping
|
||||
# 2: the person who has been opped
|
||||
oppedPlayer: "<b><v> - Opped <v>"
|
||||
# 1: the person who is freezing
|
||||
# 2: the person who has been frozen
|
||||
frozePlayer: "<b><v> - Froze <v>"
|
||||
# 1: the person who is unfreezing
|
||||
# 2: the person who has been unfrozen
|
||||
unfrozePlayer: "<b><v> - Unfroze <v>"
|
||||
noPermission: "<e>You cannot use this command!"
|
||||
# 1: the login message (uncolored) of the rank required to use the command
|
||||
noPermissionRank: "<e>You must be at least <v> to use this command!"
|
||||
noPermissionNode: "<e>You must have the permission: <v> to use this command!"
|
||||
noPermissionInGame: "<e>You must be in console to use this command!"
|
||||
noPermissionConsole: "<e>You must be in-game to use this command!"
|
||||
# 1: the username of the name history
|
||||
# 1. The sender who opped everyone
|
||||
oppedAllPlayers: "<aqua><v> - Opped all players on the server"
|
||||
# 1. The sender who de-opped everyone
|
||||
deoppedAllPlayers: "<aqua><v> - De-opped all players on the server"
|
||||
# 1. The person who is opping
|
||||
# 2. The person who has been opped
|
||||
oppedPlayer: "<aqua><v> - Opped <v>"
|
||||
# 1. The person who is deopped
|
||||
# 2. The person who has been deopped
|
||||
deoppedPlayer: "<red><v> - Deopped <v>"
|
||||
# 1. The person who is freezing
|
||||
# 2. The person who has been frozen
|
||||
frozePlayer: "<aqua><v> - Froze <v>"
|
||||
# 1. The person who is unfreezing
|
||||
# 2. The person who has been unfrozen
|
||||
unfrozePlayer: "<aqua><v> - Unfroze <v>"
|
||||
# 1. The person who is freezing
|
||||
# 2. The person who has been frozen
|
||||
mutedPlayer: "<aqua><v> - Muted <v>"
|
||||
# 1. The person who is unfreezing
|
||||
# 2. The person who has been unfrozen
|
||||
unmutedPlayer: "<aqua><v> - Unmuted <v>"
|
||||
noPermission: "<red>You cannot use this command!"
|
||||
# 1. The rank required to use the command
|
||||
noPermissionRank: "<red>You must be at least <v> to use this command!"
|
||||
# 1. The permission node required to use the command
|
||||
noPermissionNode: "<red>You must have the permission: <v> 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!"
|
||||
# 1. The username of the name history
|
||||
nameHistoryTitle: "Name History of <v>"
|
||||
# 1: a username of the found user
|
||||
# 2: when the user changed to that username
|
||||
# 1. A username of the found user
|
||||
# 2. When the user changed to that username
|
||||
nameHistoryBody: " - <v> (<v>)"
|
||||
# 1: the username that failed
|
||||
nameHistoryFail: "<e>Something went wrong while trying to retrieve name history of <v>! Try again later!"
|
||||
nameHistoryDoesntExist: "<e>Couldn't find this user! Please check if your spelling was correct and this player exists"
|
||||
# 1. The username that failed
|
||||
nameHistoryFail: "<red>Something went wrong while trying to retrieve name history of <v>! Try again later!"
|
||||
nameHistoryDoesntExist: "<red>Couldn't find this user! Please check if your spelling was correct and this player exists"
|
||||
# 1. The gamemode
|
||||
gameModeSetTo: "Your gamemode has been set to <v>."
|
||||
# 1. The player's name
|
||||
# 2. The gamemode
|
||||
setOtherPlayerGameModeTo: "You set <v>'s gamemode to <v>."
|
||||
# 1. The command sender
|
||||
# 2. The gamemode
|
||||
playerSetOtherGameMode: "<v> set your gamemode to <v>."
|
||||
setEveryoneGameMode: "<b><v> - Changing everyone's gamemode to <v>"
|
||||
# 1. The command sender
|
||||
# 2. The gamemode
|
||||
setEveryoneGameMode: "<aqua><v> - Changing everyone's gamemode to <v>"
|
||||
consoleMustDefinePlayer: "You must define a player since you are running this command from console."
|
||||
newAdminAdded: "<b><v> - Adding <v> to the admin list"
|
||||
adminRemoved: "<e><v> - Removing <v> from the admin list"
|
||||
adminSetRank: "<b><v> - Setting <v>'s rank to <v>"
|
||||
teleportedToWorld: "<b>You have been teleported to the <v>."
|
||||
higherRankThanYou: "<e>This player is an admin and a higher rank than you."
|
||||
playerNotAdmin: "<e>That player is not an admin."
|
||||
playerIsAdmin: "<e>That player is already an admin."
|
||||
rankNotFound: "<e>The rank you entered was not found."
|
||||
rankMustBeHigherThanAdmin: "<e>The rank you entered must be higher than Admin."
|
||||
consoleOnly: "<e>This command can only be executed by the console."
|
||||
yourRank: "<b>Your rank is: <v>"
|
||||
banningPlayer: "<e><v> - Banning <v>"
|
||||
unbanningPlayer: "<b><v> - Unbanning <v>"
|
||||
playerNotBanned: "<e>That player is not banned!"
|
||||
teleportedToWorldSpawn: "<b>Teleporting to the local spawn"
|
||||
toggleCommandSpy: "CommandSpy has been "
|
||||
enabled: "enabled"
|
||||
disabled: "disabled"
|
||||
# 1. The command sender
|
||||
# 2. The player
|
||||
newAdminAdded: "<aqua><v> - Adding <v> to the admin list"
|
||||
# 1. The command sender
|
||||
# 2. The player
|
||||
adminRemoved: "<red><v> - Removing <v> from the admin list"
|
||||
# 1. The command sender
|
||||
# 2. The player
|
||||
adminSetRank: "<aqua><v> - Setting <v>'s rank to <v>"
|
||||
# The world name
|
||||
teleportedToWorld: "<aqua>You have been teleported to the <v>."
|
||||
higherRankThanYou: "<red>This player is an admin and 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."
|
||||
# 1. Rank
|
||||
yourRank: "<aqua>Your rank is: <v>"
|
||||
# 1. Player name
|
||||
# 2. Rank
|
||||
otherRank: "<aqua><v>'s rank is: <v>"
|
||||
# 1. The command sender
|
||||
# 2. The player
|
||||
banningPlayer: "<red><v> - Banning <v>"
|
||||
# 1. The command sender
|
||||
# 2. The player
|
||||
unbanningPlayer: "<aqua><v> - Unbanning <v>"
|
||||
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!"
|
||||
muted: "<red>You are currently muted - STFU!"
|
||||
teleportedToWorldSpawn: "<aqua>Teleporting to the local spawn"
|
||||
toggleCommandSpy: "CommandSpy has been"
|
||||
enabled: "enabled."
|
||||
disabled: "disabled."
|
||||
adminChatFormat: '&8[&9AdminChat&8] &4<v> &7» &6<v>'
|
||||
maximumPrefixLength: "<red>The maximum length for a tag may only be <v>."
|
||||
prefixCleared: "<aqua>Your prefix has been cleared."
|
||||
otherPrefixCleared: "<aqua>You have cleared <v>'s prefix."
|
||||
prefixSetTo: "<aqua>Your prefix has been set to <v>"
|
||||
```
|
||||
|
||||
## 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).
|
||||
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