willfp / quests

Quest plugin for Spigot.

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.

Alternatively, you can build Quests via Maven using mvn clean package.

Maven

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

You can include quests in your Maven project using JitPack:

<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>

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 MIT License, 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

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.

Contribution Guidelines

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:

Added guidelines to README.md

- Added information on using Maven to build Quests.
- Added information on how to use the Issue Tracker effectively to communcate bugs.
- Made sure to elaborate on how to format files and commit messages.

Make sure your changes actually work before submitting a pull request by building the project and testing it on a Spigot server using the latest version.