BSCM

# BSCM (Ben's S#### Config Mod) BSCM is a lightweight, YAML configuration library for Fabric mods. It simplifies config creation, loading, and editing, so you can focus on building features instead of boilerplate. ## Features - Annotation-based configs Define your config structure directly in code with simple annotations. - YAML-backed Human-readable, clean, and widely supported configuration format. - Automatic loading & saving No need to manually change config YAML (server-side still requires), BSCM does it all for you. Built-in config screen (Mod Menu support) Easily edit in-game configs with Mod Menu. - Minimal & developer-friendly Designed to stay out of your way while giving you full control. ## Usage 1. Create a config class 2. Annotate fields you want to expose 3. Let BSCM handle the rest Example: Gradle: ```Groovy repositories{ maven { name = "Modrinth" url = "https://api.modrinth.com/maven" } maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } } dependencies { modImplementation "maven.modrinth:bscm:1.0.4" modImplementation "com.terraformersmc:modmenu:${project.modmenu_version}" } ``` Config Class: ```Java public class ExampleConfig { @Comment("Enable the feature") public boolean enabled = true: @Comment("Maximum value") public int maxValue = 10; } ``` Main Class: ```Java import ca.techgarage.bscm.Bscm; public void onInitialize() { Bscm.load(ExampleConfig.class, "ModID"); } ``` ### How to set up client-side #### To set up you must depend on ModMenu for the version you are using ModMenu Integration class ```Java public class MyModMenuIntegration extends BSCMModMenuIntegration { public MyModMenuIntegration() { super(ExampleConfig.class, "ModID"); } } ``` In your fabric.mod.json ```json "entrypoints": { "modmenu": } ``` BSCM will automatically: - Generate a YAML file - Load values on startup - Save changes when updated ## In-Game Configuration If you have **((https://modrinth.com/mod/modmenu))** installed, BSCM provides a simple config GUI so users can edit settings without leaving the game. ## Dependencies - Fabric Loader ≥ 0.15.0 - (Optional) Mod Menu for in-game config UI ## Why BSCM? Most config systems are either: > Too complex > Too limited > Or require tons of boilerplate BSCM aims to hit the sweet spot: > Simple, readable, and powerful enough for real mods.