message-api

# message-api A simple server-side message API for Fabric. It allows for translatable messages, with text parsing using (https://placeholders.pb4.eu/) , which can be customized with ease by end users. ## Features - Special text parsing with PlaceholderAPI - Easy customizable in-game messages - Language localization support - Easy to integrate ## Usage ### Adding the dependency To use message-api in your mod, add the following to your `build.gradle` file: Message-api doesn't bundle placeholder-api, you have to bundle a compatible of it as well. Replace `` with the respective versions. ```groovy repositories { maven { url "https://maven.nucleoid.xyz/" } maven { url "https://api.modrinth.com/maven" } } dependencies { include(modImplementation("maven.modrinth:message-api:")) include(modImplementation("eu.pb4:placeholder-api:")) } ``` ### Adding messages Create a `messages` folder in your resource folder. Create a JSON file with the (https://minecraft.fandom.com/wiki/Language#Languages) you would like to add, like the (src/testMod/resources/messages/en_us.json). Add your message to the file (make sure to prefix the message id with your mod id, to avoid conflicts). ### Creating messages Use any of the provided methods in (src/main/java/me/drex/message/api/LocalizedMessage.java) to get your text instance, which works like any other vanilla text instance! ```java ServerPlayerEntity player; player.sendMessageToClient(LocalizedMessage.localized("modid.some.message.id")); ``` <details> <summary>Official Mojang Mappings</summary> ```java ServerPlayer player; player.sendSystemMessage(LocalizedMessage.localized("modid.some.message.id")); ``` </details> ### User configuration To change messages, edit the JSON file in `./config/<modid>/<languageid>.json`. This will change the language file for the mod with the specified `modid`. ## Credits Special thanks to (https://placeholders.pb4.eu/) for providing the parsing functionality.