Skip to content

Commit b6e60a2

Browse files
committed
chore(paper): update migration guide
1 parent fc0e714 commit b6e60a2

1 file changed

Lines changed: 58 additions & 37 deletions

File tree

src/content/docs/paper/admin/getting-started/migration.md

Lines changed: 58 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,6 @@ See our [Backup Guide](/paper/updating#step-1-backup) for more information.
1616

1717
## Migrating to Paper
1818

19-
### From CraftBukkit or Spigot
20-
21-
It's easy to migrate from CraftBukkit or Spigot to Paper. Follow the steps below.
22-
23-
1. Stop your server if it is running, and create a full backup.
24-
2. Download Paper from [our downloads page](https://papermc.io/downloads).
25-
3. Rename the downloaded file to match the name specified in the [start command](/paper/getting-started#running-the-server).
26-
4. Replace your existing JAR file with your freshly downloaded Paper JAR.
27-
5. Start your new server.
28-
29-
Up until 1.20.5, Paper retained full compatibility with all Spigot plugins. However, plugins using Spigot API
30-
added **after** 1.20.5 version will not work. Such plugins may often provide Paper-compatible builds. If they
31-
do not do that, you will need to look for alternatives. However, nowadays most plugins are built and tested
32-
against Paper, so you typically will not encounter incompatible plugins.
33-
34-
:::note
35-
36-
Your new Paper server will still use [`bukkit.yml`](/paper/reference/bukkit-configuration)
37-
and [`spigot.yml`](/paper/reference/spigot-configuration).
38-
New configuration options can be found in [`config/paper-global.yml`](/paper/reference/global-configuration)
39-
and [`config/paper-world-defaults.yml`](/paper/reference/world-configuration).
40-
41-
:::
42-
43-
If you have any issues migrating from CraftBukkit or Spigot, do not hesitate to reach out for
44-
support on [our Discord server](https://discord.gg/papermc) (`#paper-help` channel).
45-
4619
### From Vanilla
4720

4821
When migrating to Paper from Vanilla, the way worlds are stored will automatically be changed.
@@ -52,7 +25,8 @@ closely, as manual changes will be required.
5225
1. Stop your Vanilla server if it is running, and create a full backup.
5326
2. Download Paper from [our downloads page](https://papermc.io/downloads) and replace your Vanilla
5427
server JAR with your freshly downloaded Paper JAR.
55-
3. Rename the downloaded file to match the name specified in the [start command](/paper/getting-started#running-the-server).
28+
3. Rename the downloaded file to match the name specified in
29+
the [start command](/paper/getting-started#running-the-server).
5630
4. Start your new Paper server.
5731

5832
You have now successfully migrated to Paper. If you encounter any issues, do not hesitate to reach
@@ -69,10 +43,59 @@ Additionally, note that Paper does not support Fabric or Forge mods. You will ne
6943
replacements. Any hybrids that attempt to support both mods and plugins are fundamentally flawed and
7044
not recommended for use.
7145

46+
### From Spigot/CraftBukkit
47+
48+
Spigot and CraftBukkit modify the Vanilla world directory structure, making a direct migration
49+
fundamentally impossible. If you wish to migrate from Spigot/CraftBukkit anyway, you will
50+
first need to **migrate from Spigot/CraftBukkit to Vanilla**, after which you can safely follow
51+
the [Vanilla Migration Guide](#from-vanilla). For instructions on how to do this, please
52+
refer to the Spigot documentation.
53+
7254
## Migrating from Paper
7355

7456
### To Vanilla
7557

58+
Because Paper shares a similar world structure to Vanilla, all you need to do is move around some files.
59+
The following list shows which files you will need to move where. **Before you move around any files,
60+
make sure your server is fully stopped**.
61+
62+
:::note
63+
64+
These steps assume a `level-name` (as set in `server.properties`) of `world`. If this is not the
65+
case for you, replace `world` with your `level-name` for all steps below.
66+
67+
:::
68+
69+
The following files will need to be moved **from** `world/dimensions/minecraft/overworld/data/minecraft/`
70+
**into** `world/data/minecraft/`:
71+
72+
- `game_rules.dat`
73+
- `scheduled_events.dat`
74+
- `wandering_trader.dat`
75+
- `weather.dat`
76+
- `world_gen_settings.dat`
77+
78+
After you have moved these files, you can now replace the Paper server JAR with a Vanilla server JAR
79+
and start your Vanilla server!
80+
81+
### To Fabric/Forge
82+
83+
Because both Fabric and Forge use the same directory structure for world storage as Vanilla, follow
84+
the [Vanilla Migration Guide](#to-vanilla) for this process. Note that neither Fabric nor Forge will
85+
support Paper plugins! You will be required to find replacement mods.
86+
87+
## Other Migration
88+
89+
:::caution
90+
91+
The guides below display outdated information no longer relevant for modern Paper servers. They are
92+
kept for historical purposes and people still using older versions. Please note that you will
93+
**not receive support for using outdated versions.**
94+
95+
:::
96+
97+
### To Vanilla (pre 26.1)
98+
7699
Because Paper stores worlds slightly differently than Vanilla, manual work is required to migrate.
77100
If these steps are not taken, your nether and end will look like they have been reset. Don't worry!
78101
Even if this has happened, you haven't lost any data. The Vanilla server just doesn't know where to
@@ -81,7 +104,7 @@ find it.
81104
Here is a chart to show the difference between how Vanilla and Paper store worlds.
82105

83106
| Server Software | Overworld | Nether | End |
84-
| --------------- | --------- | --------------------- | --------------------- |
107+
|-----------------|-----------|-----------------------|-----------------------|
85108
| Vanilla | `/world` | `/world/DIM-1` | `/world/DIM1` |
86109
| Paper | `/world` | `/world_nether/DIM-1` | `/world_the_end/DIM1` |
87110

@@ -104,14 +127,12 @@ case for you, replace `world` with your `level-name` for all steps below.
104127
6. Replace your Paper JAR with a Vanilla server JAR.
105128
7. Start your Vanilla server.
106129

107-
### To CraftBukkit or Spigot
130+
### To/From CraftBukkit or Spigot
108131

109-
Paper does **not** support migration to either CraftBukkit or Spigot! While you may find success
110-
(both CraftBukkit and Spigot use the same directory structure as Paper), **do not** reach out for
132+
Paper does **not** support migration from or to either CraftBukkit or Spigot!
133+
While you may find success, **do not** reach out for
111134
support with issues you encounter and note that data loss is possible.
112135

113-
### To Fabric/Forge
114-
115-
Because both Fabric and Forge use the same directory structure for world storage as Vanilla, follow
116-
the [Vanilla Migration Guide](#to-vanilla) for this process. Note that neither Fabric nor Forge will
117-
support Paper plugins! You will be required to find replacement mods.
136+
Historically, migrating from Spigot to Paper was possible due to a shared directory structure
137+
(`1.21.11` and older), however since `26.1`, Paper's world directory structure has been
138+
altered to more closely match Vanilla, which made migrating from or to Spigot/CraftBukkit no longer possible.

0 commit comments

Comments
 (0)