Skip to content

Commit 7c624e9

Browse files
committed
[docs] Refactor command documentation for clarity and consistency
1 parent 6147a01 commit 7c624e9

File tree

3 files changed

+165
-212
lines changed

3 files changed

+165
-212
lines changed
Lines changed: 96 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -1,222 +1,217 @@
11
<img src="Media\paradox-header.png" alt="Paradox AntiCheat Logo"> </img>
22

3-
!> This documentation could change with any version. So be sure to check it once in a while.
3+
!> This documentation could change with any version. Be sure to check it periodically for updates.
44

55
## !ban
66
### At A Glance
7-
The ban command is used to ban a player from the server, with the option to provide a reason for the ban. Additionally, it can be used to list all currently banned players. This command is an essential tool for maintaining server security and enforcing rules, ensuring a safe and enjoyable environment for all players.
7+
The `!ban` command is used to ban a player from the server, with an optional reason. It can also list all currently banned players. This command is vital for maintaining server security and enforcing rules.
88

9-
!> Required Clearance Level To Execute: 3
9+
!> Required Clearance Level To Execute: `3`
1010

1111
> ```
12-
> Usage: "!ban [ -t | --target <player> ] [ -r | --reason <reason> ] [ -l | --list ]",
12+
> Usage: "!ban [ -t | --target <player> ] [ -r | --reason <reason> ] [ -l | --list ]"
1313
> Example: !ban -t Steve Bob -r Inappropriate Behavior
1414
> Example: !ban -l
1515
> ```
1616
1717
## !command
18-
### At a Glance
19-
The `!command` command enables or disables other commands dynamically. This provides administrators with flexibility in managing which commands are active on the server. It is an essential moderation tool for customizing command availability without requiring code changes or server restarts.
18+
### At A Glance
19+
The `!command` command enables or disables other commands dynamically. This allows administrators to manage active commands without restarting the server.
2020
21-
!> Required Clearance Level To Execute: 4
21+
!> Required Clearance Level To Execute: `4`
2222
2323
> ```
24-
> Usage: "!command [ enable | disable ] <commandName1> [commandName2] ...",
24+
> Usage: "!command [ enable | disable ] <commandName1> [commandName2] ..."
2525
> Example: !command disable kick ban
2626
> Example: !command enable kick ban
2727
> ```
2828
2929
### **Options**
30-
- `enable`: Activates one or more previously disabled commands, making them available for use.
31-
- `disable`: Deactivates one or more active commands, preventing them from being executed.
32-
- `<commandName(s)>`: Specifies one or more command names to enable or disable. Multiple commands should be space-separated.
30+
- `enable`: Activates one or more previously disabled commands.
31+
- `disable`: Deactivates one or more active commands.
32+
- `<commandName(s)>`: Specifies the commands to enable or disable, space-separated.
3333
3434
### **Notes**
35-
- The `!command` command cannot be disabled itself to prevent accidental loss of administrative control.
36-
- Use the `disable` option cautiously to ensure critical commands remain functional.
37-
- This command dynamically updates the command registry, ensuring real-time changes are reflected.
38-
35+
- The `!command` command itself cannot be disabled.
36+
- Use the `disable` option with caution to avoid disabling critical commands.
37+
- The command registry updates dynamically, reflecting real-time changes.
38+
Required Clearance Level To Execute:
3939
4040
## !kick
4141
### At A Glance
42-
The kick command is used to remove a specified player from the server. This can be done with or without providing a reason for the kick. The command is useful for quickly addressing disruptive behavior or enforcing server rules.
43-
44-
!> Required Clearance Level To Execute: 3
42+
The `!kick` command removes a player from the server, with or without a reason. It's useful for addressing disruptive behavior.
4543
44+
!> Required Clearance Level To Execute: `3`
4645
4746
> ```
4847
> Usage: "!kick [ -t | --target <player> ] [ -r | --reason <reason> ]"
4948
> Example: !kick -t Pete9x -r Spamming Chat!
5049
> ```
51-
50+
Required Clearance Level To Execute:
5251
5352
## !lockdown
5453
### At A Glance
55-
The lockdown command initiates a server-wide lockdown to prevent any players who do not have a security clearance level of 4 from connecting. This command is especially useful during maintenance or when the server is under attack, ensuring that only high-clearance administrators can access the server while the lockdown is in effect.
56-
57-
!> Required Clearance Level To Execute: 4
54+
The `!lockdown` command prevents players without a security clearance of 4 from connecting to the server, useful for maintenance or during attacks.
5855
56+
!> Required Clearance Level To Execute: `4`
5957
6058
> ```
61-
> Usage: "!lockdown [ optional ]"
59+
> Usage: "!lockdown [optional]"
6260
> Example: !lockdown
6361
> ```
64-
62+
Required Clearance Level To Execute:
6563
6664
## !deop
6765
### At A Glance
68-
The deop command is used to remove Paradox-Op permissions from a player, effectively revoking their security clearance level 4 status. By using this command, administrators can ensure that only the appropriate individuals retain access to the highest levels of server permissions.
66+
The `!deop` command revokes Paradox-Op permissions from a player, reducing their clearance level to 3 or lower.
6967
70-
!> Required Clearance Level To Execute: 4
68+
!> Required Clearance Level To Execute: `4`
7169
7270
> ```
73-
> usage: "!deop <player>",
74-
> examples: !deop Peye9xi
71+
> Usage: "!deop <player>"
72+
> Example: !deop Peye9xi
7573
> ```
76-
77-
74+
Required Clearance Level To Execute:
7875
7976
## !despawn
8077
### At A Glance
81-
The despawn command is used to remove entities from the game world. It can be applied to either all entities or a specified type, depending on the parameters provided. This command is essential for managing entity populations, reducing server lag, or addressing specific gameplay situations.
78+
The `!despawn` command removes entities from the game, either all entities or a specific type. It helps with managing entity populations and improving server performance.
8279
83-
!> Required Clearance Level To Execute: 3
80+
!> Required Clearance Level To Execute: `3`
8481
85-
>```
82+
> ```
8683
> Usage: "!despawn <entity_type | all>"
87-
>Example: !despawn all
88-
>Example: !despawn iron_golem
89-
>Example: !despawn help
90-
>```
84+
> Example: !despawn all
85+
> Example: !despawn iron_golem
86+
> Example: !despawn help
87+
> ```
88+
Required Clearance Level To Execute:
9189
9290
## !gui
9391
### At A Glance
94-
The GUI command provides access to an interactive menu for managing server settings, player actions, and other administrative tasks. This is designed to streamline complex administrative functions into an easy-to-use interface.
92+
The `!gui` command provides access to an interactive administrative menu, simplifying server management tasks.
9593
96-
!> Required Clearance Level To Execute: 1
94+
!> Required Clearance Level To Execute: `1`
9795
9896
> ```
9997
> Usage: "!gui"
10098
> Example: !gui
10199
> ```
102100
103101
### **Notes**
104-
- The GUI command is optimized for rapid server administration and reduces potential for input errors.
105-
- Requires appropriate permissions for specific actions within the GUI.
106-
- Works best on supported platforms with input and display capabilities (e.g., desktop versions of Minecraft Bedrock).
102+
- Optimized for rapid server administration, minimizing input errors.
103+
- Requires appropriate permissions for specific actions.
104+
- Best on supported platforms (e.g., desktop versions of Minecraft Bedrock).
105+
Required Clearance Level To Execute:
107106
108107
## !op
109108
### At A Glance
110-
The op command is used to grant a player Paradox-Op status within the server, providing them with elevated permissions and access.
109+
The `!op` command grants Paradox-Op status to a player, providing elevated permissions.
111110
112-
!> Required Clearance Level To Execute: 4
111+
!> Required Clearance Level To Execute: `4`
113112
114113
### Initial Setup and Security
115-
During the initial setup of Paradox, the server owner will be presented with a secure OP Configuration Interface. This interface allows the owner to establish a new password, which will serve as the security key for all future OP-related actions.
116-
117-
This password is critical for managing server permissions and should be kept secure. Once set, it is used to grant Paradox-Op status to players through the !op command.
114+
Upon setting up Paradox, the server owner must set a secure OP password for future administrative actions.
118115
119116
### Security Clearance Levels
120-
Players who are granted Paradox-Op status using the !op command are assigned a security clearance level of 4. This level signifies a high degree of trust and grants the player significant administrative privileges within the server.
121-
122-
### !op list
123-
The !op list command is used to display a list of all players who currently hold a security clearance level 4, this command allows administrators to quickly see who has a clearance level of 4.
117+
- **Level 4**: Paradox-Op status, granting full administrative control.
124118
119+
### `!op list`
120+
The `!op list` command displays all players with security clearance level 4.
125121
126122
> ```
127123
> Usage: "!op <player> | !op list"
128-
> !op Pete9xi
124+
> Example: !op Pete9xi
129125
> ```
130-
126+
Required Clearance Level To Execute:
131127
132128
## !opsec
133129
### At A Glance
134-
The opsec command allows server administrators to change a player's security clearance level. This command is used to adjust the permissions and access rights of players, ensuring they have the appropriate level of authority within the server.
130+
The `!opsec` command allows administrators to modify a player's security clearance level, adjusting their permissions and access rights.
135131
136-
!> Required Clearance Level To Execute: 4
132+
!> Required Clearance Level To Execute: `4`
137133
138-
### Levels Of Clarence
139-
- Level 1: Basic permissions, typically for regular players.
140-
- Level 2: Enhanced permissions, often for moderators.
141-
- Level 3: Advanced permissions, suitable for senior moderators or co-admins.
142-
- Level 4: Paradox-Op status, granting full administrative privileges.
134+
### **Levels of Clearance**
135+
- **Level 1**: Basic permissions (regular players).
136+
- **Level 2**: Enhanced permissions (moderators).
137+
- **Level 3**: Advanced permissions (senior moderators).
138+
- **Level 4**: Paradox-Op status (full administrative privileges).
143139
144140
> ```
145-
> Usage: "!opsec <player> <clearance>"
146-
> examples: !opsec tim123 3
141+
> Usage: "!opsec <player> <clearance>"
142+
> Example: !opsec tim123 3
147143
> ```
148-
144+
Required Clearance Level To Execute:
149145
150146
## !prefix
151147
### At A Glance
152-
The prefix command is used to change the prefix for commands on the server. This allows customization of the command prefix to suit the preferences of the server administrators. The maximum length for the prefix is two characters.
148+
The `!prefix` command allows administrators to change the prefix used for commands on the server.
153149
154-
!> Required Clearance Level To Execute: 2
150+
!> Required Clearance Level To Execute: `2`
155151
156152
> ```
157-
> Usage: "!prefix [ optional ]"
158-
> Example: !prefix @@
159-
> Example: !prefix $
153+
> Usage: "!prefix [optional]"
154+
> Example: !prefix @@
155+
> Example: !prefix $
160156
> ```
161-
157+
Required Clearance Level To Execute:
162158
163159
## !punish
164160
### At A Glance
165-
The punish command is used to remove items from a specified player's inventory, equipment, and/or ender chest. This command can be utilized as a disciplinary action to manage player behavior by clearing different types of storage.
161+
The `!punish` command removes items from a player's inventory, equipment, or ender chest, acting as a disciplinary tool.
166162
167-
!> Required Clearance Level To Execute: 4
163+
!> Required Clearance Level To Execute: `4`
168164
169165
> ```
170-
> Usage: "!punish <player> [ --inventory | -i ] [ --equipment | -e ] [ --enderchest | -ec ]"
171-
>
172-
> Example: !punish Player Name
173-
> Example: !punish "Player Name" --inventory
174-
> Example: !punish Player Name -i
175-
> Example: !punish Player Name --equipment
176-
> Example: !punish Player Name -e
177-
> Example: !punish Player Name --enderchest
178-
> Example: !punish Player Name -ec
179-
> Example: !punish "Player Name" --inventory --equipment --enderchest
180-
> Example: !punish "Player Name" -i -e -ec
181-
> Example: !punish help
166+
> Usage: "!punish <player> [ --inventory | -i ] [ --equipment | -e ] [ --enderchest | -ec ]"
167+
> Example: !punish Player Name
168+
> Example: !punish "Player Name" --inventory
169+
> Example: !punish Player Name -i
170+
> Example: !punish Player Name --equipment
171+
> Example: !punish Player Name -e
172+
> Example: !punish Player Name --enderchest
173+
> Example: !punish Player Name -ec
174+
> Example: !punish "Player Name" --inventory --equipment --enderchest
175+
> Example: !punish "Player Name" -i -e -ec
176+
> Example: !punish help
182177
> ```
183-
178+
Required Clearance Level To Execute:
184179
185180
## !tpa
186181
### At A Glance
187-
The tpa command facilitates teleportation between players by allowing one player to teleport to another or vice versa. This command is useful for quickly moving players to different locations or assisting with coordination on the server. This is in place as an alternative to granting Moderators Server Op access.
182+
The `!tpa` command allows players to teleport to one another, streamlining coordination.
188183
189-
!> Required Clearance Level To Execute: 3
184+
!> Required Clearance Level To Execute: `3`
190185
191186
> ```
192-
> Usage: "!tpa <player> <player>",
193-
> Example: !tpa Lucy Steve
194-
> Example: !tpa @Steve @Lucy
187+
> Usage: "!tpa <player> <player>"
188+
> Example: !tpa Lucy Steve
189+
> Example: !tpa @Steve @Lucy
195190
> ```
196-
191+
Required Clearance Level To Execute:
197192
198193
## !unban
199194
### At A Glance
200-
The unban command is used to lift the ban on a previously banned player, allowing them to rejoin the server. This command is essential for administrators to reverse bans that were either mistakenly applied or have since been resolved. It works by adding the player to a queue, when that player rejoins the server the ban on them will be removed.
195+
The `!unban` command lifts a ban from a player, enabling them to rejoin the server.
201196
202-
!> Required Clearance Level To Execute: 3
197+
!> Required Clearance Level To Execute: `3`
203198
204199
> ```
205-
> Usage: "!unban <player>"
206-
> Example: !unban Steve
200+
> Usage: "!unban <player>"
201+
> Example: !unban Steve
207202
> ```
208-
203+
Required Clearance Level To Execute:
209204
210205
## !vanish
211206
### At A Glance
212-
The vanish command allows a player to become invisible, enabling them to monitor online players without being detected. This is a useful tool for moderators to observe player behavior discreetly.
207+
The `!vanish` command makes a player invisible, allowing them to monitor the server without detection.
213208
214-
!> Required Clearance Level To Execute: 2
209+
!> Required Clearance Level To Execute: `2`
215210
216-
### How it works
217-
The vanish command works by changing the specified player's game mode to spectator mode, effectively making them invisible to other players.
211+
### **How It Works**
212+
The `!vanish` command puts the player into spectator mode, rendering them invisible to others.
218213
219214
> ```
220-
> Usage: "!vanish <player>"
221-
> Example: !vanish Pete9xi
215+
> Usage: "!vanish <player>"
216+
> Example: !vanish Pete9xi
222217
> ```

0 commit comments

Comments
 (0)