mirror of
https://github.com/plexusorg/Website.git
synced 2024-11-12 15:56:07 +00:00
Revise documentation
This commit is contained in:
parent
ec11391ed3
commit
316760f967
@ -6,7 +6,7 @@ title: Compiling Plex
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Introduction
|
||||
# Compiling
|
||||
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
|
||||
@ -17,7 +17,7 @@ Plex does not require, but recommends having Git installed on your computer. If
|
||||
## Using the command line
|
||||
First, clone the Plex source code from GitHub on to your computer using the following command.
|
||||
```bash
|
||||
git clone https://github.com/PlexDevelopment/Plex
|
||||
git clone https://github.com/plexusorg/Plex
|
||||
```
|
||||
|
||||
:::note
|
||||
@ -32,7 +32,7 @@ cd Plex-master
|
||||
|
||||
Gradle is already included in the folder with Plex. Run the following command below based on your operating system to compile Plex.
|
||||
<Tabs>
|
||||
<TabItem value="macOS" label = "macOS" default>
|
||||
<TabItem value="macOS" label="macOS" default>
|
||||
|
||||
./gradlew build
|
||||
|
||||
@ -49,9 +49,9 @@ Gradle is already included in the folder with Plex. Run the following command be
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
You should receive a message indicating the compilation was successful. The JAR file is located at ```build/libs/Plex.jar```
|
||||
You should receive a message indicating the compilation was successful. The JAR files for the Server, API, and Proxy are located in the `build/libs` folder.
|
||||
|
||||
Plex has no external dependencies and can be used right away after compilation. Plex works on Minecraft 1.18.2. 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.
|
||||
If you receive an error that says Permission denied, run `chmod a+x gradlew`. Note that this only applies to macOS / Linux users.
|
||||
|
||||
@ -3,7 +3,7 @@ id: commandblocker
|
||||
title: Command Blocker
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# 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
|
||||
@ -77,4 +77,3 @@ commands:
|
||||
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`
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ id: config
|
||||
title: Configuration
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# Config
|
||||
This page will show you how to modify the configuration file. The configuration file is located at: ```/plugins/Plex/config.yml```.
|
||||
|
||||
## Default configuration
|
||||
|
||||
@ -3,7 +3,7 @@ id: messages
|
||||
title: Messages
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# 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
|
||||
@ -193,4 +193,4 @@ unableToParseNumber: "<red>Unable to parse {0} as a number!"
|
||||
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.
|
||||
|
||||
@ -3,7 +3,7 @@ id: indefinitebans
|
||||
title: Indefinite Bans
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# Indefinite Bans
|
||||
Similar to TotalFreedomMod, Plex has indefinite bans. Indefinite bans are reserved for players who should not automatically be unbanned. Anyone who has access to the `indefbans.yml` file can add indefinite bans. If you are using Redis, all indefinite bans will be uploaded to Redis on startup. From that point on, indefinite bans will be fetched from Redis instead of the `indefbans.yml` file. **Redis is NOT required to use indefinite bans.** If you do not use Redis, Plex will fetch indefinite bans from the `indefbans.yml` file. No matter which medium you use, you will always add new entries to the `indefbans.yml` file. Note that there is no in-game command for adding or removing indefinite bans.
|
||||
|
||||
## Default file
|
||||
@ -35,4 +35,4 @@ bypassers:
|
||||
Each entry starts with a description. This is to help you organize indefinite bans. For example, you could have a section `griefers` for serial griefers or `bypassers` for players who have bypassed bans. The `users` section is for usernames only, the `uuids` section is only for UUIDs, and the `ips` section is for IPs only. If you do not want to ban a type, you do not have to include it. Note that no duplicate descriptions can exist. This means you cannot have `bypassers` as a section twice. The actual descriptions are not used in the plugins and can be anything you like. They do not affect the indefinite ban in any way.
|
||||
|
||||
### Converting indefinite bans
|
||||
If you are switching from TotalFreedomMod to Plex, we have developed a tool called IBConverter to convert your existing indefinite bans into Plex's format. For more information on IBConverter, visit [the GitHub page](https://github.com/PlexDevelopment/IBConverter). This tool was written in Python. The only thing you need to give it is your existing `indefinitebans.yml` file from TotalFreedomMod. Note that it requires Python 3.7 or newer and `pip` to be installed on your system.
|
||||
If you are switching from TotalFreedomMod to Plex, we have developed a tool called IBConverter to convert your existing indefinite bans into Plex's format. For more information on IBConverter, visit [the GitHub page](https://github.com/PlexDevelopment/IBConverter). This tool was written in Python. The only thing you need to give it is your existing `indefinitebans.yml` file from TotalFreedomMod. Note that it requires Python 3.7 or newer and `pip` to be installed on your system.
|
||||
|
||||
@ -3,5 +3,5 @@ id: bukkittelnet
|
||||
title: BukkitTelnet
|
||||
---
|
||||
|
||||
# Introduction
|
||||
The BukkitTelnet is a very simple module. The only purpose of the module is to allow admins to automatically log in to telnet without needing to enter the password. If the person's rank is an Admin or above, it will let them connect. If your server is using permissions, you should add the `plex.telnet.autoconnect` to any group you want to have automatically connect to telnet.
|
||||
# BukkitTelnet
|
||||
The BukkitTelnet is a very simple module. The only purpose of the module is to allow admins to automatically log in to telnet without needing to enter the password. If the person's rank is an Admin or above, it will let them connect. If your server is using permissions, you should add the `plex.telnet.autoconnect` to any group you want to have automatically connect to telnet.
|
||||
|
||||
@ -3,7 +3,7 @@ id: httpd
|
||||
title: HTTPD
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# HTTPD
|
||||
The HTTPD module sets up a basic web server to display information from Plex.
|
||||
|
||||
## Endpoints
|
||||
@ -25,4 +25,4 @@ If you go this page, it will ask you to enter a UUID in the URL. When you enter
|
||||
This page allows anyone to download schematics from the server. No permission is required to access the page
|
||||
|
||||
### /api/schematics/upload
|
||||
This page allows players who are an Admin or above to upload schematics. The corresponding permission to upload schematics is `plex.httpd.schematics.upload`
|
||||
This page allows players who are an Admin or above to upload schematics. The corresponding permission to upload schematics is `plex.httpd.schematics.upload`
|
||||
|
||||
@ -5,9 +5,10 @@ title: LibsDisguises
|
||||
|
||||
# LibsDisguises
|
||||
The LibsDisguises module adds two new commands: `undisguiseall` and `disguisetoggle`.
|
||||
|
||||
## Commands
|
||||
### undisguiseall
|
||||
The `undisguiseall` command disguises all non-admins. You can optionally add `-a` to undisguise all players including admins. If your server is using permissions, the permission to bypass being undisguised is `plex.libsdisguises.bypass`. This permission will not bypass `-a`. The permission to use the command itself is `plex.libsdisguises.undisguiseall`
|
||||
|
||||
### disguisetoggle
|
||||
The `disguisetoggle` command toggles LibsDisguises. It allows admins or players with the `plex.libsdisguises.disguisetoggle` permission to toggle LibsDisguises. When LibsDisguises is disabled, all players are undisguised and no commands from LibsDisguises can be used until reenabled.
|
||||
The `disguisetoggle` command toggles LibsDisguises. It allows admins or players with the `plex.libsdisguises.disguisetoggle` permission to toggle LibsDisguises. When LibsDisguises is disabled, all players are undisguised and no commands from LibsDisguises can be used until reenabled.
|
||||
|
||||
@ -3,7 +3,7 @@ id: permissions
|
||||
title: Permissions
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# Permissions
|
||||
This page is a comprehensive list of all of Plex's permission nodes.
|
||||
|
||||
## Plex
|
||||
@ -72,4 +72,4 @@ This page is a comprehensive list of all of Plex's permission nodes.
|
||||
|----------------|-----------------------------------|-----------------------------------------------------------------------------------------------|
|
||||
| disguisetoggle | plex.libsdisguises.disguisetoggle | Toggle LibsDisguises |
|
||||
| undisguiseall | plex.libsdisguises.undisguiseall | Undisguise all players |
|
||||
| undisguiseall | plex.libsdisguises.bypass | Bypass being undisguised. This can be overridden regardless of permission with the `-a` flag. |
|
||||
| undisguiseall | plex.libsdisguises.bypass | Bypass being undisguised. This can be overridden regardless of permission with the `-a` flag. |
|
||||
|
||||
@ -3,7 +3,7 @@ id: redis
|
||||
title: Configuring Redis
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# Redis
|
||||
This page will show you how to setup and configure Redis for Plex. This tutorial assumes a moderate amount of computer knowledge. Please note that setting up Redis is optional. It offers many performance improvements, but can be dangerous if improperly configured.
|
||||
|
||||
## Using Pterodactyl
|
||||
@ -79,4 +79,4 @@ side:
|
||||
password: 'your_secure_password_here'
|
||||
```
|
||||
|
||||
Replace `your_secure_password_here` with the password you made for Redis. Now, Plex will use Redis for storing punishment data. Note that the JSON files are still made as a backup no matter what.
|
||||
Replace `your_secure_password_here` with the password you made for Redis. Now, Plex will use Redis for storing punishment data. Note that the JSON files are still made as a backup no matter what.
|
||||
|
||||
@ -3,7 +3,7 @@ id: versions
|
||||
title: Versions
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# Versions
|
||||
Plex builds against the latest Minecraft version available. A table has been provided below to help you determine which versions of Plex work with your version of Minecraft.
|
||||
|
||||
| Plex Version | Minecraft Versions |
|
||||
@ -17,4 +17,4 @@ Plex builds against the latest Minecraft version available. A table has been pro
|
||||
| 0.7 | 1.18 - 1.18.1 |
|
||||
| 0.6 | 1.18 - 1.18.1 |
|
||||
| 0.5 | 1.18 - 1.18.1 |
|
||||
| 0.4 | 1.16.5 - 1.18.1 |
|
||||
| 0.4 | 1.16.5 - 1.18.1 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user