BSCM

BSCM (Ben's S#### Config Mod)

BSCM — это лёгкая библиотека конфигураций в формате YAML для модов на Fabric. Она упрощает создание, загрузку и редактирование конфигов, чтобы вы могли сосредоточиться на создании функций, а не на шаблонном коде.

Возможности

• Конфиги на основе аннотаций Определяйте структуру конфига прямо в коде с помощью простых аннотаций.
• На основе YAML Читаемый, чистый и широко поддерживаемый формат конфигурации.
• Автоматическая загрузка и сохранение Не нужно вручную менять YAML конфига (на серверной стороне всё ещё требуется), BSCM сделает всё за вас. Встроенный экран конфигурации (поддержка Mod Menu) Легко редактируйте конфиги прямо в игре с помощью Mod Menu.
• Минималистичный и удобный для разработчиков Создан так, чтобы не мешать вам, давая при этом полный контроль.

Использование

1. Создайте класс конфига
2. Добавьте аннотации к полям, которые хотите открыть
3. Позвольте BSCM сделать всё остальное Пример: Gradle:

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}"

}

Класс конфига:

public class ExampleConfig {

@Comment("Enable the feature")
public boolean enabled = true:

@Comment("Maximum value")
public int maxValue = 10;
}

Главный класс:

import ca.techgarage.bscm.Bscm;

public void onInitialize() {

Bscm.load(ExampleConfig.class, "ModID");
}

Как настроить на стороне клиента

Для настройки необходимо зависеть от ModMenu для используемой вами версии

Класс интеграции с ModMenu

public class MyModMenuIntegration extends BSCMModMenuIntegration {
    public MyModMenuIntegration() {
        super(ExampleConfig.class, "ModID");
    }
}

В вашем fabric.mod.json

"entrypoints": {
    "modmenu": [
        "com.example.mymod.MyModMenuIntegration"
    ]
}

BSCM автоматически:

• Создаст YAML-файл
• Загрузит значения при запуске
• Сохранит изменения при обновлении

Конфигурация в игре

Если у вас установлен Mod Menu), BSCM предоставляет простой графический интерфейс конфигурации, чтобы пользователи могли менять настройки, не выходя из игры.

Зависимости

• Fabric Loader ≥ 0.15.0
• (Опционально) Mod Menu для интерфейса конфигурации в игре

Почему BSCM?

Большинство систем конфигурации либо:

Слишком сложные Слишком ограниченные Или требуют тонны шаблонного кода BSCM стремится найти золотую середину: Простой, читаемый и достаточно мощный для настоящих модов.