Skip to content

Overview

Work in Progress! 🚧 πŸ‘· πŸ—

Both the plugin and the API are currently getting redesigned.

Therefore, required docs and API's are likely missing and will be added one by one. Newly added API's are subject to change and will have an API state assigned to them.

We appreciate any feedback! The old API page is still available.

API States

BetonQuest 2.0 is currently in development.
This will take some time. Any part of the API may change more than once during development. Sure, any API is supposed to be stable. But we cannot guarantee this - BetonQuest 2.0 includes many redesigns of core concepts. It's possible that these turn out to be flawed.
However, API states help you understand how finalized an API part is.

Unfinished

This part of the API is brand-new. It will be changed if there are any bugs, missing features or usability improvements.

It is not recommended relying on this part of the API, it will most likely change.

Draft

Our own usage and testing has shown that this part of the API is complete and seems bug free. However, other plugins may have other use cases which are not covered by our testing. Therefore, please go ahead and use this API part. Let us know if there are missing features or bugs. This API part will be changed if there are more bugs, missing features or usability improvements.

Please use this part of the API and give us feedback!

Stable

Both our own and third party testing showed that this part of the API is complete. Only bugs and major conceptual problems would lead to more changes.

This part of the API should be safe to use. We try to keep it compatible with previous versions if changes are needed.

Adding BetonQuest as a dependencyπŸ”—

You can add BetonQuest as a dependency using your build system. Here is the config for Maven:

Add this to your repositories tag
<repository>
    <id>betonquest-repo</id>
    <url>https://betonquest.org/nexus/repository/betonquest/</url>
</repository>
Add this to your dependencies tag
<dependency>
    <groupId>org.betonquest</groupId>
    <artifactId>betonquest</artifactId>
    <version>2.0.0-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>