Configuration

Config

config.yml
1
# MineCrates 2.10.0 configuration file
2
# Created by: extended_clip
3
#
4
#
5
# area_handler: World / WorldGuard / MRL / PrisonMines
6
# area_handler is the name of the hook you want to define crate areas for
7
# Crate areas are tied to the name of the world / mine / region you choose
8
# depending on the hook you use.
9
#
10
# crate_despawn_time: <time in seconds that crates will despawn after spawning>
11
#
12
# crate_material: <Material or ID of the crate block that is spawned>
13
#
14
# crate_inventory_name: <name of the inventory shown when the crate is opened>
15
#
16
# ==================================================
17
#
18
# Crate area configuration:
19
#
20
# Almost all entries in areas are optional
21
# although you must have a drop_counter and drop_chance entry.
22
# You must also have a rewards section with at least 1 valid reward list for the area to be loaded.
23
#
24
# areas:
25
# (region, mine, or world name):
26
# permission: (if you want players to have a certain permission to obtain crates in this area, add the permission node here)
27
# drop_counter: (how many blocks need to be broken before a crate has a chance to spawn)
28
# drop_chance: (what is the chance out of 100.0 that a crate will spawn when the counter reaches 0)
29
# alternate_areas:
30
# - (if you would like to allow this area options to be used for other areas)
31
# - (that way all rewards and options are shared, you can list the alternate area names here)
32
# - world_nether
33
# - world_the_end
34
# counted_materials:
35
# - (if you only want to have certain materials count towards the counter)
36
# - (you can list them here, otherwise don't add this option)
37
# - DIAMOND_ORE
38
# - EMERALD_ORE
39
# reward_on_break: <true/false> should rewards be given on break of the block instead of spawning a crate
40
# rewards: (this section holds all reward related options specific to this area)
41
# (name of this reward list):
42
# priority: (if you have multiple lists, the lowest priority list will be applied if player has multiple list permissions)
43
# permission: (optional if you require players have certain permission to obtain rewards in this list)
44
# max_rewards_per_crate: (max amount of rewards a player can get in a crate from this list)
45
# only_owner_can_open: (should only the person this crate spawned for be allowed to open it)
46
# crate_spawn_actions: (these actions are performed when a crate holding this reward list is spawned)
47
# - [msg] You found a crate
48
# - [broadcast] @p found a crate
49
# - [command] eco give @p 100
50
# - [playersound] ANVIL_LAND 10 1
51
# - [worldsound] ANVIL_BREAK 10 1
52
# - [effect] helix
53
# crate_open_actions: (these actions are performed when a crate holding this reward list is opened)
54
# - [msg] You opened a MineCrate!
55
# - [broadcast] @p opened a crate
56
# - [playersound] CHEST_OPEN 10 1
57
# - [effect] atom
58
# crate_despawn_actions: (these actions are performed when a crate holding this reward list is despawned if it was not opened)
59
# - [msg] You missed your crate
60
# - [worldsound] ANVIL_BREAK 10 1
61
# - [effect] heart
62
# items: (this section holds all of the actual commands / items given as rewards)
63
# (unique name for this item reward):
64
# chance: (chance this reward will be selected) the chance system is explained below...
65
# item: (if this reward is an itemstack, you must specify 'item:' here, otherwise you will specify 'commands:')
66
# material: (if this is an item, these are the item options you can use)
67
# data: (data value if needed)
68
# amount: (amount of this item to give)
69
# name: (display name to set on this item)
70
# lore:
71
# - (add your lore here if you want)
72
# - (supports multiple lines)
73
# enchantments:
74
# - <ENCHANTMENT NAME>,<LEVEL>
75
# (unique name for this command reward):
76
# chance: 50.0
77
# commands:
78
# - (list all your commands here, they must start with a valid action identifier)
79
# - [command] eco give @p 100
80
# - [msg] you got 100 bucks!
81
# ==================================================
82
#
83
# CRATE SPAWN CHANCE INFORMATION
84
#
85
# This chance can be any double value from 0.01 to 100.0
86
# it is percentage based, so if you set the chance to 10.0
87
# there will be a 10% chance a crate will spawn when the break
88
# counter reaches 0. If you set it to 99.0, there will be a 99% chance
89
# that a crate will spawn when the counter rewaches 0.
90
#
91
# ==================================================
92
#
93
# REWARD CHANCE INFORMATION
94
#
95
# All rewards in a specific reward list have a chance associated with the item/commands that are executed for that reward.
96
# All reward chances in a list must add up to or be less than 100.0
97
# Example:
98
#
99
# rewards:
100
# VIP_REWARDS:
101
# priority: 1
102
# permission: vip.rewards
103
# max_rewards_per_crate: 1
104
# only_owner_can_open: true
105
# items:
106
# item_1:
107
# chance: 10.0
108
# item:
109
# material: DIAMOND
110
# amount: 128
111
# item_2:
112
# chance: 15.0
113
# item:
114
# material: IRON_INGOT
115
# amount: 64
116
# item_3:
117
# chance: 25.0
118
# item:
119
# material: DIRT
120
# amount: 64
121
# command_1:
122
# chance: 25.0
123
# commands:
124
# - [command] eco give @p 25
125
# - [msg] You got 25 bucks
126
#
127
# With this example, all of our chances add up to 75.0,
128
# This means that there is a 25% chance that we get nothing each time a reward is
129
# being selected. If we want to make sure players always get a reward, we could
130
# simply add one more reward item or command with the remainder percentage for all of our
131
# chances to equal 100.0, which would be 25.0.
132
# This system allows you to set what items are rare, and which items are going to be
133
# more commonly selected when the plugin chooses rewards.
134
# Always keep in mind that all reward chances must be less than, or add up to 100.0
135
# If your combined chance exceeds 100.0, the rewards that are being checked after 100.0 has
136
# been reached will not be loaded. Also remember, to make it where a player has a chance to get
137
# no reward, always leave the total chance less than 100.0 as all chance remaining will
138
# be the chance amount that no reward is chosen.
139
#
140
# ==================================================
141
#
142
# CRATE SPAWN/DESPAWN/OPEN/COMMANDS ACTION IDENTIFIERS
143
#
144
# Any action added to these lists must contain a specific identifier
145
# as there are more actions than just commands to be executed.
146
# These actions are as follows:
147
#
148
# [msg] <message>
149
# This will send a raw message to the target player
150
#
151
# [broadcast] <message>
152
# This will broadcast a message to the entire server
153
#
154
# [command] <command here>
155
# This will execute a command in the console
156
#
157
# [worldsound] <sound> <volume> <pitch>
158
# This will play a sound to the entire world at the crate location
159
#
160
# [playersound] <sound> <volume> <pitch>
161
# This will play a sound to the target player
162
#
163
# [effect] <effectName>
164
# This will play a preset effect at the crate location
165
#
166
# effect names:
167
# animatedball
168
# arc
169
# atom
170
# bleed
171
# circle
172
# cloud
173
# cone
174
# cube
175
# cylinder
176
# disco
177
# dna
178
# donut
179
# dragon
180
# earth
181
# explode
182
# flame
183
# fountain
184
# grid
185
# heart
186
# helix
187
# hill
188
# icon
189
# love
190
# music
191
# shield
192
# smoke
193
# sphere
194
# star
195
# tornado
196
# vortex
197
# warp
198
# wave
199
#
200
# ==================================================
201
#
202
# Optional: display a temporary hologram above the MineCrate when it is spawned.
203
#
204
# To enable this feature, add the following entry to the top of your config file:
205
#
206
# You can either use HolographicDisplays API to display the hologram, or the internal
207
# hologram mechanics. Set handler: none to disable holograms
208
#
209
# Note: the internal hologram handler is only available for 1.8.8
210
# More hologram handlers will be coming soon.
211
#
212
# crate_hologram:
213
# handler: none/internal/holographicdisplays
214
# message:
215
# - '%player%s MineCrate'
216
# - '(Right click to open)
217
# height: 2'
218
#
219
# Inside of the message, you can use the following placeholders:
220
# %player% - shows players name who MineCrate is for
221
# %area% - name of the area the crate spawned in
222
# %rewardlist% - name of the list the rewards were chosen from
223
# %rewards% - amount of rewards inside of the MineCrate
224
#
225
# ==================================================
226
227
crate_hologram:
228
handler: none
229
message:
230
- '&f%player%''s &aMineCrate'
231
- '&e(&7Right click to open&e)'
232
height: 2.2
233
check_updates: true
234
area_handler: World
235
ignore_silk_touch: true
236
crate_despawn_time: 30
237
crate_material: ENDER_CHEST
238
crate_inventory_name: '%reward_list_name% &aMineCrate'
239
messages:
240
help:
241
- '&aMineCrates &fhelp'
242
- '&a/minecrates reload &7- &freload the plugin'
243
- '&a/minecrates info &7- &fView minecrates information for the area you are standing'
244
- '&a/minecrates ignore &7- &ftoggle on/off ignoring minecrates for yourself'
245
ignore_toggle_on: '&aYou are now ignoring MineCrates!'
246
ignore_toggle_off: '&fYou are no longer ignoring MineCrates!'
247
only_owner_can_open_crate: '&cOnly &[email protected] &ccan open this &aMineCrate!'
248
no_permission: '&cYou don''t have permission to do that!'
249
areas:
250
world:
251
permission: minecrates.getcrates.world
252
drop_counter: 100
253
drop_chance: 50.0
254
cooldown: 30
255
counted_materials:
256
- COAL_ORE
257
- IRON_ORE
258
- GOLD_ORE
259
- DIAMOND_ORE
260
rewards:
261
vip:
262
priority: 1
263
permission: minecrates.rewards.world.vip
264
max_rewards_per_crate: 1
265
only_owner_can_open: true
266
crate_spawn_actions:
267
- '[message] &aYou found a VIP MineCrate!'
268
- '[command] eco give @p 100'
269
- '[broadcast] &[email protected] &afound a MineCrate!'
270
- '[effect] helix'
271
crate_despawn_actions:
272
- '[message] &7Your crate has despawned!'
273
- '[effect] helix'
274
items:
275
example_item:
276
chance: 20.0
277
item:
278
material: DIAMOND
279
data: 0
280
amount: 64
281
name: '&bVIP &3Diamonds'
282
lore:
283
- This item is only available to players who
284
- have permission for this vip reward list!
285
enchantments:
286
- LUCK,1
287
example_command_1:
288
chance: 1.0
289
commands:
290
- '[command] eco give @p 1000000'
291
- '[msg] You got 1000000 dollars!'
292
example_command_2:
293
chance: 30.0
294
commands:
295
- '[command] eco give @p 500'
296
- '[msg] You got 500 dollars!'
297
example_command_3:
298
chance: 49.0
299
commands:
300
- '[command] eco give @p 1000'
301
- '[msg] You got 1000 dollars!'
302
default:
303
priority: 2
304
max_rewards_per_crate: 1
305
only_owner_can_open: false
306
crate_spawn_actions:
307
- '[message] &aYou found a regular MineCrate!'
308
- '[command] eco give @p 100'
309
- '[broadcast] &[email protected] &afound a MineCrate!'
310
- '[effect] helix'
311
items:
312
example_item_1:
313
chance: 5.0
314
item:
315
material: DIAMOND
316
amount: 16
317
example_item_2:
318
chance: 10.0
319
item:
320
material: IRON_INGOT
321
amount: 32
322
example_command:
323
chance: 85.0
324
commands:
325
- '[command] eco give @p 250'
326
- '[msg] You got 250 dollars!'
Copied!
Copy link