aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
blob: 84855e5249eda79bb8e9fd404762efcc3a5c4da8 (plain)
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
---
title: Home
nav_order: 1
---
<div style="float: right">
<img src="https://leonardobishop.com/~/artwork/questcompass2-256.png" width="200" height="200"><br>
</div>

# Quests documentation

Welcome to the Quests Wiki! Please use the sidebar for navigation around
the wiki.

**🌟 New & Highlighted Articles**

- [Tips](tips "wikilink")
- [Basic options](Basic_options "wikilink")
- [Creating a quest](Creating_a_quest "wikilink")
- [Creating a category](Creating_a_category "wikilink")
- [Custom GUI items](Custom_GUI_items "wikilink")
- [Task types](Task_types "wikilink")
- [PlaceholderAPI](tools/placeholderapi.md "wikilink")

Spot a mistake or ambiguous information? Please consider [contributing
to the wiki](contributing_to_the_wiki "wikilink").

## FAQs

Q. What task types are there?  

<!-- -->

  
Many different [task types](task_types "wikilink") are provided. Follow
the links there to see how to format them.

<!-- -->

Q. Can I use this plugin on a BungeeCord network/use MySQL?  

<!-- -->

  
Yes, refer to [storage providers](storage_providers "wikilink").

<!-- -->

Q. Players are able to place blocks then break them to advance tasks! How do I stop this?  

<!-- -->

  
Take a look at the [Task configuration layout §
blockbreakcertain](Task_configuration_layout#blockbreakcertain "wikilink").
You can enable CoreProtect functionality to detect if a player has
placed a block, or enable the `reverse-if-broken` flag which will
subtract from task progress if a block is placed.

<!-- -->

Q. How do I limit a quest to a certain world?  

<!-- -->

  
Most task types support world restrictions. Take a look at the task
configuration in [task configuration
layout](task_configuration_layout "wikilink") to see if your task does.

<!-- -->

Q. How do I organise quests in the GUI?  

<!-- -->

  
Quests can have a `sort-order`, which organises them within the GUI. You
can see it at [creating a quest](creating_a_quest "wikilink").

<!-- -->

  
If you want to add custom elements to a quest GUI, you can refer to
[custom GUI items](custom_GUI_items "wikilink").

<!-- -->

Q. How to I only let specific players do specific quests?  

<!-- -->

  
Specific quests can have permissions enabled for them. Take a look at
[creating a quest](creating_a_quest "wikilink") for more information.
Alternatively, entire categories can have permissions enabled.

<!-- -->

Q. Does this plugin support PlaceholderAPI?  

<!-- -->

  
Yes, see [PlaceholderAPI](tools/placeholderapi.md "wikilink").

<!-- -->

Q. How do I get quest progress on a scoreboard?  

<!-- -->

  
I have written a guide for this: [Quest progress in
scoreboard](Quest_progress_in_scoreboard "wikilink")

<!-- -->

Q. I found a bug or have a feature request! Where do I report it?  

<!-- -->

  
Great! Go to the [issue
tracker](https://github.com/LMBishop/Quests/issues) to report bugs or
create feature requests. Please avoid using Spigot's discussion pages or
Discord for requests as I will most likely forget about it!

<!-- -->

Q. I have a sizeable portion of money and I feel the need to donate it to you, where do I go?  

<!-- -->

  
Consider giving your money to [Mind](https://www.mind.org.uk/donate);
[Help for Heroes](https://www.helpforheroes.org.uk/donate-online/);
[Cancer Research UK](https://www.cancerresearchuk.org/); or, any other
good cause in your country/local area. Or, if you are programmatically
gifted, donating some of [your
time](https://github.com/LMBishop/Quests/pulls) instead.