aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 13:57:32 +0100
committerLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 13:57:32 +0100
commit7a2a45691068db51ba4e7dc851f44a17f545f0ae (patch)
tree4613842f6cd175965dc0920c7e210f417be8f574 /docs/index.md
parent467715dcb3ee23e05e8fe445d9e2a2416a26a8e0 (diff)
Fix wiki linksmigrate-docs
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md102
1 files changed, 39 insertions, 63 deletions
diff --git a/docs/index.md b/docs/index.md
index 84855e52..a64b6f84 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,123 +3,102 @@ title: Home
nav_order: 1
---
<div style="float: right">
-<img src="https://leonardobishop.com/~/artwork/questcompass2-256.png" width="200" height="200"><br>
+<img src="https://leonardobishop.com/~/artwork/questcompass2-256.png" width="140" height="140"><br>
</div>
# Quests documentation
Welcome to the Quests Wiki! Please use the sidebar for navigation around
the wiki.
+{: .fs-6 .fw-300 }
-**๐ŸŒŸ 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")
+{: .important }
+The information on this wiki documents the most recent version of Quests,
+and is built directly from the `docs` directory in the `master` branch on
+GitHub. It may contain documentation for features not yet released.
-Spot a mistake or ambiguous information? Please consider [contributing
-to the wiki](contributing_to_the_wiki "wikilink").
+## New and highlighted articles
-## FAQs
+- [Tips](tips)
+- [Basic options](configuration/basic-options)
+- [Creating a quest](configuration/creating-a-quest)
+- [Creating a category](configuration/creating-a-category)
+- [Custom GUI items](configuration/custom-gui-items)
+- [Task types](task-types)
+- [PlaceholderAPI](tools/placeholderapi)
-Q. What task types are there?
+Spot a mistake or ambiguous information? Please consider [contributing
+to the wiki](contributing-to-the-wiki).
-<!-- -->
+## FAQs
+**Q. What task types are there?**
-Many different [task types](task_types "wikilink") are provided. Follow
+Many [task types](task-types) are provided with the plugin. Follow
the links there to see how to format them.
-<!-- -->
-
-Q. Can I use this plugin on a BungeeCord network/use MySQL?
+Some task types require another plugin to activate.
<!-- -->
+**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?
+Yes, refer to [storage providers](configuration/storage-providers).
<!-- -->
+**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").
+Take a look at the options for
+[blockbreakcertain](task-types/blockbreak-(task-type)).
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?
-
-<!-- -->
-
+**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?
+configuration in [task types](task-types) 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").
-
-<!-- -->
-
+can see it at [creating a quest](configuration/creating-a-quest).
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?
+[custom GUI items](configuration/custom-gui-items).
<!-- -->
+**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.
+[creating a quest](configuration/creating-a-quest) for more information.
Alternatively, entire categories can have permissions enabled.
<!-- -->
-Q. Does this plugin support PlaceholderAPI?
+**Q. Does this plugin support PlaceholderAPI?**
-<!-- -->
-
-
-Yes, see [PlaceholderAPI](tools/placeholderapi.md "wikilink").
+Yes, see [PlaceholderAPI](tools/placeholderapi).
<!-- -->
-Q. How do I get quest progress on a scoreboard?
+**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")
+scoreboard](guides/quest-progress-in-scoreboard)
<!-- -->
-Q. I found a bug or have a feature request! Where do I report it?
-
-<!-- -->
+**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
@@ -127,11 +106,8 @@ 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?
-
-<!-- -->
+**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