Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 4.33 KB

README.md

File metadata and controls

91 lines (69 loc) · 4.33 KB
Raw



Quests

Quick Navigation

💾 Downloads / Building

The latest release version of Quests can be found here. 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 Gradle, targeting Java 17. You can change the target version in build.gradle.

  • Ensure Java is installed on your machine
  • Clone this repository
  • Run ./gradlew (Linux and macOS) or gradlew (Windows) in the base directory to build Quests
    • The jar will be output in /build/libs

See CONTRIBUTING.md for more information.

🧰 Custom Task

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

Quests can be found on the Maven repository listed below, or alternatively on JitPack.

For versions from repo.leonardobishop.com, the version number corresponds to the release version. Please see Spigot for the latest release number.

👨‍💻 Maven

<repository>
    <id>repo.leonardobishop.com</id>
    <url>https://repo.leonardobishop.com/releases/</url>
</repository>

<dependency>
    <groupId>com.leonardobishop</groupId>
    <artifactId>quests</artifactId>
    <version><!--LATEST SPIGOT VERSION--></version>
    <scope>provided</scope>
</dependency>

👩‍💻 Gradle

repositories {
    maven { url = uri('https://repo.leonardobishop.com/releases/') }
}

dependencies {
    compileOnly 'com.leonardobishop:quests:<LATEST SPIGOT VERSION>'
}

👫 Contributors

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

🤝 Contributing to Quests

See CONTRIBUTING.md

📖 Wiki

Full documentation can be found at https://quests.leonardobishop.com/.

Documentation is built directly from this repository, from the /docs directory.

💡 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 ask this instead.

💬 Discord

This is the preferred method for general questions about Quests or the development of the project. There is no dedicated support team, rather a team of volunteers (myself) who can help only when they have time.

🌐 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, making demands, or just complaining in general 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.