Skip to content

boze-dev/addon-api

Repository files navigation

Boze Addon API Readme

Boze API is an addon api for developers looking to create custom addons for the Boze Utility Mod, a versatile Minecraft anarchy utility mod. This API lets you to seamlessly integrate your own features (modules, commands, etc.) into the Boze Utility Mod.

Compatibility

Boze API supports the following Minecraft versions:

  • 1.21.1
  • 1.20.6
  • 1.20.4

Older versions are no longer updated, see tags for the archived branches.

Documentation

All the information you need to get started with Boze API can be found in our comprehensive Javadocs. Visit docs.boze.dev to access the API documentation. The Javadocs provide detailed information about the API's classes, methods, and usage, making it easier for you to develop custom addons and utilities.

Example Addon

If you're new to Boze API and need a hands-on example to kickstart your development, check out our example addon. This repository serves as a practical reference, showcasing a boilerplate implementation of the API, demonstrating how to get started with creating addons for the Boze Utility Mod. Feel free to explore, modify, and learn from the example addon's source code.

Getting Started

To begin using the Boze API, follow these steps:

  1. Download Boze Utility Mod: First, make sure you have the Boze Utility Mod installed in your Minecraft client. You can download it from the boze.dev dashboard.

  2. Setup your development environment: Use the example addon as a template, to get started, open it in IntellJ or the editor of your choice.

  3. Make your first build and test it ingame: Run the gradle build task, and put the jar into your Minecraft mods folder. Launch Boze (make sure it's the right Minecraft version) and see if your addon gets loaded.

Issues and Support

If you encounter any issues, have questions, or need assistance, please visit our discord server to report issues and seek support. Our active community and development team are here to help.

We look forward to seeing the amazing addons you create with it!

Packages

No packages published

Languages