Skip to content

README.md

Latest commit

 

History

History
117 lines (83 loc) · 4.05 KB

README.md

File metadata and controls

117 lines (83 loc) · 4.05 KB
Raw

Eyelib

the renderer lib for Minecraft.

English | 中文

Getting Started

The lib is published to Maven Central.

Pick the one that matches your target:

Minecraft Loader Java Artifact version
1.20.1 Forge 47.x 17 1.20.1-forge latest
1.21.1 NeoForge 21.1.x 21 1.21.1-neoforge latest
26.1.2 NeoForge 26.1.x 25 26.1.2-neoforge latest

Replace {mod_version} with the artifact version listed above. Check Maven Central for the latest published version of each target.

Gradle

Groovy DSL (build.gradle) 
repositories {
    mavenCentral()
}

dependencies {
    implementation "io.github.tt432:eyelib:{mod_version}"
}
Kotlin DSL (build.gradle.kts) 
repositories {
    mavenCentral()
}

dependencies {
    implementation("io.github.tt432:eyelib:{mod_version}")
}

If your mod will bundle eyelib inside its own jar instead of requiring users to install it separately, use jarJar (Forge / NeoForge) in addition to compileOnly.

Maven

Maven (pom.xml) 
<dependency>
    <groupId>io.github.tt432</groupId>
    <artifactId>eyelib</artifactId>
    <version>{mod_version}</version>
</dependency>

Declaring a mod dependency

Add eyelib as a dependency in your mod metadata so the loader enforces it at runtime.

Forge — src/main/resources/META-INF/mods.toml 
[[dependencies."your_mod_id"]]
    modId="eyelib"
    mandatory=true
    versionRange="[{mod_version},)"
    ordering="AFTER"
    side="CLIENT"
NeoForge — src/main/resources/META-INF/neoforge.mods.toml 
[[dependencies."your_mod_id"]]
    modId="eyelib"
    mandatory=true
    versionRange="[{mod_version},)"
    ordering="AFTER"
    side="CLIENT"

The versionRange uses the mod version — the artifact version with its +mc-loader suffix stripped (e.g. 21.1.23 for 21.1.23+1.20.1-forge) — because that is the version the mod reports in-game. Set side to "CLIENT" (eyelib is a client-side rendering library) or "BOTH" depending on your needs.

Dependencies

  • Handwritten recursive-descent parser for Molang (ANTLR removed).
  • jdk-classfile-backport for generate bytecode for Molang.
  • lombok for generate getter/setter and more.
  • Chin for utils.

Repository Docs