Registed

# Registed ## Implementation First, implement **Registed** through gradle: <details> <summary>Using <b>Groovy</b></summary> ###### build.gradle ```groovy repositories { maven { url "https://api.modrinth.com/maven" } } dependencies { modApi "maven.modrinth:registed:$project.registed_version" } ``` ###### gradle.properties ``` registed_version=? ``` > Replace `?` with the latest (https://github.com/HO-Artisan/Registed/tags) of **Registed.** </details> <details> <summary>Using <b>Kotlin</b></summary> ###### build.gradle.kts ```kotlin repositories { maven("https://api.modrinth.com/maven") } dependencies { modApi("maven.modrinth:registed:${property("registedVersion")}") } ``` ###### gradle.properties ``` registedVersion=? ``` > Replace `?` with the latest (https://github.com/HO-Artisan/Registed/tags) of **Registed.** </details> Next, reference **Registed** into your `fabric.mod.json` as a dependency: <h6 align="right">fabric.mod.json</h6> ```json5 { // Other contents "depends": { "registed": "*" }, // Other contents } ``` > **Registed** **should not** be nested in your project. You should always treat **Registed** as a standalone mod. ## Usage To register an object, do: ###### full.path.to.ClassName.java ```java @RegistryId("modid") public class ClassName { @ho.artisan.registed.annotation.registries.Item public static final Item ITEM = ...; } ``` You must annotate your registration class with `@RegistryID` to tell **Registed** which namespace to use. : `ho.artisan.registed.annotation.RegistryID` After that, remember to reference this class in your `fabric.mod.json`: ###### fabric.mod.json ```json5 { // Other contents "entrypoints": { "registed": }, // Other contents } ``` **Registed** supports all `Registry<?>` types inside class `Registries`. You should convert the target registry type name from **UPPER_SNAKE_CASE** to **CamelCase** to find the desired annotation, for example, `Registries.LOOT_NBT_PROVIDER_TYPE` has a representing annotation `@LootNBTProviderType`. : `net.minecraft.registry.Registries` > All available annotations for registered objects are under package `ho.artisan.registed.annotation.registries`. > These annotations can only be applied on fields, and you should always make sure your registered objects are `static` and `final` fields. By default, the registered objects will use their field names in **snake_case** as their in-game identifier paths, for example, field `MY_EXAMPLE_ITEM` will have the identifier path of `my_example_item`. We suggest using **UPPER_SNAKE_CASE** to name your fields, as they should be `static` and `final` and only in snake cases will **Registed** preserve the underscores. To customize a registered object's in-game identifier path, you can apply annotation `@RegistryID` to the target field: ```java @RegistryID("my_item") @ho.artisan.registed.annotation.registries.Item public static final Item ITEM = ...; ``` > The identifier path provided by `@RegistryID` will be consumed as raw without any further processing.