Configuration Guide
Complete guide to configuring ReanimateMC
Configuration Overview
ReanimateMC can be configured in two ways:
- GUI Configuration: Use
/reanimatemc configfor an intuitive in-game interface - File Configuration: Edit
plugins/ReanimateMC/config.ymldirectly
After making changes to config.yml manually, use /reanimatemc reload to apply them.
General Settings
| Setting | Default | Description |
|---|---|---|
language |
"en" | Plugin language (en, fr, es, de, it, ru, zh, kr, pt) |
first_run |
true | Whether this is the first run of the plugin |
setup_completed |
false | Whether initial setup has been completed |
Revival System (reanimation)
| Setting | Default | Description |
|---|---|---|
require_special_item |
true | Whether reviving requires holding a special item |
required_item |
GOLDEN_APPLE | Item required for revival (Minecraft material name) |
duration_ticks |
100 | Time to complete revival (20 ticks = 1 second) |
health_restored |
4 | Hearts restored after revival (2 = 1 heart) |
cooldown |
60 | Cooldown between revivals in seconds |
revive_cooldown |
60 | Personal revival cooldown for the revived player |
Example Configuration
reanimation:
require_special_item: true
required_item: GOLDEN_APPLE
duration_ticks: 100 # 5 seconds
health_restored: 4 # 2 hearts
cooldown: 60 # 1 minute
revive_cooldown: 60 # 1 minute
KO System (knockout)
| Setting | Default | Description |
|---|---|---|
enabled |
true | Enable/disable the KO system entirely |
duration_seconds |
30 | How long KO lasts before death |
movement_disabled |
true | Disable movement during KO (except crawl) |
use_particles |
true | Show particles around KO'd players |
heartbeat_sound |
true | Play heartbeat sound during KO |
blindness |
true | Apply blindness effect to KO'd players |
suicide_hold_seconds |
3 | Hold shift time to commit suicide while KO'd |
weakness_level |
1 | Weakness effect level (0 to disable) |
fatigue_level |
1 | Mining fatigue level (0 to disable) |
Execution System (execution)
| Setting | Default | Description |
|---|---|---|
enabled |
true | Enable/disable execution system |
hold_duration_ticks |
40 | Hold time to execute (20 ticks = 1 second) |
message_broadcast |
true | Broadcast execution messages to server |
Revival Effects (effects_on_revive)
| Setting | Default | Description |
|---|---|---|
nausea |
5 | Nausea duration in seconds (0 to disable) |
slowness |
10 | Slowness duration in seconds (0 to disable) |
resistance |
10 | Resistance duration in seconds (0 to disable) |
Crawling System (prone)
| Setting | Default | Description |
|---|---|---|
enabled |
true | Enable prone/crawling mechanics |
allow_crawl |
true | Allow KO'd players to crawl |
crawl_slowness_level |
5 | Slowness level when crawling |
auto_crawl |
false | Automatically enable crawling on KO |
Other Settings
| Category | Setting | Default | Description |
|---|---|---|---|
| looting | enabled |
true | Allow looting KO'd player inventories |
| tablist | enabled |
true | Show [KO] tag in player list |
NPC System Configuration
| Setting | Default | Description |
|---|---|---|
enabled |
true | Enable/disable NPC summon system |
max_summons_per_player |
1 | Maximum NPCs per player at once |
summon_cooldown |
300 | Cooldown between summons in seconds (5 min) |
offline_timeout |
300 | Time before NPC despawns if owner offline (seconds) |
require_item |
false | Require item to summon NPCs |
required_item |
NETHER_STAR | Item required for summoning (if enabled) |
item_to_summon_golem |
GOLD_INGOT | Specific item for golem summons |
Example NPC Configuration
npc_summon:
enabled: true
max_summons_per_player: 1
summon_cooldown: 300 # 5 minutes
offline_timeout: 300 # 5 minutes
require_item: false
required_item: NETHER_STAR
item_to_summon_golem: GOLD_INGOT
Configuration Tips
Server Types
- PvP: Short KO duration (20-30s), enable execution
- RP: Longer KO (60s+), disable execution, enable crawl
- Hardcore: Short KO (15s), expensive revival items
Performance
- Disable particles if lagging
- Reduce heartbeat sounds
- Lower NPC summon limits
Balance
- Match revival time to server pace
- Adjust cooldowns for activity level
- Consider item economy for requirements