An open API service indexing awesome lists of open source software.

https://github.com/samb440/queste

An expandable, advanced, yet simple-to-use quest plugin for Minecraft
https://github.com/samb440/queste

Last synced: 11 months ago
JSON representation

An expandable, advanced, yet simple-to-use quest plugin for Minecraft

Awesome Lists containing this project

README

          




Queste


An advanced yet simple-to-use quest plugin for Minecraft




Report Bug / Feature request



Discord

[![CodeFactor](https://www.codefactor.io/repository/github/samb440/queste/badge?s=423044de775c341aa4bc557dc41d390344d16556)](https://www.codefactor.io/repository/github/samb440/queste) ![Contributors](https://img.shields.io/github/contributors/SamB440/Queste?color=dark-green) ![Issues](https://img.shields.io/github/issues/SamB440/Queste) ![License](https://img.shields.io/github/license/SamB440/Queste)
![Forks](https://img.shields.io/github/forks/SamB440/Queste?style=social) ![Stargazers](https://img.shields.io/github/stars/SamB440/Queste?style=social)

## Table Of Contents

* [About the Project](#about-the-project)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Setting up](#setting-up)
* [What to do](#what-to-do)
* [Contributing](#contributing)
* [License](#license)

## About The Project

Queste is an advanced yet simple-to-use quest plugin for Minecraft servers, supporting Spigot and relevant forks.

The plugin was created from the fact that existing plugins are all complex to setup and use, difficult to configure, and don't have the features expected from a quest plugin.

## Getting Started

To contribute to Queste, follow the steps below. Contributions are welcome.

### Prerequisites

* [JDK 16](https://adoptium.net/)
* [Gradle](https://gradle.org/)
* [Git](https://gitforwindows.org/), if on windows.

### Setting up

Clone the repository
Via IntelliJ:
```File > New > Project from Version Control > URL: https://github.com/SamB440/Queste.git > Clone```

Or, via git bash:
```sh
git clone https://github.com/SamB440/Queste.git
```

To build, run the `build` task from IntelliJ, gradle, or gradlew.

## What to do

See the [open issues](https://github.com/SamB440/Queste/issues) for a list of proposed features (and known issues).

## Contributing

Contributions to Queste are greatly welcomed.
* If you have suggestions for new features or changes, feel free to [open an issue](https://github.com/SamB440/Queste/issues/new) to discuss it, or directly create a pull request.
* Make sure to put javadoc comments on public API methods.
* Both Kotlin and Java contributions are accepted, however for API and more complex pull requests, Java is preferred.
* Create an individual PR for each suggestion.

### Creating A Pull Request

Please be mindful that we may ask you to make changes to your pull requests.

Also, if possible, please use `feature` or `fix` branch prefixes.

## License

Distributed under the GNU GPL v3 License. See [LICENSE](https://github.com/SamB440/Queste/blob/main/LICENSE.md) for more information.