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,4 +4,8 @@ title: BukkitTelnet
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
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.
|
||||
|
||||
10
docs/modules/falseop.md
Normal file
10
docs/modules/falseop.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
id: falseop
|
||||
title: FalseOp
|
||||
---
|
||||
|
||||
# FalseOp
|
||||
|
||||
The FalseOp module uses ProtocolLib to trick clients into thinking they have true operator privileges. This is useful as
|
||||
Plex uses permissions rather than granting true operator privileges to users. This module has no additional
|
||||
configuration, commands, or permissions.
|
||||
@ -4,25 +4,40 @@ title: HTTPD
|
||||
---
|
||||
|
||||
# HTTPD
|
||||
|
||||
The HTTPD module sets up a basic web server to display information from Plex.
|
||||
|
||||
## Endpoints
|
||||
|
||||
The endpoints are what allow you to query the server and see information. All endpoints are formatted in JSON.
|
||||
|
||||
### /api/admins
|
||||
Displays a list of admins in JSON format. If your IP is not registered to an admin, it will not display IP addresses. If your server is using permissions, it will check if the player has the `plex.httpd.admins.access` instead.
|
||||
### /api/commands
|
||||
|
||||
This endpoint shows a list of registered commands on the server. It is an automatically generated help page. It is up to
|
||||
plugin authors to provide accurate information about their plugins and the commands they provide.
|
||||
|
||||
### /api/indefbans
|
||||
Displays a list of indefinite players in JSON format. This page is only accessible if your IP address is linked to an admin on the server. If your server is using permissions, it will check if the player has the `plex.httpd.indefbans.access` instead.
|
||||
|
||||
Displays a list of indefinite players in JSON format. This page is only accessible if your IP address is linked to an
|
||||
admin on the server. If your server is using permissions, it will check if the player has the
|
||||
`plex.httpd.indefbans.access` instead.
|
||||
|
||||
### /api/list
|
||||
|
||||
This will display a list of online players in JSON format. This is accessible to everyone.
|
||||
|
||||
### /api/punishments
|
||||
If you go this page, it will ask you to enter a UUID in the URL. When you enter a valid UUID to the URL, it will display that user's punishments in JSON format. An example URL would be `/api/punishments/78408086-1991-4c33-a571-d8fa325465b2`. If your IP is not registered to an admin, it will not display IP addresses. If your server is using permissions, it will check if the player has the `plex.httpd.punishments.access` instead.
|
||||
|
||||
If you go this page, it will ask you to enter a UUID in the URL. When you enter a valid UUID to the URL, it will display
|
||||
that user's punishments in JSON format. An example URL would be `/api/punishments/78408086-1991-4c33-a571-d8fa325465b2`.
|
||||
If your IP is not registered to an admin, it will not display IP addresses. If your server is using permissions, it will
|
||||
check if the player has the `plex.httpd.punishments.access` instead.
|
||||
|
||||
### /api/schematics/download
|
||||
|
||||
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`
|
||||
|
||||
@ -4,15 +4,18 @@ title: Introduction
|
||||
---
|
||||
|
||||
# Introduction
|
||||
Plex has optional modules to add additional features to your server experience. Modules are placed in the `/plugins/Plex/modules` folder. They extend off of Plex and can add or change functionality. They are designed for server owners who may want a specific feature that's not built in to Plex.
|
||||
|
||||
Plex has optional modules to add additional features to your server experience. Modules are placed in the
|
||||
`/plugins/Plex/modules` folder. They extend off of Plex and can add or change functionality. They are designed for
|
||||
server owners who may want a specific feature that's not built in to Plex.
|
||||
|
||||
Below is a list of official and supported modules
|
||||
|
||||
| Name | Versions |
|
||||
|---------------|----------|
|
||||
| BukkitTelnet | 1.4 |
|
||||
| HTTPD | 1.4 |
|
||||
| Guilds | 1.4 |
|
||||
| LibsDisguises | 1.4 |
|
||||
| NUSH | 1.4 |
|
||||
| TFMExtras | 1.4 |
|
||||
| Name | Versions |
|
||||
|---------------|--------------|
|
||||
| BukkitTelnet | 1.5 |
|
||||
| HTTPD | 1.5-SNAPSHOT |
|
||||
| LibsDisguises | 1.5-SNAPSHOT |
|
||||
| FalseOp | 1.5-SNAPSHOT |
|
||||
| NUSH | 1.5-SNAPSHOT |
|
||||
| TFMExtras | 1.5-SNAPSHOT |
|
||||
|
||||
@ -4,11 +4,19 @@ 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`
|
||||
|
||||
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.
|
||||
|
||||
43
docs/modules/nush.md
Normal file
43
docs/modules/nush.md
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
id: nush
|
||||
title: NUSH
|
||||
---
|
||||
|
||||
# NUSH
|
||||
|
||||
The NUSH (New User Silent Hush) module prevents raids from happening on servers. When a new player joins, only admins
|
||||
and themselves can see their chat messages. Admins can then choose to allow a player to chat where everyone can see it.
|
||||
Alternatively, if they start spamming, they can be banned while regular players do not see their chat messages. You can
|
||||
also set an expiration so that after a certain amount of time, they will be allowed to chat globally regardless of
|
||||
manual intervention.
|
||||
|
||||
## Permissions
|
||||
|
||||
The `plex.nush.use` permission will grant access to the NUSH command and all subcommands. The `plex.nush.view` command
|
||||
will allow people to view chat messages that are intercepted by NUSH. You would want to give both permissions to
|
||||
moderators and none to regular players.
|
||||
|
||||
## Commands
|
||||
|
||||
### nush on
|
||||
|
||||
This turns the NUSH module on. New players will be subjected to a delay before their chat messages are globally seen.
|
||||
|
||||
### nush off
|
||||
|
||||
This turns the NUSH module off. This is the default state for the NUSH module. All new players will be able to chat
|
||||
normally.
|
||||
|
||||
### nush status
|
||||
|
||||
This shows the status of NUSH. By default, it is turned off. You can check its status with this command.
|
||||
|
||||
### nush time \<duration\>
|
||||
|
||||
This sets the time that players must wait before they can chat and their messages are seen. This gives admins enough
|
||||
time to react if they immediately spam when they join.
|
||||
|
||||
### nush remove \<player\>
|
||||
|
||||
This removes a player from the NUSH list. Only new players are added, but if they are a legitimate new player during a
|
||||
raid, you can remove them, and they will be able to chat normally.
|
||||
Reference in New Issue
Block a user