Skip to content

Commit aed8c08

Browse files
Alexteens24Alexteens24
committed
docs: update wiki with Death Confirmation GUI feature
1 parent cbdfea5 commit aed8c08

9 files changed

Lines changed: 1381 additions & 1069 deletions

File tree

‎wiki/Advanced-Configuration.md‎

Lines changed: 354 additions & 299 deletions
Large diffs are not rendered by default.

‎wiki/Basic-Configuration.md‎

Lines changed: 157 additions & 157 deletions
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,157 @@
1-
# Basic Configuration
2-
3-
This page covers the essential settings. For advanced features like death-cause rules and protection plugins, see [Advanced Configuration](Advanced-Configuration).
4-
5-
## Config File Location
6-
7-
After first run, config is at: `plugins/DynamicKeepInv/config.yml`
8-
9-
---
10-
11-
## Main Settings
12-
13-
```yaml
14-
enabled: true # Master switch for the plugin
15-
keep-inventory-day: true # Keep inventory during daytime
16-
keep-inventory-night: false # Keep inventory during nighttime
17-
check-interval: 100 # How often to check time (in ticks, 100 = 5 seconds)
18-
```
19-
20-
| Setting | Description |
21-
|---------|-------------|
22-
| `enabled` | Turn the entire plugin on/off |
23-
| `keep-inventory-day` | `true` = players keep items when dying during day |
24-
| `keep-inventory-night` | `true` = players keep items when dying during night |
25-
| `check-interval` | Lower = more accurate, but slightly more CPU usage |
26-
27-
---
28-
29-
## Time Settings
30-
31-
Minecraft uses ticks for time. One full day = 24000 ticks.
32-
33-
### Time Reference Chart
34-
35-
| Time | Ticks | What happens |
36-
|------|-------|--------------|
37-
| 🌅 Sunrise | 0 | Day starts, sun rises |
38-
| ☀️ Noon | 6000 | Sun at highest point |
39-
| 🌆 Sunset | 12000 | Sun begins to set |
40-
| 🌙 Night | 13000 | Stars visible, mobs spawn |
41-
| 🌑 Midnight | 18000 | Darkest point |
42-
| 🌄 Dawn | 23000 | Sky starts to lighten |
43-
44-
### Configuration
45-
46-
```yaml
47-
day-start: 0 # Tick when "day" begins
48-
night-start: 13000 # Tick when "night" begins
49-
```
50-
51-
**Example:** To make night start later (at sunset instead of dusk):
52-
```yaml
53-
night-start: 12000
54-
```
55-
56-
---
57-
58-
## World Settings
59-
60-
### Option 1: Enable for specific worlds only
61-
62-
```yaml
63-
enabled-worlds:
64-
- world
65-
- world_nether
66-
```
67-
68-
Worlds not in this list will be ignored by the plugin.
69-
70-
**Leave empty to enable for ALL worlds:**
71-
```yaml
72-
enabled-worlds: []
73-
```
74-
75-
### Option 2: Per-world settings
76-
77-
Override day/night settings for specific worlds:
78-
79-
```yaml
80-
world-settings:
81-
world_nether:
82-
keep-inventory-day: false # Always drop in nether
83-
keep-inventory-night: false
84-
world_the_end:
85-
keep-inventory-day: true # Always keep in end
86-
keep-inventory-night: true
87-
```
88-
89-
This is useful when you want different rules for different dimensions.
90-
91-
---
92-
93-
## Broadcast Settings
94-
95-
Notify players when keepInventory changes:
96-
97-
```yaml
98-
broadcast:
99-
enabled: true # Enable notifications
100-
day-change: true # Notify when day starts
101-
night-change: true # Notify when night starts
102-
103-
# Where to show the message
104-
chat: true # In chat
105-
action-bar: false # Above hotbar
106-
title: false # Center of screen
107-
108-
# Sound effects
109-
sound:
110-
enabled: false
111-
day: "ENTITY_PLAYER_LEVELUP"
112-
night: "ENTITY_WITHER_SPAWN"
113-
```
114-
115-
### Available Sounds
116-
117-
Use any [Bukkit Sound](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html) name:
118-
- `ENTITY_PLAYER_LEVELUP` - Level up sound
119-
- `BLOCK_NOTE_BLOCK_PLING` - Note block pling
120-
- `ENTITY_EXPERIENCE_ORB_PICKUP` - XP pickup
121-
- `ENTITY_WITHER_SPAWN` - Dramatic wither sound
122-
123-
---
124-
125-
## Custom Trigger Times
126-
127-
By default, keepInventory changes at `day-start` and `night-start`. You can set different trigger times:
128-
129-
```yaml
130-
gamerule-change:
131-
day-trigger: 1000 # Turn ON keepInventory at tick 1000
132-
night-trigger: 12500 # Turn OFF keepInventory at tick 12500
133-
```
134-
135-
Set to `-1` to use the default `day-start` / `night-start` values.
136-
137-
**Use case:** You want "day" to be 0-13000 for mob spawning purposes, but keepInventory to change at different times.
138-
139-
---
140-
141-
## Messages
142-
143-
Edit `plugins/DynamicKeepInv/messages.yml` to customize messages:
144-
145-
```yaml
146-
language: en # 'en' for English, 'vi' for Vietnamese
147-
```
148-
149-
All messages support color codes (`&a`, `&b`, etc.) and MiniMessage format.
150-
151-
---
152-
153-
## Next Steps
154-
155-
- [Advanced Configuration](Advanced-Configuration) - Death cause, protection plugins, economy
156-
- [Commands](Commands) - Available commands
157-
- [FAQ](FAQ) - Common questions
1+
# Basic Configuration
2+
3+
This page covers the essential settings. For advanced features like death-cause rules and protection plugins, see [Advanced Configuration](Advanced-Configuration).
4+
5+
## Config File Location
6+
7+
After first run, config is at: `plugins/DynamicKeepInv/config.yml`
8+
9+
---
10+
11+
## Main Settings
12+
13+
```yaml
14+
enabled: true # Master switch for the plugin
15+
keep-inventory-day: true # Keep inventory during daytime
16+
keep-inventory-night: false # Keep inventory during nighttime
17+
check-interval: 100 # How often to check time (in ticks, 100 = 5 seconds)
18+
```
19+
20+
| Setting | Description |
21+
|---------|-------------|
22+
| `enabled` | Turn the entire plugin on/off |
23+
| `keep-inventory-day` | `true` = players keep items when dying during day |
24+
| `keep-inventory-night` | `true` = players keep items when dying during night |
25+
| `check-interval` | Lower = more accurate, but slightly more CPU usage |
26+
27+
---
28+
29+
## Time Settings
30+
31+
Minecraft uses ticks for time. One full day = 24000 ticks.
32+
33+
### Time Reference Chart
34+
35+
| Time | Ticks | What happens |
36+
|------|-------|--------------|
37+
| 🌅 Sunrise | 0 | Day starts, sun rises |
38+
| ☀️ Noon | 6000 | Sun at highest point |
39+
| 🌆 Sunset | 12000 | Sun begins to set |
40+
| 🌙 Night | 13000 | Stars visible, mobs spawn |
41+
| 🌑 Midnight | 18000 | Darkest point |
42+
| 🌄 Dawn | 23000 | Sky starts to lighten |
43+
44+
### Configuration
45+
46+
```yaml
47+
day-start: 0 # Tick when "day" begins
48+
night-start: 13000 # Tick when "night" begins
49+
```
50+
51+
**Example:** To make night start later (at sunset instead of dusk):
52+
```yaml
53+
night-start: 12000
54+
```
55+
56+
---
57+
58+
## World Settings
59+
60+
### Option 1: Enable for specific worlds only
61+
62+
```yaml
63+
enabled-worlds:
64+
- world
65+
- world_nether
66+
```
67+
68+
Worlds not in this list will be ignored by the plugin.
69+
70+
**Leave empty to enable for ALL worlds:**
71+
```yaml
72+
enabled-worlds: []
73+
```
74+
75+
### Option 2: Per-world settings
76+
77+
Override day/night settings for specific worlds:
78+
79+
```yaml
80+
world-settings:
81+
world_nether:
82+
keep-inventory-day: false # Always drop in nether
83+
keep-inventory-night: false
84+
world_the_end:
85+
keep-inventory-day: true # Always keep in end
86+
keep-inventory-night: true
87+
```
88+
89+
This is useful when you want different rules for different dimensions.
90+
91+
---
92+
93+
## Broadcast Settings
94+
95+
Notify players when keepInventory changes:
96+
97+
```yaml
98+
broadcast:
99+
enabled: true # Enable notifications
100+
day-change: true # Notify when day starts
101+
night-change: true # Notify when night starts
102+
103+
# Where to show the message
104+
chat: true # In chat
105+
action-bar: false # Above hotbar
106+
title: false # Center of screen
107+
108+
# Sound effects
109+
sound:
110+
enabled: false
111+
day: "ENTITY_PLAYER_LEVELUP"
112+
night: "ENTITY_WITHER_SPAWN"
113+
```
114+
115+
### Available Sounds
116+
117+
Use any [Bukkit Sound](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html) name:
118+
- `ENTITY_PLAYER_LEVELUP` - Level up sound
119+
- `BLOCK_NOTE_BLOCK_PLING` - Note block pling
120+
- `ENTITY_EXPERIENCE_ORB_PICKUP` - XP pickup
121+
- `ENTITY_WITHER_SPAWN` - Dramatic wither sound
122+
123+
---
124+
125+
## Custom Trigger Times
126+
127+
By default, keepInventory changes at `day-start` and `night-start`. You can set different trigger times:
128+
129+
```yaml
130+
gamerule-change:
131+
day-trigger: 1000 # Turn ON keepInventory at tick 1000
132+
night-trigger: 12500 # Turn OFF keepInventory at tick 12500
133+
```
134+
135+
Set to `-1` to use the default `day-start` / `night-start` values.
136+
137+
**Use case:** You want "day" to be 0-13000 for mob spawning purposes, but keepInventory to change at different times.
138+
139+
---
140+
141+
## Messages
142+
143+
Edit `plugins/DynamicKeepInv/messages.yml` to customize messages:
144+
145+
```yaml
146+
language: en # 'en' for English, 'vi' for Vietnamese
147+
```
148+
149+
All messages support color codes (`&a`, `&b`, etc.) and MiniMessage format.
150+
151+
---
152+
153+
## Next Steps
154+
155+
- [Advanced Configuration](Advanced-Configuration) - Death cause, protection plugins, economy
156+
- [Commands](Commands) - Available commands
157+
- [FAQ](FAQ) - Common questions

0 commit comments

Comments
 (0)