Skip to content

Commit 2490af9

Browse files
authored
Update to 1.20 Docs (#172)
1 parent 932b456 commit 2490af9

37 files changed

+4351
-10
lines changed

docs/paper/dev/api/event-api/event-listeners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public class ExampleListener implements Listener {
4242
:::note[Events]
4343

4444
There is no list of events that can be listened to, however take a look
45-
[here](https://jd.papermc.io/paper/1.19/org/bukkit/event/Event.html) to see all events that extend `Event`.
45+
[here](https://jd.papermc.io/paper/1.20/org/bukkit/event/Event.html) to see all events that extend `Event`.
4646

4747
An event can only be listened to if it has a static `getHandlerList` method.
4848

docs/paper/dev/getting-started/paper-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ name: Paper-Test-Plugin
2929
version: '1.0'
3030
main: io.papermc.testplugin.TestPlugin
3131
description: Paper Test Plugin
32-
api-version: '1.19'
32+
api-version: '1.20'
3333
bootstrapper: io.papermc.testplugin.TestPluginBootstrap
3434
loader: io.papermc.testplugin.TestPluginLoader
3535
```

docs/paper/dev/getting-started/plugin-yml.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ main: io.papermc.testplugin.ExamplePlugin
3131
description: An example plugin
3232
author: PaperMC
3333
website: https://papermc.io
34-
api-version: 1.19
34+
api-version: '1.20'
3535
```
3636
3737
## Fields
@@ -89,8 +89,8 @@ This will be shown in the plugin info commands.
8989

9090
The version of the Paper API that your plugin is using. This doesn't include the minor version.
9191
Servers with a version lower than the version specified here will refuse to load the plugin.
92-
The valid versions are 1.13 - 1.19.
93-
- `api-version: 1.19`
92+
The valid versions are 1.13 - 1.20.
93+
- `api-version: '1.20'`
9494
9595
:::info
9696

docs/paper/dev/getting-started/project-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ repositories {
3131
}
3232

3333
dependencies {
34-
compileOnly("io.papermc.paper:paper-api:1.19.4-R0.1-SNAPSHOT")
34+
compileOnly("io.papermc.paper:paper-api:1.20-R0.1-SNAPSHOT")
3535
}
3636

3737
java {

docs/velocity/admin/reference/server-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ we can.
1010

1111
## Compatible game versions
1212

13-
As of this writing, Velocity is compatible with Minecraft 1.7.2 through 1.19.4.
13+
As of this writing, Velocity is compatible with Minecraft 1.7.2 through 1.20.
1414

1515
## Vanilla setups
1616

docs/versioned/paper.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
["1.18"]
1+
[
2+
"1.19",
3+
"1.18"
4+
]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Welcome to the Paper Docs
2+
3+
Paper is a high performance fork of the Spigot Minecraft Server that aims to fix gameplay and
4+
mechanic inconsistencies as well as to improve performance. Paper contains numerous features, bug
5+
fixes, exploit preventions and major performance improvements not found in Spigot.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
slug: /admin
3+
---
4+
5+
import DocCardList from "@theme/DocCardList";
6+
import { useCurrentSidebarCategory } from "@docusaurus/theme-common";
7+
8+
# Paper Server Administration
9+
10+
Welcome to the Paper Server Administration Guide! This guide includes information and tutorials
11+
regarding the administration of a Paper server.
12+
13+
---
14+
15+
<DocCardList items={useCurrentSidebarCategory().items} />
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
toc_max_heading_level: 4
3+
slug: /adding-plugins
4+
---
5+
6+
# Adding Plugins
7+
8+
Plugins are the most powerful way to extend the functionality of Paper beyond the configuration
9+
files. Functionality added by plugins can range from making milk restore hunger or dead bushes grow,
10+
to adding entirely new and original game modes or items.
11+
12+
:::danger[Malicious Plugins]
13+
14+
Ensure you fully trust the source of any plugin before installing it. Plugins are given **full and
15+
unrestricted** access to not only your server but also the machine that it runs on. Because of this,
16+
it is imperative that plugins only be installed from trusted sources. Be careful!
17+
18+
:::
19+
20+
## Finding Plugins
21+
22+
Before installing a plugin, you'll need to find what you want to install. The best place to find plugins is [Hangar](https://hangar.papermc.io), Paper's plugin repository, but you can also find many plugins
23+
on [SpigotMC](https://www.spigotmc.org/resources/),
24+
[BukkitDev](https://dev.bukkit.org/bukkit-plugins), or the
25+
[PaperMC Forums](https://forums.papermc.io/forums/paper-plugin-releases/), while other plugins may
26+
release on [GitHub](https://github.com). One of the best ways to find plugins isn't to browse any of
27+
these sites directly but to search for plugins using a search engine. Searching for the function you
28+
desire followed by `Minecraft plugin` will often yield good results.
29+
30+
:::tip[Spigot and Bukkit Plugins]
31+
32+
Paper is compatible with both Spigot and Bukkit plugins. It's okay if a plugin does not explicitly
33+
mention Paper compatibility. It'll still work.
34+
35+
:::
36+
37+
## Installing Plugins
38+
39+
1. Once you've found the plugin you'd like to install, download it. Ensure the file you have
40+
downloaded ends in `.jar`. Some plugins also distribute as `.zip` files, in which case you will
41+
need to extract the file and locate the `.jar` for your platform, often labelled `bukkit` or
42+
`paper`.
43+
2. Once you have the plugin downloaded locally, locate the `plugins` folder from the root directory
44+
of your Paper server.
45+
3. Drag and drop the plugin file (`.jar`) into the `plugins` folder. If you are using a shared
46+
hosting service, you may need to use their web panel or SFTP to upload the plugin; however, the
47+
procedure will be the same.
48+
4. Restart your server. The plugin should load.
49+
5. Check your work. Once the server has finished loading, run the `/plugins` command in-game or type
50+
`plugins` into the console. You should see your freshly installed plugin listed in green. If it
51+
is not listed or is colored red, continue to [troubleshooting](#troubleshooting). A plugin listed
52+
in red means that it is not currently enabled. For a freshly installed plugin, this often means
53+
that the plugin failed to load.
54+
55+
## Troubleshooting
56+
57+
### Check your logs
58+
59+
The first step to troubleshooting installing plugins is to check the log of your server. Your
60+
server's most recent logs will be stored to the `logs/latest.log` file. You may need to scroll near
61+
the beginning of this file to see when plugins were loaded.
62+
63+
#### Missing Dependencies
64+
65+
If you see something like this:
66+
67+
```log
68+
Could not load 'plugins/MyAwesomePlugin-1.0.0.jar' in folder 'plugins'
69+
org.bukkit.plugin.UnknownDependencyException: Unknown/missing dependency plugins: [Vault]. Please download and install these plugins to run 'MyAwesomePlugin'.
70+
```
71+
72+
This means that the plugin you tried to install is missing a dependency. A dependency, in this case,
73+
is another plugin that you must install for the first to function. While you will get a big scary
74+
error, the important line to look at is
75+
76+
```log
77+
Unknown/missing dependency plugins: [Vault]. Please download and install these plugins to run 'MyAwesomePlugin'.
78+
```
79+
80+
This is telling you that in order to load `MyAwesomePlugin`, you must first install `Vault`.
81+
82+
#### Invalid plugin.yml
83+
84+
If you see something closer to this:
85+
86+
```log
87+
Could not load 'plugins/MyAwesomePlugin-1.0.0.jar' in folder 'plugins'
88+
org.bukkit.plugin.InvalidDescriptionException: Invalid plugin.yml
89+
```
90+
91+
This means that what you have downloaded isn't a valid Paper plugin. This is generally caused by one
92+
of the following:
93+
94+
1. The plugin you downloaded isn't a plugin at all, but instead a mod for Forge, Fabric, or similar.
95+
These will not run on Paper.
96+
2. The plugin failed to download completely. Especially when using tools such as `curl` or `wget`,
97+
you can easily download error pages rather than the plugin you intended. This may also be caused
98+
by a network issue. Attempt to download the plugin again. If you are using FTP (not SFTP or a web
99+
panel) to upload your plugin to a shared hosting service, ensure your FTP client is in `binary`
100+
and not `ASCII` mode. Consult the documentation for your FTP client for details.
101+
102+
#### Ambiguous plugin name
103+
104+
If you see something like this:
105+
106+
```log
107+
Ambiguous plugin name `Essentials' for files `plugins/EssentialsX-2.19.4.jar' and `plugins/Essentialsx-2.20.0-dev.jar' in `plugins'
108+
```
109+
110+
This means you have two plugins with the same name, which is not supported. In this case, two
111+
versions of EssentialsX are installed. Both the release `2.19.4`, and a development build of
112+
`2.20.0`. Ensure you only have one version of each plugin installed at one time. Delete the older
113+
version of the duplicate plugin, and restart your server.
114+
115+
[//]: # "To prevent accidentally installing two versions of one plugin while updating, you can use"
116+
[//]: # "the `update` folder as described in the [Update Guide](/paper/how-to/update)."
117+
118+
#### Something Else
119+
120+
If you see an error, but it isn't similar to one of the above, attempt to read it yourself. While
121+
the full error may be large and scary, you likely only have to read the first one or two lines to
122+
understand what is going on. If you're not sure, do not hesitate to reach out for support on our
123+
[Discord](https://discord.gg/papermc) in the `#paper-help` channel.
124+
125+
### If nothing is logged
126+
127+
If nothing is logged, your server is likely not attempting to load any plugins. The conditions
128+
needed for the server to load a plugin are as follows:
129+
130+
1. The file is at the root of the `plugins` folder, relative to its working directory. This is
131+
usually the same folder as the server JAR file. **Subdirectories of the `plugins` folder will not
132+
be checked.** All plugins must be in the root folder.
133+
2. The file ends in `.jar`. If your plugin does not end in `.jar`, what you have downloaded may not
134+
be a plugin. Note that some plugins distribute multiple jars as `.zip` files. If this is the
135+
case, you have to extract them before installing the plugin.
136+
137+
If both of these are true and you still see no logs please reach out for support on our
138+
[Discord](https://discord.gg/papermc) server in the `#paper-help` channel. We will be happy to
139+
assist you.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
slug: /getting-started
3+
---
4+
5+
# Getting Started
6+
7+
## Requirements
8+
9+
:::tip
10+
11+
With the release of Minecraft 1.18, Paper now requires **Java 17** to run. If you don't already have
12+
Java 17, [it's easy to download and install](/misc/java-install).
13+
14+
:::
15+
16+
| Paper Version | Recommended Java Version |
17+
| -------------- | ------------------------ |
18+
| 1.8 to 1.11 | Java 8 |
19+
| 1.12 to 1.16.4 | Java 11 |
20+
| 1.16.5 | Java 16 |
21+
| 1.17.1-1.18.1+ | Java 17 |
22+
23+
## Migrating to Paper
24+
25+
### From Vanilla
26+
27+
Migrating from Vanilla is easy, but there are some differences, namely in world saves. Paper (and
28+
CraftBukkit and Spigot) separate out each dimension of a world (nether, the end, etc.) into separate
29+
world folders.
30+
31+
Paper will handle this conversion for you automatically. No additional consideration is required.
32+
33+
### From Craftbukkit or Spigot
34+
35+
Paper is a drop in replacement for both CraftBukkit and Spigot, you don't need to make any changes.
36+
37+
## Downloading Paper
38+
39+
Paper provides runnable server jars directly from our
40+
[website's downloads page](https://papermc.io/downloads).
41+
42+
Click on the build number to download a file.
43+
44+
## Running The Server
45+
46+
To run the server, simply start it up like any other Java application.
47+
48+
Open your terminal, navigate to the saved location, and then run
49+
`java -Xms2G -Xmx2G -jar paper.jar --nogui`. Ensure you replace `paper.jar` with the name of the jar
50+
you have downloaded.
51+
52+
The amount of RAM can be set by changing the numbers in the `-Xms` and `-Xmx` arguments. `--nogui`
53+
disables Vanilla's GUI, so you don't get double interfaces when using the command line.
54+
55+
For more advanced Java tuning, see [Aikar's Flags](../how-to/aikars-flags.md).
56+
57+
To configure your server, see the [Global Configuration](../reference/global-configuration.md) and
58+
[Per World Configuration](../reference/world-configuration.md) pages.
59+
60+
## Updating The Server
61+
62+
Updating Paper is simple! See our [Update Tutorial](../how-to/update.md) for more information.

0 commit comments

Comments
 (0)