From 107c529bfd6613473256a73051987ebb1b301e40 Mon Sep 17 00:00:00 2001 From: LMBishop <13875753+LMBishop@users.noreply.github.com> Date: Thu, 23 Apr 2020 00:49:18 +0100 Subject: Rewrote a few things --- README.md | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 63e8a6b5..d1cba8d2 100644 --- a/README.md +++ b/README.md @@ -3,39 +3,52 @@ This plugin will allow your players to do quests in-game to earn rewards. This can all be configured. ## Downloads/Building -The latest release version of Quests can be found on [Spigot](https://www.spigotmc.org/resources/▶-quests-◀-set-up-goals-for-players.23696/) +The latest release version of Quests can be found on [Spigot](https://www.spigotmc.org/resources/▶-quests-◀-set-up-goals-for-players.23696/). Alternatively, you can build Quests via Maven using ``mvn clean package``. + +### Maven +Creating new Task Types within Quests is supported, [see the wiki](https://github.com/LMBishop/Quests/wiki/New-Task-Type) for help. + +You can include quests in your Maven project using Jitpack +```$xslt + + jitpack.io + https://jitpack.io + +``` +``` + + com.github.LMBishop + Quests + master-SNAPSHOT + provided + +``` + ## Contributors -- LMBishop -- Reinatix -- ToastedCoconut -- nicuch -- RodneyMKay +See https://github.com/LMBishop/Quests/graphs/contributors ## Support For support please open a [GitHub issue](https://github.com/LMBishop/Quests/issues) or join our [Discord server](https://discord.gg/8amrJnX). Please provide information of the issue, any errors that may come up and make sure you are using the latest version of the plugin. ### Issue Tracker -**This is the perferred method of bug reporting & feature requests**. Please use one of the two templates which are provided. If it is neither a bug report or a feature request and is a question, Discord would be a better place to asked this instead. **Follow the template in the issue tracker**. There is nothing more frustrating than people not reporting a bug correctly by missing out vital steps to reproduce the bug or an incomplete description. If the issue is not correctly formated, it will be closed and ignored. +**This is the preferred method of bug reporting & feature requests**. Please use one of the two templates which are provided. If it is neither a bug report or a feature request and is a question, Discord would be a better place to asked this instead. **Follow the template in the issue tracker**. There is nothing more frustrating than people not reporting a bug correctly by missing out vital steps to reproduce the bug or an incomplete description. If the issue is not correctly formated, it will be closed and ignored. ### Discord -**This is the perferred method for general questions about Quests or the development of the project**. Join the Discord server and go to the relative support channel (in this case: #quests-support). Please provide steps to reproduce and a good enough description of the bug and include any errors you may see in console. +**This is the preferred method for general questions about Quests or the development of the project**. Join the Discord server and go to the relative support channel (in this case: #quests-support). Please provide steps to reproduce and a good enough description of the bug and include any errors you may see in console. ### Language -Please speak English and do not use any vulgar or harmful language. Insulting myself or any other contributors will lead to you being blocked, please remember this is a *voulenteer driven project*. +Please speak English and do not use any vulgar or harmful language. We work on this project in our free time, getting mad at us if things do not work will not achieve anything. ## Configuration Assistance The configuration documentation can be found at the [wiki](https://github.com/LMBishop/Quests/wiki/Creating-A-Quest-Or-Category). -## Developing Alongside Quests -Creating new Task Types within Quests is supported, [see the wiki](https://github.com/LMBishop/Quests/wiki/New-Task-Type) for help. - ## Contributing To Quests Fork and make a pull request. Please be consistent with the formatting of the file, please state what you have changed, please test what you have changed before submitting a pull request to make sure it works. Include your DiscordTag if you want a 'contributors' role in our [Discord server](https://discord.gg/8amrJnX). ### Contribution Guildlines -Make sure to format your file using *spaces* not *tabs*. This is how the rest of the project is and it will remain that way. When committing, please follow normal convention which is to have a ~50 character summary on the first line, a blank line then (if applicable) a more detailed description either in bullet points (using a dash as the bullet) or as paragraphs. +Make sure to format your file using *spaces* not *tabs*. This is how the rest of the project is, and it will remain that way. When committing, please follow normal convention which is to have a ~50 character summary on the first line, a blank line then (if applicable) a more detailed description either in bullet points (using a dash as the bullet) or as paragraphs. Example commit message: ``` -- cgit v1.2.3-70-g09d2