ReLib

ReLib

Универсальная служебная библиотека для модов на Fabric, изначально созданная для модов TheSmoothRere, но открытая для всех желающих.

Возможности

• Система конфигов — определяйте классы конфигурации с помощью аннотации @Config
• Автообнаружение — конфиги автоматически находятся через entrypoints Fabric и регистрируются при запуске
• Сохранение в JSON — значения конфигов сохраняются и загружаются в виде форматированного JSON через Gson
• Типизированные опции — BooleanOption, StringOption, IntegerOption, DoubleOption, `EnumOption, ListStringOption`
• Ограничение диапазона — IntegerOption и DoubleOption соблюдают границы min/max
• Поддержка списков — ListStringOption на основе изменяемой обёртки ListString с методами add, edit, remove, clear

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

1. Создайте класс конфига

import io.github.thesmoothrere.relib.config.ListString;
import io.github.thesmoothrere.relib.config.option.*;

@Config(name = "my_mod")
public class MyModConfig implements ConfigApi {

    private final BooleanOption enabled = new BooleanOption("enabled", true);
    private final IntegerOption volume = new IntegerOption("volume", 50, 0, 100);
    private final DoubleOption sensitivity = new DoubleOption("sensitivity", 0.5, 0.0, 1.0);
    private final StringOption greeting = new StringOption("greeting", "Hello!");
    private final EnumOption<MyEnum> mode = new EnumOption<>("mode", MyEnum.NORMAL);
    private final ListStringOption favoriteColors = new ListStringOption("favorite_colors", "red", "blue");

    public ConfigOption<Boolean> enabled() {
        return enabled;
    }

    public ConfigOption<Integer> volume() {
        return volume;
    }

    public ConfigOption<Double> sensitivity() {
        return sensitivity;
    }

    public ConfigOption<String> greeting() {
        return greeting;
    }

    public ConfigOption<MyEnum> mode() {
        return mode;
    }

    public ConfigOption<ListString> favoriteColors() {
        return favoriteColors;
    }
}

2. Зарегистрируйте entrypoint в fabric.mod.json

{
  "entrypoints": {
    "relib": [
      "com.example.MyModConfig"
    ]
  }
}

3. Обращайтесь к конфигу где угодно

MyModConfig config = ConfigManager.get(MyModConfig.class);
boolean enabled = config.enabled().getValue();

ConfigManager.load(config);
ConfigManager.save(config);

Типы опций

Лицензия

Распространяется под лицензией GNU Lesser General Public License v2.1. См. LICENSE.