Configuration
A walk through config.yml, section by section, with what every key does.
Everything except the wording lives in config.yml. The file itself carries a comment above each key, so this page is a map rather than a replacement.
Run /pp reload after editing. A restart is not needed.
Top of the file
config-version: 5
language: en_US
update-notifier: true| Key | What it does |
|---|---|
config-version | Bookkeeping for the plugin. Leave it alone. |
language | Which file in lang to read messages from. See Languages. |
update-notifier | Check SpigotMC on startup and mention it when a newer version is out. See Metrics and update checks. |
Do not edit config-version by hand. The plugin uses it to work out which new keys to add when you update, and a wrong value there means either missing keys or a file that gets rewritten when it should not be.
The piñata
pinata:
name: "&d&lPINATA PARTY"
type: LLAMA
glow: true
limit: -1
hits-multiplier: 3
hit-cooldown: 1.0
hit-chance: 75.0
broadcast-hits: false
spawn-cooldown: 3| Key | What it does | Default |
|---|---|---|
name | Name tag above the piñata. Hidden while a hologram is showing. | &d&lPINATA PARTY |
type | Which mob it is. Any living Bukkit entity type. | LLAMA |
glow | Outline visible through blocks. | true |
limit | How many piñatas can run at once. -1 for no cap. | -1 |
hits-multiplier | Hits needed is this times the number of players online. | 3 |
hit-cooldown | Seconds a player must wait between hits that count. | 1.0 |
hit-chance | Chance out of 100 that a swing counts at all. | 75.0 |
broadcast-hits | Announce every hit in chat. Off because it is a lot of chat. | false |
spawn-cooldown | Seconds of countdown before the piñata appears. | 3 |
See How a party runs for how these fit together.
Movement
pinata:
movement:
teleport-back-interval: 0
speed: 0.3
interval: 40
speed-multiplier: 1.0| Key | What it does |
|---|---|
teleport-back-interval | A distance in blocks, despite the name. Go further than this from the spawn point and the piñata is pulled straight back. 0 never pulls it back. |
speed | How hard the random shove is on each movement step. Around 0.1 to 0.6. |
interval | Ticks between movement steps. 20 ticks is one second. |
speed-multiplier | Scales the mob's own walking speed. 1.0 is the normal pace for that mob. |
teleport-back-interval is badly named and always has been. It is a leash distance, not a timer. Setting it to 30 keeps the piñata within 30 blocks of where it spawned.
Knockback, carpet and holograms
These have their own pages:
Effects and sounds
Knockback, the rainbow carpet, fireworks, glow and every sound.
Holograms
The floating text above the piñata and the backend that draws it.
Spawn locations
locations:
spawn1:
type: FIXED
world: "world"
x: 0.5
y: 65.0
z: 0.5
yaw: 0.0
pitch: 0.0Covered in full on Spawn locations.
Rewards
rewards:
hit:
'1':
chance: 50.0
commands:
- "eco give %player% 50"
death:
'1':
chance: 100.0
commands:
- "eco give %player% 500"
last-hit:
min-rewards: 1
max-rewards: 3
'1':
chance: 50.0
commands:
- "eco give %player% 1000"Covered in full on Rewards, including the difference between a chance and a weight.
Party start commands
party-start-commands:
once: []
per-player: []Commands fired when a piñata spawns. once runs a single time, per-player repeats for every player online. Both empty by default. Covered on How a party runs.
Broadcasts, fireworks and sounds
broadcast:
handle-internally: true
fireworks:
enabled: true
sounds:
spawn: "ENTITY_LLAMA_AMBIENT"See Broadcasts and Effects and sounds.
What happens when you update
New settings are added to your file with their defaults, settings that no longer exist are removed, and everything you changed is kept.
Two parts of the file are treated as yours and are never touched:
locations, so spawn points made with/pp setspawnsurviverewards.hitandrewards.death, so extra reward entries you added survive
The comments in your file are yours too. A key you already have keeps whatever comment sits above it, so an update will not overwrite your notes. Only newly added keys bring the plugin's own comments with them.
If something is wrong
The plugin keeps running with sensible defaults rather than refusing to start. Check the console after a reload: unknown sound names, bad particle names, non-carpet materials and unparseable firework effects each log a line telling you exactly which entry is at fault.