Skip to content

Commit 1df4c9e

Browse files
committed
feat: document remaining commands
1 parent a1d6966 commit 1df4c9e

File tree

5 files changed

+112
-18
lines changed

5 files changed

+112
-18
lines changed

astro.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ export default defineConfig({
149149
],
150150
},
151151
"paper/reference/paper-plugins",
152-
"paper/reference/paper-command",
152+
"paper/reference/commands",
153153
"paper/reference/system-properties",
154154
"paper/reference/permissions",
155155
],
13.9 KB
Loading
18.8 KB
Loading
26.2 KB
Loading

src/content/docs/paper/admin/reference/paper-command.mdx renamed to src/content/docs/paper/admin/reference/commands.md

Lines changed: 111 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,107 @@
11
---
2-
title: The Paper command
3-
slug: paper/reference/paper-command
2+
title: Commands in Paper
3+
slug: paper/reference/commands
44
description: Documentation about the /paper command and its subcommands.
55
version: 1.21.8
66
---
77

8-
This page explains the subcommands of the in-game `/paper` command.
8+
This page explains all commands which are added by Paper.
99

10-
## chunkinfo
10+
## Bukkit commands
11+
12+
These commands are located under the `bukkit:` namespace.
13+
14+
### version (aliases: ver, about)
15+
16+
The version command displays the version information about the server, the output may look like this:
17+
18+
![](./assets/version-command-output.png)
19+
20+
You can also use this command to display version information about specific plugins.
21+
22+
![](./assets/plugin-version-command-output.png)
23+
24+
### plugins (alias: pl)
25+
26+
The plugins command displays the list of all loaded plugins. Paper differentiates between two types of
27+
plugins: **Paper plugins** and **Bukkit plugins**. The difference is generally only relevant to plugin
28+
developers ([guide to paper-plugin.yml](/paper/dev/getting-started/paper-plugins)). Plugins are marked
29+
as **green** if no issues occurred whilst enabling them and their functionality can be assumed working.
30+
Plugins marked **red** failed to load or were disabled. Check the startup logs for more information if
31+
that happens.
32+
33+
Bukkit plugins furthermore have the possibility of being loaded **with legacy support** enabled. These
34+
are marked with a **yellow star** in front of their name. That usually means the plugin was made for a
35+
very old version of the game or the plugin author simply forgot to specify a target Minecraft version
36+
for their plugin.
37+
38+
You can click on the plugins' names to display version information about that plugin. The click action
39+
is equivalent to running `/version <plugin_name>`.
40+
41+
![](./assets/plugins-command-output.png)
42+
43+
### help (alias: ?)
44+
45+
The help command displays descriptions for all registered commands. It acts
46+
as a quick reference to both built-in commands and any plugin-added commands.
47+
48+
### reload (alias: spigot reload)
49+
50+
:::danger[Deprecation]
51+
52+
The reload command is deprecated for removal. You should instead restart your server
53+
if you wish to update your plugins, as the reload is known for causing issues with plugins.
54+
55+
If you are looking to reload the Paper configs, you can use [/paper reload](#reload).
56+
57+
:::
58+
59+
## Performance profiling
60+
61+
The `/mspt` and `/tps` commands, whilst working fine, are superseeded by the `/spark` command,
62+
and you should therefore switch to the `/spark` command instead.
63+
64+
### spark
65+
66+
The only command you should rely on for performance information is the `/spark` command.
67+
The spark subcommands are documented [in the dedicated spark wiki](https://spark.lucko.me/docs/Command-Usage).
68+
69+
### tps
70+
71+
The tps command is a simple command to get the TPS (ticks per second, how often the game loop
72+
is run per second. The higher, the better. Target TPS is 20.0) from the past 1, 5, and 15 minutes.
73+
74+
### mspt
75+
76+
The mspt command is another simple command to get the average, min, and max MSPT (milliseconds per tick, how much time
77+
a tick takes. The lower, the better. MSPT should be below 50 for 20 TPS) of the server from the last 5, 10, and 60 seconds.
78+
79+
### timings
80+
81+
:::danger[Deprecation]
82+
83+
The timings command is deprecated for removal. You should instead use the [spark command](#spark) as a replacement.
84+
85+
More information can be viewed here: https://github.com/PaperMC/Paper/discussions/10565.
86+
87+
:::
88+
89+
## restart
90+
91+
The `/restart` command is part of Spigot's restart mechanism, which makes the server restart when it crashes
92+
or the command is run manually.
93+
94+
:::note
95+
96+
For help setting up the restart script, see
97+
[this gist by Prof_Bloodstone](https://gist.github.com/Prof-Bloodstone/6367eb4016eaf9d1646a88772cdbbac5).
98+
99+
:::
100+
101+
## paper
102+
This section is dedicated to the subcommands of the in-game `/paper` command.
103+
104+
### chunkinfo
11105
The `/paper chunkinfo [<worldname>]` command is used for displaying information about loaded chunks in a world.
12106
You can specify the world to get info about with the `[<worldname>]` argument. If you set it to `*` or leave it
13107
out, it will list information for all worlds.
@@ -21,28 +115,28 @@ A more complete documentation may be found in the [Minecraft wiki](https://minec
21115
- `Block Ticking` All game aspects work as expected, except that entities are not spawned naturally or ticked, but still accessible. Also called **lazy chunks**.
22116
- `Entity Ticking` The chunk is being ticked fully.
23117

24-
## debug
118+
### debug
25119
The `/paper debug <chunks>` command is used to dump information about all currently loaded chunks to a file. The content
26120
of this file is generally irrelevant for most server admins and is intended to be used by developers.
27121

28-
## dumpitem
122+
### dumpitem
29123
The `/paper dumpitem [all]` command can be used to retrieve the data component representation of your currently held
30124
item. Simply running `/paper dumpitem` will yield the item data, which you can use to represent this item in
31125
commands which expect an item argument. `/paper dumpitem all` yields the **full data component representation**,
32126
including default data components you do not have to explicitly declare.
33127

34-
## dumplisteners
128+
### dumplisteners
35129
The `/paper dumplisteners toFile|<className>` command is primarily intended for developers trying to figure out why
36130
their event handlers might not be working as expected. Using `/paper dumplisteners toFile` will write all
37131
currently registered event handlers to a file, whilst `/paper dumplisteners <className>` will print the registered
38132
event handlers only for the specific event.
39133

40-
## dumpplugins
134+
### dumpplugins
41135
The `/paper dumpplugins` command is intended for developers trying to figure out issues with their dependencies or
42136
loading order in relation to other plugins. It can also be used to debug bootstrapper providers, general load order,
43137
and listing class loaders for the plugins.
44138

45-
## entity
139+
### entity
46140
The `/paper entity list [<filter>] [<world>]` command can be used to list all currently ticking entities.
47141

48142
The `[<filter>]` argument is used to filter the listed entities types and acts similar to a **regular expression**:
@@ -67,17 +161,17 @@ Total Ticking: -78, Total Non-Ticking: 92
67161

68162
The comment at the end already clearly describes the purpose of the numbers.
69163

70-
## fixlight
164+
### fixlight
71165
The `/paper fixlight` command is a simple command to trigger a full re-calculation of the light map of all currently
72166
loaded chunks. This can be used to fix any lighting issues which commonly occur with plugins like WorldEdit.
73167

74-
## heap
168+
### heap
75169
The `/paper heap` is a developer debug command to dump the current JVM heap to a `.hprof` file, which can be analyzed
76170
to detect to amount of memory used by certain objects. The output file can be rather big, so having a bit of free
77171
space on your disk is recommended before running this command (as a general rule, the file is usually smaller
78172
than the currently used memory. You can check the memory consumption using the `/spark healthreport` command).
79173

80-
## holderinfo
174+
### holderinfo
81175
The `/paper holderinfo [<world>]` command is used to gather the number of different chunks currently held in memory.
82176

83177
The `[<world>]` argument can be used to define the world to get the chunk holder information for. Leave blank to
@@ -91,22 +185,22 @@ In general, the types have the following meanings:
91185
- `Proto` A "prototype" chunk, which is a fully working chunk loaded in memory, but which is not currently placed in the world.
92186
- `Full` Represents the number of chunks currently placed in the world.
93187

94-
## mobcaps
188+
### mobcaps
95189
Not to be confused with the [playermobcaps](#playermobcaps) subcommand, the `/paper mobcaps [<world>]` command displays
96190
the **global** mob caps for all players in a world. The `[<world>]` argument defaults to the overworld and
97191
can be set to retrieve the mob caps for other worlds as well. The command also lists the number of
98192
chunks in which mobs can spawn.
99193

100-
## playermobcaps
194+
### playermobcaps
101195
The `/paper playermobcaps [<player>]` command is used to list the local mob caps for a specific player. The `[<player>]`
102196
argument defaults to the player, who ran the command, if one exists.
103197

104-
## reload
198+
### reload
105199
The `/paper reload` command is an unsupported command which allows for runtime Paper-config reloading. If you get any issues
106200
after using this command, please make sure to reproduce this on a freshly-started server before asking for help or
107201
reporting it. Do not that this command **does not** reload non-Paper configs, like the `spigot.yml`.
108202

109-
## syncloadinfo
203+
### syncloadinfo
110204
The `/paper syncloadinfo [clear]` command requires the `-Dpaper.debug-sync-loads=true` JVM flag to be explicitly set
111205
before running the command. The command was historically used for debugging purposes during Paper development, but
112206
the mechanism behind the command is currently unused, meaning that the written file will **always** look
@@ -120,5 +214,5 @@ like this:
120214

121215
Outside of checking for whether the command is allowed to be run, the JVM flag is otherwise unused.
122216

123-
## version
217+
### version
124218
The `/paper version` command is an alias to the standard `/version` command.

0 commit comments

Comments
 (0)