About Quests

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. The latest build of Quests (development version) can be found on GitHub.

Alternatively, you can build Quests via Gradle. Release versions of Quests are built using Java 8, you can change the target version in build.gradle.

• ensure Java 8 is installed on your machine
• clone this repository
• run gradlew build in the base directory

Custom Task

Creating new Task Types within Quests is supported, see the wiki for help.

You can include quests in your project using JitPack as a repository.

Maven

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.LMBishop</groupId>
    <artifactId>Quests</artifactId>
    <version>master-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven { url = 'https://jitpack.io' }
}  
dependencies {
    compileOnly 'com.github.LMBishop:Quests:master-SNAPSHOT'
}

Contributors

See https://github.com/LMBishop/Quests/graphs/contributors

Support

For support please open a GitHub issue or join our Discord server. 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 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 formatted, it will be closed and ignored.

Discord

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. We work on this project in our free time, getting mad at us if things do not work will not achieve anything.

License

The source code for Quests is licensed under the GNU General Public License v3.0, to view the license click here.

The artwork for Quests is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License , to learn more click here.

Configuration Assistance

The configuration documentation can be found at the wiki.

Contributing To Quests

We welcome all contributions, we will check out all pull requests and determine if it should be added to Quests

Guidance

• ensure Java 8 is installed on your machine
• fork this repository and clone it
• edit the source code as your please
• run gradlew build in the base directory to build Quests
• push to your fork when ready & submit a pull request

Contribution Guidelines

If you plan on contributing upstream please note the following:

• discuss large changes first
• indent the file with 4 spaces
• take a look at how the rest of the project is formatted and follow that
• do not alter the version number in build.gradle, that will be done when the release version is ready
• limit the first line of commit messages to ~50 chars and leave a space below that
• test your changes on the latest Spigot version before making a pull request

By contributing to Quests you agree to license your code under the GNU General Public License v3.0.