1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
# | =================================================== |
# | Thank you for downloading and trying out |
# | Quests |
# | https://www.spigotmc.org/resources/23696/ |
# | https://github.com/LMBishop/Quests/ |
# | |
# | =x= |
# | |
# | Trying to add new quests? |
# | |
# | Go to the 'quests' |
# | subdirectory to edit the |
# | quests |
# | |
# | The example quests |
# | are commented to help you |
# | learn how to use the plugin |
# | |
# | =x= |
# | |
# | Have Discord & need help? |
# | Head to the GitHub page and click on the |
# | Discord link, or create an issue |
# | =================================================== |
# Categories are a way of grouping up quests.
# When a player uses /quests, a menu of categories will be presented to them.
# When a player clicks ona category, a list of quests under that category will show.
# If categories are disabled, all quests will be shown under one big GUI.
# Players can access specific categories by command using /quests c [category].
# If a quest does not have a category, it will not be shown.
categories:
examples:
display:
name: "&cExample Quests"
lore:
- "&7This category contains example quests"
- "&7which are commented in the config."
- "&7The comments should guide you with"
- "&7how the config works."
- ""
- "&cIt is highly recommended you read this"
- "&csection and all the comments so you can"
- "&cmake the most of this plugin."
type: "WATER_BUCKET"
permissionexample:
display:
name: "&cPermission Example"
lore:
- "&7This category is an example of one which"
- "&7requires a permission to open."
- ""
- "&cIt is highly recommended you read this"
- "&csection and all the comments so you can"
- "&cmake the most of this plugin."
type: "WATER_BUCKET"
# This category needs the permission "quests.category.permissionexample", because the category ID is 'permissionexample'.
# The permission for other categories is: "quests.category.<id>".
permission-required: true
# The items listed below are placeholder items for quests which the player cannot start.
# You should change these for 1.8
gui:
back-button:
name: "&cReturn"
lore:
- "&7Return to the categories menu."
type: "ARROW"
page-prev:
name: "&7Previous Page"
lore:
- "&7Switch the page to page &c{prevpage}."
type: "FEATHER"
page-next:
name: "&7Next Page"
lore:
- "&7Switch the page to page &c{nextpage}."
type: "FEATHER"
page-desc:
name: "&7Page &c{page}"
lore:
- "&7You are currently viewing page &c{page}."
type: "PAPER"
quest-locked-display:
name: "&c&lQuest Locked"
lore:
- "&7You have not completed the requirements"
- "&7for this quest (&c{quest}&7)."
- ""
- "&7Requires: &c{requirements}"
- "&7to be completed to unlock."
type: "RED_STAINED_GLASS_PANE"
quest-permission-display:
name: "&6&lNo Permission"
lore:
- "&7You do not have permission for this"
- "&7quest (&6{quest}&7)."
type: "BROWN_STAINED_GLASS_PANE"
quest-cooldown-display:
name: "&e&lQuest On Cooldown"
lore:
- "&7You have recently completed this quest"
- "&7(&e{quest}&7) and you must"
- "&7wait another &e{time} &7to unlock again."
type: "ORANGE_STAINED_GLASS_PANE"
quest-completed-display:
name: "&a&lQuest Complete"
lore:
- "&7You have completed this quest"
- "&7(&a{quest}&7) and cannot."
- "&7repeat it."
type: "GREEN_STAINED_GLASS_PANE"
no-started-quests:
name: "&c&lNo Started Quests"
lore:
- "&7Go start some!"
type: "FEATHER"
quest-cancel-yes:
name: "&a&lConfirm Cancel"
lore:
- "&7Confirm you wish to cancel"
- "&7this quest and lose all"
- "&7progress."
type: "GREEN_STAINED_GLASS_PANE"
quest-cancel-no:
name: "&c&lAbort Cancel"
lore:
- "&7Return to the quest menu."
type: "RED_STAINED_GLASS_PANE"
quest-cancel-background:
type: "GRAY_STAINED_GLASS_PANE"
# Here you can add custom items to the quest menu
# Categories & quests will fill empty slots
#custom-elements:
# "categories": # apply to the categories menu (the main menu by default)
# 0: # <--- slot 1, note the slots start from 0! so 0 = slot 1 in this case
# display:
# name: "&cExample Custom Item (slot 1)"
# lore:
# - "&7This is a custom item which can be added"
# - "&7to your menus. This is purely cosmetic."
# - ""
# - "&7Two empty slots should follow."
# type: "DIAMOND_BLOCK"
# 1: # <--- start from slot 2
# spacer: true # empty slot in GUI
# repeat: 2 # repeats for 2 slots
# 3: # <--- start from slot 4
# display:
# name: "&cExample Custom Item (slots 4 - 7)"
# lore:
# - "&7This is a custom item which can be added"
# - "&7to your menus, but in slot 4 and repeated"
# - "&73 times."
# - "&7"
# - "&7This will come after 2 empty slots."
# - "&7"
# - "&7This is purely cosmetic."
# type: "NETHERRACK"
# repeat: 3 # repeats for 3 more slots
# "c:examples": # apply to the category "examples"
# 0:
# display:
# name: "&cExample Custom Item (slot 1)"
# lore:
# - "&7This is a custom item which can be added"
# - "&7to your menus. This is purely cosmetic."
# type: "EMERALD_BLOCK"
# "quests": # apply to the general quests menu IF categories are disabled
# 0:
# display:
# name: "&cExample Custom Item (slot 1)"
# lore:
# - "&7This is a custom item which can be added"
# - "&7to your menus. This is purely cosmetic."
# type: "EMERALD_BLOCK"
options:
# If categories are disabled, quests will be put into one big gui.
categories-enabled: true
# If true, the gui size will automatically change based on the amount of quests inside it.
trim-gui-size: true
# Enable/disable titles
titles-enabled: true
# Players cannot start any more quests than this at a single time
quest-started-limit: 2
# Hide locked quests, quests on cooldown and completed (but not repeatable) quests
gui-hide-locked: false
# Allow players to cancel a quest (you may want to remove the cancel instructions in the global item lore)
allow-quest-cancel: true
# Allow players to track a quest (you may want to remove the tracking instructions in the global item lore)
allow-quest-track: true
# Titles for the GUIs
guinames:
quests-category: "Quests Categories"
quests-menu: "Quests"
quests-started-menu: "Started Quests"
daily-quests: "Daily Quests"
quest-cancel: "Cancel Quest"
# Show when quests register in console - will only show if verbose-logging-level=2. Disable if you want less console spam at startup.
show-quest-registrations: true
# Hide quests which a player cannot start due to permissions.
gui-hide-quests-nopermission: false
# Hide categories which a player cannot open due to permissions.
gui-hide-categories-nopermission: false
# Replace placeholders from PlaceholderAPI in Quests GUI items
gui-use-placeholderapi: false
# Make it so players do not have to start quest themselves
quest-autostart: false
# Automatically track quests on start, and stop tracking on completion
quest-autotrack: true
# How much quests should log, 0 = errors only, 1 = warnings, 2 = info, 3 = debug
verbose-logging-level: 2
# Verify quests exist when a player's data is loaded - inconsistencies may arise when
# players progress on specific quests and those quests are later removed. The problem is that their progress
# is still kept in the quest progress file, which may lead to issues such as players reaching a quest started
# limit when the quests they had active no longer exist - having this option enabled prevents
# non-existent quests from being loaded
verify-quest-exists-on-load: true
performance-tweaking: # The following are measured in server ticks, multiply SECONDS by 20 to get the number of ticks.
quest-queue-executor-interval: 1 # how frequently Quests should execute the next check in the completion queue (def=1 - 0.05s) - increase this value if you are struggling with performance
quest-autosave-interval: 12000 # how frequently online players data will be autosaved (def=12000 - 10 minutes)
tab-completion:
enabled: true
error-checking:
# Allow quests to be loaded if they contain errors
# This may lead to errors in the console!
override-errors: false
# How much time (in seconds) that plugin will cache placeholders
placeholder-cache-time: 10
# Whether or not the global task configuration will override per-task configuration settings
global-task-configuration-override: false
# Whether or not the global display configuration will override per-quest display settins
global-quest-display-configuration-override: false
# Storage options - please see the following: https://github.com/LMBishop/Quests/wiki/Storage-Providers
storage:
# Either 'yaml' (flatfile) or 'mysql' (network)
# Please read the following before using MySQL https://github.com/LMBishop/Quests/wiki/Storage-Providers#network
provider: "yaml"
# The following is only applicable for database storage providers (e.g. mysql)
database-settings:
network:
# The name of the database. This database should already exist!
database: "minecraft"
username: "root"
password: ""
# Address should be in the format ip:port (just like the game itself)
address: "localhost:3306"
# This plugin uses 'HikariCP' for connection management, the pooling configuration can be changed here
connection-pool-settings:
# The maximum number of connections to keep open with the database (def=8)
maximum-pool-size: 8
# The minimum number of connections to keep open with the database (def=8)
minimum-idle: 8
# The maximum time (in milliseconds) to keep a single connection open (def=1800000 - 30 min)
maximum-lifetime: 1800000
# The time (in milliseconds) the plugin will wait for a response by the database (def=500)
connection-timeout: 5000
# The prefix each table will use
table-prefix: "quests_"
# This switches up the entire quest system.
# By enabling daily-quests, players will no longer be presented with the standard Quest GUI.
# Instead, they will be presented with 5 random quests.
# The 'requirements' section in each quest does not apply here.
# The 'cooldown' section in each quest does not apply here - if it's done, it's done (and will be repeatable next time they get the quest).
# The 'repeatable' section in each quest does not apply here. It will NOT be repeatable until the next day.
# Enabling this MAY cause previous quest progress to be modified, wiped or changed irreversibly! If you're testing this on a live server, it is wise to backup
# the Quests/playerdata/ folder! You've been warned!
#
# Quests BETA: this feature is a work in progress, it does not work yet!
daily-quests:
enabled: false # <----- NOT YET IMPLEMENTED (THIS WILL NOT DO ANYTHING)
# The global task configuration will apply to the config of each task of a specified type in each quest.
# In the example below, every task with a type of "inventory" will have the config option "update-progress"
# set to true. This is useful if you do not want to go through each quest if you want to update the configuration
# for every task of a specific type.
#
# You must uncomment all below lines for the example to have any effect
# vvvvvvvvvvvvvvvvvvvvvvvvv
#global-task-configuration:
# types:
# inventory:
# update-progress: true
global-quest-display:
lore:
# append-normal:
# - "..."
append-not-started:
- ""
- "&eLeft Click &7to start this quest."
append-started:
- ""
- "&aYou have started this quest."
- "&eMiddle Click &7to track this quest."
- "&eRight Click &7to cancel this quest."
append-tracked:
- ""
- "&aYou are &etracking &athis quest."
- "&eMiddle Click &7to stop tracking this quest."
- "&eRight Click &7to cancel this quest."
# Configure titles
titles:
quest-start:
title: "&cQuest Started"
subtitle: "&7{quest}"
quest-complete:
title: "&cQuest Complete"
subtitle: "&7{quest}"
# Configure messages
messages:
time-format: "{hours}h {minutes}m"
quest-start: "&7Quest &c{quest} &7started!"
quest-complete: "&7Quest &c{quest} &7completed!"
quest-cancel: "&7Quest &c{quest} &7cancelled!"
quest-track: "&7Tracking quest &c{quest}&7."
quest-track-stop: "&7No longer tracking quest &c{quest}&7."
quest-random-none: "&cYou have no quests which you can start."
quest-start-limit: "&7Players are limited to &c{limit} &7started quests at a time."
quest-start-disabled: "&7You cannot repeat this quest."
quest-start-locked: "&7You have not unlocked this quest yet."
quest-start-cooldown: "&7You have recently completed this quest. You have to wait &c{time} &7until you are able to restart it."
quest-start-started: "&7You have already started this quest."
quest-start-permission: "&7You do not have permission to start this quest."
quest-category-permission: "&7You do not have permission to view this category."
quest-category-quest-permission: "&7You do not have permission to start this quest since it is in a category you do not have permission to view."
quest-cancel-notstarted: "&7You have not started this quest."
quest-updater: "&cQuests > &7A new version &c{newver} &7was found on Spigot (your version: &c{oldver}&7). Please update me! <3 - Link: {link}"
command-sub-doesntexist: "&7The specified subcommand '&c{sub}' &7does not exist."
command-quest-start-doesntexist: "&7The specified quest '&c{quest}&7' does not exist."
command-quest-general-doesntexist: "&7The specified quest '&c{quest}&7' does not exist."
command-category-open-disabled: "&7Categories are disabled."
command-category-open-doesntexist: "&7The specified category '&c{category}&7' does not exist."
command-quest-admin-playernotfound: "&7Player '&c{player}&7' could not be found."
command-quest-openquests-admin-success: "&7Opened Quest GUI for player &c{player}&7."
command-quest-opencategory-admin-success: "&7Opened category &c{category} &7for player &c{player}&7."
command-taskview-admin-fail: "&7Task type '&c{task}&7' does not exist."
beta-reminder: "&cQuests > &7Reminder: you are currently using a &cbeta &7version of Quests. Please send bug reports to https://github.com/fatpigsarefat/Quests/issues and check for updates regularly using &c/quests admin update&7!"
command-quest-admin-loaddata: "&7Quest data for '&c{player}&7' is being loaded."
command-quest-admin-nodata: "&7No data could be found for player &c{player}&7."
command-quest-admin-fullreset: "&7Data for player &c{player}&7 has been fully reset."
command-quest-admin-clean-success: "&7All quest progress files have been cleaned."
command-quest-admin-clean-fail: "&cFailed to clean quest progress files. Please report the error in the console."
command-quest-admin-start-faillocked: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have not yet unlocked it."
command-quest-admin-start-failcooldown: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. It is still on cooldown for them."
command-quest-admin-start-failcomplete: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have already completed it."
command-quest-admin-start-faillimit: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have reached their quest start limit."
command-quest-admin-start-failstarted: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. It is already started."
command-quest-admin-start-failpermission: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They do not have permission."
command-quest-admin-start-failcategorypermission: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They do not have permission for the category which the quest is in."
command-quest-admin-start-failother: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7."
command-quest-admin-start-success: "&7Quest &c{quest} &7started for player &c{player}&7."
command-quest-admin-category-permission: "&7Category &c{category} &7 could not be opened for player &c{player}&7. They do not have permission to view it."
command-quest-admin-complete-success: "&7Quest &c{quest} &7completed for player &c{player}&7."
command-quest-admin-reset-success: "&7Successfully reset quest '&c{quest}&7' for player &c{player}&7."
|
