BetonQuest is a Spigot questing plugin. It lets the users create complex quests, NPC conversations and other server mechanics for their players.
This page is contains information important for developers. If you're a user of BetonQuest, head to the Spigot page or the official Wiki. Alternatively, you can ask for support on Issues.
If you're looking for an already compiled binaries visit Releases for standard releases or dev website for development builds. This section will cover setting up the BetonQuest development workflow.
In order to compile BetonQuest you need to have JDK installed on your system (version 8 or later). This is basically the Java compiler.
In order to easily build the plugin .jar file you'll need Maven, the build automation tool. Simply download a binary zip archive and unpack it somewhere on your system. Don't forget to add bin directory to your PATH.
Additionally, Maven needs the JAVA_HOME environment variable to point to your JDK installation in order to work.
You can either download the source code directly and unpack it on your system or clone it with Git (recommended):
git clone https://github.com/Co0sh/BetonQuest.git
To compile the plugin open the command line and navigate to the BetonQuest directory. Then use Maven to package BetonQuest into a .jar file:
mvn package
If you want to run an optimised build along with javadocs and source artifacts, run:
mvn package -Drelease
This is much slower and the resulting binary is only slightly faster, so use it only when compiling for production. In development cycle use the regular build command.
In either case, the final BetonQuest.jar file will appear in the target directory.
BetonQuest is installed like any other Spigot plugin, by dropping the BetonQuest.jar file into the plugins directory and restarting/reloading the server. It will automatically deploy example files. Please read the Quick start tutorial page to learn the basics.
The documentation for the current plugin features is located in docs directory. You can also find the same docs compiled into a .pdf file on the dev website.
If you're looking for documentation for the latest stable release head to the Wiki. You can also view the wiki's history if you clone it locally with:
git clone https://github.com/Co0sh/BetonQuest.wiki.git
- Home
- Installation and Configuration
- Commands and Permissions
- Quick start tutorial
- Reference
- Condition List
- Events List
- Objectives List
- Variables List
- Compatibility
- Tips and tricks
- Frequently Asked Questions
- Info for developers
- Contributing
- Images
The contributing guidelines are located in the CONTRIBUTING.md file. Please take a brief look at them before opening an issue or pull request, it will make the world a better place.
The project is licensed under GPLv3 license - see the LICENSE file for more details.