Jauml

Документация · Discord · Источник и проблемы

Общая библиотека модов NightBeam

Jauml (Just Another Utility Library Minecraft) содержит код, общий для наших модов: типизированные конфигурации JSON с комментариями, события сервера с планировщиком тиков и один API платформы для Fabric, NeoForge и Forge.

Играете? Если мод запрашивает Jauml, поместите jar-файл вашего загрузчика и версию Minecraft в папку mods. Само по себе оно ничего не добавляет в игру.

3.0 доступен для Fabric, NeoForge и Forge в версиях 1.20.1, 1.21.1, 26.2 и 26.3. Моды, созданные для Jauml 2.x, продолжают работать над ним.

Новинка: полная документация со всеми API, примерами, руководством по миграции и журналом изменений теперь находится по адресу nightbeam.dev/docs/jauml.

Запишите свои настройки в виде простого класса Java и привяжите их с помощью JaumlConfig.bind("my_mod", "common", MyConfig.class).

• Комментарии в файле. @Comment текста, @Range границ, допустимые значения перечисления и значения по умолчанию записываются в виде // строк над каждой опцией. Игроки также могут добавлять свои комментарии; файл все еще загружается.
• Безопасная загрузка. Отсутствующие параметры получают значения по умолчанию, значения неправильного типа преобразуются или сбрасываются, а числа за пределами их диапазона фиксируются, каждое из которых сопровождается предупреждением в журнале.
• Вложенные разделы из вложенных классов, а также списки и карты. Записи на карте, которые игрок удаляет, остаются удаленными.
• Постоянные обновления. reload(), reloadIfChanged(), update(...) и менять слушателей. Файл, который ломается во время работы игры, сохраняет последние хорошие значения; тот, который ломается перед запуском, перемещается на .bak и заменяется значениями по умолчанию.
• Миграция выполняется до привязки, поэтому переименованные или перемещенные параметры сохраняются.

• ServerEvents: запуск, запуск, остановка, остановка, начало и конец тика для выделенных и однопользовательских серверов. ServerEvents.currentServer() возвращает работающий сервер.
• PlayerEvents: присоединяйтесь и уходите.
• Scheduler: runLater, runRepeating и queueServerWork (рабочая очередь MCreator, то же значение), всегда в потоке сервера. Ожидающие задачи удаляются при остановке сервера.
• Один слушатель работает на Fabric, NeoForge и Forge. Запустите сервер с помощью -Djauml.selfTest=true, чтобы увидеть каждое событие в журнале; на карте выше показан этот журнал загрузки NeoForge 26.3.

• Services.load(IMyHelper.class) загружает ваши собственные реализации, специфичные для загрузчика, поэтому вы можете удалить копию класса MultiLoader Services из вашего мода.
• Platform: загрузчик, физический клиент или выделенный сервер, среда разработки, каталоги игры и конфигурации, версия Minecraft, а также версия и название любого загруженного мода.
• Интеграция с учетом версий: Platform.isModLoaded("geckolib", ">=4.4") и Platform.isMinecraft(">=26.2").

API конфигурации 2.x все еще здесь:

• ConfigFile через JaumlConfig.open(...): типизированные геттеры, точечные пути, такие как server.port или users[0].name, списки, атомарные сохранения, перезагрузка при изменении и резервное копирование испорченных файлов.
• JsonSchema для проверки типа, диапазона, перечисления, длины и требуемого ключа, JsonMigrator для версий обновлений и JsonLib для безопасного анализа, глубокого слияния, нормализации и стабильного вывода.
• JaumlConfigLib, статические помощники, вызываемые старыми модами, сохраняет каждый метод и подпись для всей строки 3.x.

• Cooldowns: время восстановления для каждого игрока (или чего-либо еще) по времени на настенных часах или по тикам сервера.
• Version и VersionRange: сравнить 1.20.1, 26.3.0.95-beta или 0.165.0+26.3 и проверить диапазоны, записанные как [2.1,3), >=2.1 <3, ~2.3, ^2, 1.x или a || b.
• Event: небольшой список слушателей с приоритетами ваших мероприятий.

