Skip to content

refactor: update userdev docs to improve clarity #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Leguan16 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

refactor: update userdev docs to improve clarity #787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/content/docs/paper/dev/getting-started/userdev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,20 +143,20 @@ tasks.assemble {
}
```

## 1.20.5 and beyond
### 1.20.5 and beyond

As of 1.20.5, Paper ships with a Mojang-mapped runtime instead of re-obfuscating the server to Spigot mappings.
Additionally, CraftBukkit classes will no longer be relocated into a versioned package.
This requires plugins to be deobfuscated before loading when necessary.

Most of this process is done automatically by paperweight, but there are some important things to know when using server internals (or "NMS") from now on.

### Default mappings assumption
#### Default mappings assumption
* By default, all Spigot/Bukkit plugins will be assumed to be Spigot-mapped if they do not specify their mappings namespace in the manifest.
The other way around, all Paper plugins will be assumed to be Mojang-mapped if they do not specify their mappings namespace in the manifest.
* Spigot-mapped plugins will need to be deobfuscated on first load, Mojang-mapped plugins will not.

### Compiling to Mojang mappings
#### Compiling to Mojang mappings

:::note

Expand All @@ -172,7 +172,7 @@ If you want your main output to use Mojang mappings, you need to remove all `dep
paperweight.reobfArtifactConfiguration = io.papermc.paperweight.userdev.ReobfArtifactConfiguration.MOJANG_PRODUCTION
```

### Compiling to Spigot mappings
#### Compiling to Spigot mappings

If you want your main output to use Spigot mappings, add the following code to your build script:

Expand Down
Loading