message-api

message-api

Простой серверный API сообщений для Fabric. Позволяет использовать переводимые сообщения с разбором текста через PlaceholderAPI, который конечные пользователи могут легко настраивать.

Возможности

• Особый разбор текста с PlaceholderAPI
• Легко настраиваемые внутриигровые сообщения
• Поддержка локализации языков
• Простая интеграция

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

Добавление зависимости

Чтобы использовать message-api в своём моде, добавьте следующее в файл build.gradle:

Message-api не включает в себя placeholder-api, вам нужно также подключить совместимую с ним версию. Замените [TAG] на соответствующие версии.

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

dependencies {
    include(modImplementation("maven.modrinth:message-api:[TAG]"))
    include(modImplementation("eu.pb4:placeholder-api:[TAG]"))
}

Добавление сообщений

Создайте папку messages в папке ресурсов. Создайте JSON-файл с кодом языка, который хотите добавить, как в примере testmod. Добавьте своё сообщение в файл (убедитесь, что id сообщения начинается с id вашего мода, чтобы избежать конфликтов).

Создание сообщений

Используйте любой из предоставленных методов в LocalizedMessage, чтобы получить экземпляр текста, который работает как любой другой ванильный экземпляр текста!

ServerPlayerEntity player;
player.sendMessageToClient(LocalizedMessage.localized("modid.some.message.id"));

ServerPlayer player;
player.sendSystemMessage(LocalizedMessage.localized("modid.some.message.id"));

Пользовательская настройка

Чтобы изменить сообщения, отредактируйте JSON-файл в `./config//.json. Это изменит языковой файл для мода с указанным modid`.

Благодарности

Особая благодарность PlaceholderAPI за предоставление функциональности разбора.