Skip to content

Commit 67f7079

Browse files
committed
docs: expand delete world documentation with detailed flags and examples
1 parent ad9eeab commit 67f7079

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
---
22
title: Delete a world
33
---
4+
5+
To delete a world you can use the `/world delete <world> [<flags>]` command.
6+
This command will permanently delete the specified world, so use it with caution.
7+
8+
## Flags
9+
10+
- `--confirm`: This flag is required to confirm the deletion of the world.
11+
It is a safety measure to prevent accidental deletions.
12+
- `--schedule`: This flag schedules the deletion of the world to the server shutdown process.
13+
This option is required to be set on Folia servers, as they cannot delete worlds while they are running.
14+
Also the `minecraft:overworld` can only be scheduled as it is required to always exist during runtime.
15+
16+
## Examples
17+
18+
To simply delete a world, you can use the following command:
19+
20+
```
21+
/world delete worlds:my_world --confirm
22+
```
23+
24+
To schedule the deletion of a world, you can use:
25+
26+
```
27+
/world delete minecraft:overworld --confirm --schedule
28+
```

0 commit comments

Comments
 (0)