ZConfig

Зачем существует этот проект?

Это универсальный мод для конфигурации, немного основанный на внутренней системе конфигурации c2me. Он также позволяет мне уменьшить размер zfastnoise до нескольких десятков килобайт, а пользователям нужно скачать мод для конфигурации только один раз.

Возможности

• Файлы конфигурации на основе Toml
• Конфигурационные записи на основе boolean и int
• Позволяет другим модам переопределять конфигурационные записи с помощью метаданных мода
• Помечать моды как несовместимые с определёнными конфигурационными записями

Например, fabric.mod.json

{
  ...
  "custom": {
    "zfastnoise:overrides" : "mixin.perf.surface"
  }
}

Приведённый выше код отключает опцию конфигурации mixin.perf.surface

Планы на будущее

• добавить поддержку modmenu/forge config api
• добавить сборки для neoforge
• добавить больше синтаксического сахара для лёгкой генерации конфигурации

Пример конфигурации

package org.codeberg.zenxarch.zconfig.test;

import org.codeberg.zenxarch.zconfig.entry.BooleanConfigEntry;
import org.codeberg.zenxarch.zconfig.entry.ConfigEntries;
import org.codeberg.zenxarch.zconfig.entry.IntConfigEntry;
import org.codeberg.zenxarch.zconfig.loader.Config;
import org.codeberg.zenxarch.zconfig.loader.ConfigLoader;
import org.codeberg.zenxarch.zconfig.loader.OverrideCollector;
import org.junit.jupiter.api.Test;

public class ExampleConfig extends ConfigEntries {
  public static final ExampleConfig INSTANCE = new ExampleConfig();

  public static final BooleanConfigEntry MAIN =
      INSTANCE.createEntry(
          "main",
          builder -> builder.addComment("Main entry").defaultValue(false).addIncompat("sodium"));

  public static final IntConfigEntry OTHER =
      INSTANCE.createIntEntry(
          "other", builder -> builder.addComment("Other entry").defaultValue(0).constraints(-1, 1));

  public static final Config CONFIG =
      new Config(
          new ConfigLoader("example_mod_id", INSTANCE), new OverrideCollector("example_mod_id"));

  @Test
  public void loadConfig() {
    IO.println(CONFIG.get(MAIN));
    IO.println(CONFIG.get(OTHER));
    IO.println(CONFIG.loadMixinEntries());
  }
}