Curios API Continuation

Важное примечание

Это неофициальное продолжение CuriosAPI от TheIllusiveC4 для NeoForge (в текущем состоянии) и Forge (в будущем). Пожалуйста, не сообщайте о проблемах этого порта TheIllusiveC4, вместо этого используйте отдельную страницу с проблемами на GitHub или приглашение в Discord. Описание мода и документация будут обновлены в ближайшее время, так что следите за обновлениями!

Обзор

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

Возможности

• Расширяемые слоты экипировки через центральную библиотеку. Новые слоты для снаряжения можно легко создавать и управлять ими через реестр идентификаторов. Идентичные идентификаторы будут объединены, чтобы избежать функционального дублирования и обеспечить максимальную совместимость с потенциальными предметами, в то время как уникальные идентификаторы по-прежнему можно использовать для обозначения специальных типов, когда это уместно.

• Слоты создаются только по требованию. По умолчанию слоты не включены, все слоты создаются только по мере необходимости. Это уменьшает случаи, когда присутствуют один или несколько лишних слотов без подходящих предметов для их заполнения.

• Слоты полностью настраиваемы и управляемы. Слоты могут иметь пользовательский фон, разные размеры и даже могут быть отключены или скрыты по умолчанию. Но как игрок вообще может получить доступ к отключенным слотам? Через API разработчики могут использовать функции для включения/отключения слотов игрока или добавления/удаления определенного количества слотов заданного типа.

• Гибкие отношения предмет-курио с использованием ванильной системы тегов. Потенциальные курио выбираются через ванильную систему тегов, что означает, что категоризация предметов по типам курио так же проста, как создание файла .json в папке data/curios/tags. Предметы можно классифицировать на столько типов курио, сколько вы хотите, если они помечены в соответствующих файлах, и эти настройки можно даже полностью переопределить. Для получения дополнительной информации см. ванильную систему тегов.

• Полная интеграция с другими механиками инвентаря. Починка и проклятия будут работать со всеми применимыми предметами, экипированными в слотах курио. Также есть различные второстепенные функции для разработчиков, которые упрощают интеграцию их текущих предметов или механик в систему курио.

• Доступ из одного графического интерфейса. Curios поставляется с собственным графическим интерфейсом, доступным из инвентаря, который показывает все доступные игроку слоты. Это позволяет игрокам видеть все расширенные слоты экипировки в центральном месте без необходимости доступа к разным графическим интерфейсам инвентаря. Однако разработчики по-прежнему могут предоставлять свои собственные графические интерфейсы для своих мод-специфичных слотов, если захотят. Клавиша по умолчанию для графического интерфейса - 'g'.

Документация

Если вы разработчик, добавьте следующее в ваш файл build.gradle:

repositories {
    maven {
        name = "OctoStudios"
        url = uri("https://maven.octo-studios.com/releases")
    }
}

dependencies {
    implementation 'top.theillusivec4.curios:curios-neoforge:${version}'
}

Замените ${version} на версию Curios, которую вы хотите использовать.