Skip to content

Commit 5351edb

Browse files
committed
feat(docs): add documentation for world recreate and regenerate commands
1 parent d21e3f8 commit 5351edb

File tree

3 files changed

+65
-1
lines changed

3 files changed

+65
-1
lines changed
Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
{
2-
"pages": ["create", "clone", "import", "load-unload", "delete", "links", "..."]
2+
"pages": [
3+
"create",
4+
"clone",
5+
"regenerate",
6+
"recreate",
7+
"import",
8+
"load-unload",
9+
"delete",
10+
"links",
11+
"..."
12+
]
313
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Recreate a world
3+
description: How to use the world recreate command.
4+
---
5+
6+
To recreate a world you can use the `/world recreate <world> <name>` command.
7+
This command creates a modified instance of the specified world.
8+
The same options as in [`/world create`](create#additional-options) apply: `bonus-chest`, `seed`, `structures`, `hardcore`, `key`, and `dimension`.
9+
If you don't specify any of these options, the recreated world will have an auto generated name and key, and the world options will be copied 1:1.
10+
11+
Example on how to recreate a world with a different seed:
12+
13+
```
14+
/world recreate <aqua>worlds:my_world</aqua> <yellow>"recreated world"</yellow> seed <green>Hawaii</green>
15+
```
16+
17+
Example on how to recreate a world without structures:
18+
19+
```
20+
/world recreate <aqua>worlds:my_world</aqua> <yellow>"recreated world"</yellow> structures <green>false</green>
21+
```
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Regenerate a world
3+
description: How to use the world regenerate command.
4+
---
5+
6+
To regenerate a world you can use the `/world regenerate <world> [<flags>]` command.
7+
This command will regenerate the specified world, so use it with caution.
8+
9+
<Callout type="error" title="Caution">
10+
11+
Regenerating a world is irreversible. Make sure to back up any important data before proceeding.
12+
The world's entire progress will be permanently deleted.
13+
14+
</Callout>
15+
16+
## Flags [!toc]
17+
18+
- `--confirm`: This flag is required to confirm the regeneration of the world.
19+
It is a safety measure to prevent accidental regenerations.
20+
- `--schedule`: This flag schedules the regeneration of the world to the server shutdown process.
21+
The regeneration of `minecraft:overworld` can only be scheduled as it is required to always exist during runtime.
22+
23+
To simply regenerate a world, you can use the following command:
24+
25+
```
26+
/world regenerate <aqua>worlds:my_world</aqua> <yellow>--confirm</yellow>
27+
```
28+
29+
To schedule the regeneration of a world, you can use:
30+
31+
```
32+
/world regenerate <aqua>minecraft:overworld</aqua> <yellow>--confirm --schedule</yellow>
33+
```

0 commit comments

Comments
 (0)