Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.46 KB

README.md

File metadata and controls

53 lines (35 loc) · 2.46 KB
Raw

Mesh

Minecraft Modding Library

Build Status Latest Release OnyxStudios Maven JitPack


Features

  • 🌐 automatic loading of environment variables from .env files at runtime
  • ⚡ automatically register anything that has a registry
  • 🔨 inject recipes at runtime
  • 🐛 wide variety of debug features

Installation

To install Mesh, you need to first add the OnyxStudios maven repository to your buildscript:

repositories {
	maven {
		name = "OnyxStudios"
		url = "https://maven.onyxstudios.dev"
	}
}

After that, you simply add the api and main artifact as runtime dependencies (define mesh_version in your gradle.properties file): If you want to use the automatic registration feature, you also need the annotation processor jar.

dependencies {

	modRuntime "dev.upcraft:Mesh:${project.mesh_version}"
	modApi "dev.upcraft:Mesh-API:${project.mesh_version}"
	annotationProcessor "dev.upcraft:Mesh-Annotations:${project.mesh_version}" // optional; currently only needed for the automatic registration feature

}

Notes

  • Debug mode is enabled by setting the mesh.debug system property to true. For more fine-tuned control see MeshApiOptions.

  • Development mode is enabled by setting the fabric.development system property to true (default for mod workspaces).

    • in development mode only: set the mesh.minecraft.session.username and mesh.minecraft.session.uuid system properties to automatically update your session on game start, and get your username and skin.