Библиотека на создание своего сервера для Майнкрафт 1.19.2 / 1.18.2 (Cloth Config API)

Модификация Cloth Config полностью техническая. Данный мод является творением автора shedaniel и необходим для нормальной работы других модификаций, которые зависят от Cloth Config. Сам же Cloth Config почти ничего не добавляет в вашу игру.

Описание мода

Cloth Config доступен и необходим только на стороне клиента. Однако Cloth Config - это всего лишь API экрана конфигурации, а не полностью конфигурационный API. Вы можете просто игнорировать конфигурацию Cloth, когда находитесь на клиенте, или вы можете попросить сервер отправить клиенту копию конфигурации и синхронизировать ее, когда пользователь сохранит данные из конфигурации Cloth.

Данная модификация всё ещё поддерживает конфигурацию Cloth / Auto, её разработчик всё ещё старается как можно чаще выпускать Cloth Config на более новые версии игры, с каждой версией исправляя всё больше ошибок и багов.
Также, если по каким либо причинам пользователей не устраивает Cloth Config или Auto Config, то существует несколько примечательных альтернатив, которые, на наш взгляд, тоже довольно хороши:

• Midnight Config;
• Owo - lib;
• Oro Config.

Cloth Config можно настроить как для Fabric, так и для Forge. Только сразу предупреждаем вас - не используйте Auto Config / Cloth Config для серверных модов! Самым лучшим вариантом будет добавление через Gradle.

Создание экрана конфигурации

Вызовите ConfigBuilder.create() для того, чтобы создать новый конструктор конфигураций, оттуда вы можете установить фон, создать новые категории, отключить плавную прокрутку и т. д.

Заголовок будет автоматически переведен на выбранный пользователем язык, но, на всякий случай, убедитесь, что вы локализовали язык в языковом файле.

ConfigBuilder builder = ConfigBuilder.create()
.setParentScreen(parent)
.setTitle(new TranslatableText("title.examplemod.config"));

Сохранение конфигурации

Вы можете определить код, который запускается, когда пользователь нажимает кнопку сохранения, используя следующий метод:

[...]
builder.setSavingRunnable(() -> {
// Serialise the config into the config file. This will be called last after all variables are updated.
});

Создание категории конфигурации

Вкладки категорий отображаются только в том случае, если у вас более одной категории. Вы можете создать новую категорию, вызвав getOrCreateCategory:

[...]
ConfigCategory general = builder.getOrCreateCategory(new TranslatableText("category.examplemod.general"));

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

Создание параметра конфигурации

Вы можете с лёгкостью создавать параметры с помощью ConfigEntryBuilder, для этого сначала создайте новый ConfigEntryBuilder:

[...]
ConfigEntryBuilder entryBuilder = builder.entryBuilder();

Существует множество типов опций, предоставляемых по умолчанию, которые вы можете выбрать. Вот пример добавления нового текстового поля String:

[...]
general.addEntry(entryBuilder.startStrField(new TranslatableText("option.examplemod.optionA"), currentValue)

.setDefaultValue("This is the default value") // Используется, когда пользователь нажимает кнопку сброса.

.setTooltip(new TranslatableText("This option is awesome!")) // Отображается при наведении курсора мыши на этот параметр.

.setSaveConsumer(newValue -> currentValue = newValue) // Рекомендуется вызывать в том случае, когда пользователь сохраняет конфигурацию.

.build()); // Создает запись параметра для конфигурации. Текущим значением должно быть поле, содержащее значение параметра, и потребитель savy сохранит его обратно при сохранении конфигурации.

Создание экрана конфигурации

Вот, как вы можете получить готовый экран из конструктора:

[...]
Screen screen = builder.build();


И вот, как вы можете показать его игроку:

[...]
MinecraftClient.getInstance().openScreen(screen);

Введение в автоматическую настройку

API был основан на аннотациях конфигураций для модов с интеграцией графического интерфейса Cloth Config, предназначенного для использования другими модами. Просто добавьте несколько аннотаций к вашему классу конфигурации, и этот мод позаботится о создании графического интерфейса конфигурации для вас.