README.md

Custom-Nameplates

How to Build

Command Line

Install JDK 17 & 21.
Start terminal and change directory to the project folder.
Execute ".\gradlew build" and get the artifact under /target folder

IDE

Import the project and execute gradle build action.
Get the artifact under /target folder

How to Contribute

Translations

Clone this project and create a new language file in the /common/src/main/resources/translations directory.
Once your changes are ready, open a pull request for review. We appreciate your works!

Support the Developer

Polymart: https://polymart.org/resource/customnameplates.2543/
BuiltByBit: https://builtbybit.com/resources/customnameplates.36359/
Afdian: https://afdian.com/@xiaomomi/

CustomNameplates API

Maven

<repositories>
  <repository>
    <id>jitpack</id>
    <url>https://jitpack.io/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.github.Xiao-MoMi</groupId>
    <artifactId>Custom-Nameplates</artifactId>
    <version>{VERSION}</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

Gradle (Groovy)

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    compileOnly 'com.github.Xiao-MoMi:Custom-Nameplates:{VERSION}'
}

Gradle (Kotlin)

repositories {
    maven("https://jitpack.io/")
}

dependencies {
    compileOnly("com.github.Xiao-MoMi:Custom-Nameplates:{VERSION}")
}