Skip to content

Commit 0fcb0fd

Browse files
committed
Add CreativeUtilities documentation
1 parent b7dd1e4 commit 0fcb0fd

File tree

6 files changed

+209
-16
lines changed

6 files changed

+209
-16
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Commands
3+
description: All available commands and their aliases
4+
---
5+
6+
## Utility Commands
7+
8+
| Command | Aliases | Permission | Description |
9+
|----------------|-------------------|----------------------------------|------------------------------------------------------------------------|
10+
| `/advancedfly` | `/advfly`, `/fly` | `builders.util.advancedfly` | Removes velocity when stopping mid-air instead of continuing to move |
11+
| `/armorcolor` | `/color` | `builders.util.color` | Color armor pieces using a GUI |
12+
| `/banner` | `/bm` | `builders.util.banner` | Design banners with patterns and colors using a GUI |
13+
| `/nightvision` | `/nv`, `/n` | `builders.util.nightvision` | Toggle night vision to see in the dark |
14+
| `/noclip` | `/nc` | `additions.command.no-clip` | Fly through blocks like spectator mode while still being able to build |
15+
| `/pottery` | | `builders.util.pottery-designer` | Open the pottery designer GUI |
16+
| `/utils` | `/butil`, `/bu` | `builders.util.gui` | Open a GUI to manage all features |
17+
18+
## FastAsyncWorldEdit Shortcuts
19+
20+
These commands provide convenient abbreviations for common FAWE operations.
21+
22+
| Command | Aliases | Permission | Description |
23+
|---------------------------|---------|---------------------------|---------------------------------------------------------------|
24+
| `/convex` | `/con` | `worldedit.analysis.sel` | Change selection type to convex |
25+
| `/cuboid` | `/cub` | `worldedit.analysis.sel` | Change selection type to cuboid |
26+
| `/derot <axis> <degrees>` | | `worldedit.region.deform` | Rotate selected region around an axis by specified degrees |
27+
| `/scale <size>` | | `worldedit.region.deform` | Scale the selected region by the defined factor |
28+
| `/twist <axis> <degrees>` | | `worldedit.region.deform` | Twist the selected region around an axis by specified degrees |
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Configuration
3+
description: Configure block physics, redstone, weather and more
4+
---
5+
6+
All configuration options are stored in a JSON file using kebab-case naming.
7+
8+
## Options
9+
10+
| Option | Description |
11+
|-------------------------------|---------------------------------------------------------------------------------------------------------|
12+
| `disable-explosions` | Disable all explosions |
13+
| `disable-fading` | Disable block fading (fire burning out, coral dying without water, etc.) |
14+
| `disable-gravity` | Disable gravity for affected blocks (e.g., sand and gravel won't fall) |
15+
| `disable-leaves-decay` | Disable leaves decaying over time when not connected to a log |
16+
| `disable-physics` | Disable block physics (blocks like lanterns, ladders, and torches won't require adjacent block support) |
17+
| `disable-redstone` | Disable redstone functionality |
18+
| `disable-soil-trample` | Disable farmland trampling |
19+
| `disable-weather-changes` | Disable weather changes in all worlds |
20+
| `piston-sliming` | Right-click a piston with a slime ball to convert it to a sticky piston |
21+
| `fix-attack-speed` | Allows faster block breaking |
22+
| `prevent-dragon-egg-teleport` | Prevent dragon eggs from teleporting when right-clicked |
23+
24+
## Example Configuration
25+
26+
```json
27+
{
28+
"disable-explosions": true,
29+
"disable-fading": true,
30+
"disable-gravity": false,
31+
"disable-leaves-decay": true,
32+
"disable-physics": false,
33+
"disable-redstone": false,
34+
"disable-soil-trample": true,
35+
"disable-weather-changes": true,
36+
"piston-sliming": true,
37+
"fix-attack-speed": true,
38+
"prevent-dragon-egg-teleport": true
39+
}
40+
```
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Features
3+
description: Interactive features and gameplay tweaks
4+
---
5+
6+
## Interactive Features
7+
8+
### Iron Door Interaction
9+
10+
Right-click iron doors and iron trapdoors to open and close them, just like their wooden counterparts.
11+
12+
### Custom Slab Breaking
13+
14+
When breaking a double slab, only the half you're actually looking at will be destroyed instead of both parts.
15+
16+
### Air Placing
17+
18+
Place blocks directly in the air or even underwater without needing an adjacent block for support.
19+
20+
## Player Modes
21+
22+
### Night Vision
23+
24+
Toggle permanent night vision to see clearly in dark areas without needing potions.
25+
26+
**Command:** `/nightvision` (`/nv`, `/n`)
27+
28+
### No Clip
29+
30+
Fly through solid blocks like spectator mode while retaining the ability to place and break blocks like in creative mode.
31+
32+
**Command:** `/noclip` (`/nc`)
33+
34+
### Advanced Fly
35+
36+
When enabled, your velocity is instantly removed when you stop flying mid-air, allowing for precise positioning without drifting.
37+
38+
**Command:** `/advancedfly` (`/advfly`, `/fly`)
39+
40+
## GUIs
41+
42+
### Armor Color Designer
43+
44+
Color leather armor pieces using an intuitive color picker interface.
45+
46+
**Command:** `/armorcolor` (`/color`)
47+
48+
### Banner Designer
49+
50+
Create complex banner designs with various patterns and colors without needing a loom.
51+
52+
**Command:** `/banner` (`/bm`)
53+
54+
### Pottery Designer
55+
56+
Design decorated pots with custom patterns using a visual interface.
57+
58+
**Command:** `/pottery`
59+
60+
### Utilities Menu
61+
62+
Access all features from a central GUI menu.
63+
64+
**Command:** `/utils` (`/butil`, `/bu`)
Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
11
---
22
title: Overview
3-
description: Utilities that help you building in creative mode
3+
description: Quality of life tools for builders and creative players
44
icon: BookMarked
55
---
66

7-
Coming Soon!
7+
import { Settings, Terminal, Shield, Sparkles } from "lucide-react"
8+
9+
CreativeUtilities provides a collection of quality of life features for builders and creative players,
10+
including block physics toggles, custom GUIs, and convenient command shortcuts.
11+
12+
<Cards>
13+
<Card
14+
title="Features"
15+
description="Interactive features and gameplay tweaks"
16+
href="/docs/creativeutilities/features"
17+
icon={<Sparkles />}
18+
target="_self"
19+
/>
20+
<Card
21+
title="Commands"
22+
description="All available commands and their aliases"
23+
href="/docs/creativeutilities/commands"
24+
icon={<Terminal />}
25+
target="_self"
26+
/>
27+
<Card
28+
title="Permissions"
29+
description="Permission nodes for all features"
30+
href="/docs/creativeutilities/permissions"
31+
icon={<Shield />}
32+
target="_self"
33+
/>
34+
<Card
35+
title="Configuration"
36+
description="Configure block physics, redstone, weather and more"
37+
href="/docs/creativeutilities/configuration"
38+
icon={<Settings />}
39+
target="_self"
40+
/>
41+
</Cards>
Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
{
2-
"root": true,
3-
"title": "CreativeUtilities",
4-
"description": "Utilities that help you building in creative mode",
5-
"icon": "BrickWall",
6-
"pages": [
7-
"---Links---",
8-
"external:[Github][GitHub](https://github.com/TheNextLvl-net/creative-utilities)",
9-
"external:[Download][Download](https://modrinth.com/project/zAcZq5oV#download)",
10-
"external:[ChartLine][Metrics](https://bstats.org/plugin/bukkit/TheNextLvl%20CreativeUtilities/22858)",
11-
"---Introduction---",
12-
"index",
13-
"faq",
14-
"---Guide---"
15-
]
2+
"root": true,
3+
"title": "CreativeUtilities",
4+
"description": "Quality of life tools for builders",
5+
"icon": "BrickWall",
6+
"pages": [
7+
"---Links---",
8+
"external:[Github][GitHub](https://github.com/TheNextLvl-net/creative-utilities)",
9+
"external:[Download][Download](https://modrinth.com/project/zAcZq5oV#download)",
10+
"external:[ChartLine][Metrics](https://bstats.org/plugin/bukkit/TheNextLvl%20CreativeUtilities/22858)",
11+
"---Introduction---",
12+
"index",
13+
"---Guide---",
14+
"features",
15+
"commands",
16+
"permissions",
17+
"configuration"
18+
]
1619
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Permissions
3+
description: Permission nodes for all features
4+
---
5+
6+
## Utility Permissions
7+
8+
| Permission | Description |
9+
|----------------------------------|----------------------------------|
10+
| `builders.util.advancedfly` | Use the advanced fly command |
11+
| `builders.util.color` | Color armor using the GUI |
12+
| `builders.util.banner` | Design banners using the GUI |
13+
| `builders.util.nightvision` | Toggle night vision |
14+
| `additions.command.no-clip` | Use no-clip mode |
15+
| `builders.util.pottery-designer` | Use the pottery designer GUI |
16+
| `builders.util.gui` | Access the main utilities GUI |
17+
| `builders.util.tpgm3` | Teleport while in spectator mode |
18+
19+
## WorldEdit Permissions
20+
21+
| Permission | Description |
22+
|---------------------------|-------------------------------------------|
23+
| `worldedit.analysis.sel` | Change selection type (convex/cuboid) |
24+
| `worldedit.region.deform` | Use deform commands (derot, scale, twist) |

0 commit comments

Comments
 (0)