| Майнкрафт | Погрузчики | Ява | Также установите | | --- | --- | --- | --- | | 1.20.1 | Ткань, Кузница | 17 | API Fabric (рекомендуется Fabric) | | 1.21.1 | Ткань, NeoForge | 21 | API Fabric (рекомендуется Fabric) | | 26,2 · 26,3 | Ткань, NeoForge | 25 | API Fabric (рекомендуется Fabric) |

• Загрузите файл, соответствующий вашему загрузчику и версии Майнкрафта, например jauml-fabric-26.3-3.0.0.jar.
• Установите его везде, где установлен мод, которому он нужен: клиент, сервер или оба. — На Fabric конфиги работают без Fabric API; события сервера и планировщик нуждаются в этом, и Jauml регистрирует предупреждение, когда оно отсутствует. Для Fabric в версии 1.20.1 требуется Fabric Loader 0.16.10 или новее.
• Обновление с версии 2.x: замените старый jar. Ваши конфигурационные файлы и моды, которые их используют, работают как прежде.
• Minecraft 1.21.11 или 26.1.2? Оставьте Jauml 2.3.1; 3.0 не предназначен для этих версий.

Джаумл находится на Модринте Мавене. Используйте номер версии, указанный на вкладке «Версии», который заканчивается на ваш загрузчик и версию Minecraft:

repositories {
    maven { url = "https://api.modrinth.com/maven" }
}

dependencies {
    // Fabric 1.20.1 / 1.21.1 and Forge 1.20.1 remap mod jars:
    modImplementation "maven.modrinth:jauml:3.0.0+fabric-1.21.1"
    // NeoForge, and Fabric on 26.x (unobfuscated):
    implementation "maven.modrinth:jauml:3.0.0+neoforge-26.3"
}

Затем объявите его в fabric.mod.json ("jauml": ">=3.0.0") или neoforge.mods.toml/mods.toml (versionRange = "[3.0.0,)"). В руководстве по настройке и руководстве по миграции] описаны все API с примерами.

Делает ли Jauml что-нибудь самостоятельно? Нет. Это библиотека: она загружается, записывает одну небольшую демонстрационную конфигурацию в среде разработки, никогда не используется, и ждет модов, которые ее используют.

Нужно ли мне это на сервере и на клиенте? Установите его везде, где установлен мод, который его требует. Сам Jauml ничего не отправляет по сети.

Будут ли работать мои моды, созданные для Jauml 2.x? Да. Версия 3.0 ничего не удаляет из версии 2.x и не меняет подпись; тест в сборке фиксирует вызов каждого метода, выпущенного модами.

Где конфигурации? В папке config, в папке, выбранной каждым модом, например config/my_mod/common.json.

Где документы? На нашем сайте: Документация · Типизированные конфиги · События сервера · Платформа · Руководство по миграции · Список изменений · Проблемы]

Jauml распространяется под лицензией Apache-2.0. Сделано студией NightBeam.

Jauml поддерживает каждый мод NightBeam. Играйте вместе в Remnants: Ashen Legacy, сюжетном пакете модов для ролевых игр NightBeam.

Еще от NightBeam Studio

• Remnants: Ashen Legacy: сюжетный пакет модов для ролевой игры в стиле Souls, созданный на основе модов NightBeam.
• Плагины премиум-сервера: античит, рейтинговые PvP, настройки SMP и многое другое на сайтеBuildByBit.
• NightBeam Pro: библиотека моделей и кредиты NightBeam Forge, от 5 долларов США в месяц.
• Discord: поддержка, отчеты об ошибках, предложения и первые обзоры.
• Поддержка NightBeam: помогите сохранить каждый мод бесплатным.

Подписывайтесь: YouTube · Instagram · X · Facebook