BlossomBridge: Enhancing Your Minecraft Experience
Introducing BlossomBridge
BlossomBridge is a compact API designed for Tywrap Studios Mods, introducing a range of subtle enhancements to your modding experience.
Key Features
- Innovative configuration system utilizing Jankson that incorporates advanced logic.
- A streamlined, specialized logging framework for ensuring uniform log outputs across all modifications.
- Comprehensive Java documentation that aids in understanding the codebase effectively.
Information for Developers
Setting Up the Project
If you’re interested in integrating this API into your own mod, you’re welcome to do so! However, keep in mind that many components are tailored specifically to our development processes, which might not perfectly suit your requirements. Additionally, the current amount of code is relatively minimal, so utility may vary.
Gradle Configuration
Incorporate BlossomBridge like any standard Fabric mod. Simply include the following lines in your build.gradle file:
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
// Other dependencies...
modImplementation("com.github.Tywrap-Studios:BlossomBridge:${project.blossombridge_version}")
}Additionally, make the following addition to your gradle.properties file:
blossombridge_version="1.0.2"
# Feel free to specify any version you would like to use :)It is advisable to utilize the most recent STABLE version available to avoid any unexpected issues with features still in development.
Necessary Additions for Fabric
Don’t forget to include this snippet in your fabric.mod.json file:
{
"depends": {
"blossombridge": ">=1.0.2"
}
}Mod Integration Guide
After successfully adding the mod to your project, you can start leveraging its functionalities! The entire codebase is thoroughly documented with JavaDoc, ensuring you can navigate its features effortlessly. Generally, you should create a configuration class extending AbstractConfig, subsequently creating a new ConfigManager to load and implement your configurations. Alongside this, establishing a LoggingHandler will set you on the right path!
[!WARNING] Avoid using the
BlossomBridgeclass directly! In fact, refrain from using any components from themainpackage! Everything included in themainpackage is tailored toward the primary “MOD” functionality, not the API aspects! All API functionalities are found exclusively within theapipackage. For practical examples, check out Tywragriculture, which effectively demonstrates the application of this API’s capabilities.
