https://github.com/GlassPane/Mesh

Modding Library for Fabric
https://github.com/GlassPane/Mesh

fabric fabric-mod fabric-mod-loader fabricmc fabricmc-mod hacktoberfest java minecraft minecraft-mod

Last synced: 13 days ago
JSON representation

Modding Library for Fabric

• Host: GitHub
• URL: https://github.com/GlassPane/Mesh
• Owner: GlassPane
• License: lgpl-3.0
• Created: 2019-01-14T00:42:06.000Z (almost 6 years ago)
• Default Branch: 1.18
• Last Pushed: 2021-11-30T04:38:35.000Z (almost 3 years ago)
• Last Synced: 2024-08-02T06:17:40.231Z (3 months ago)
• Topics: fabric, fabric-mod, fabric-mod-loader, fabricmc, fabricmc-mod, hacktoberfest, java, minecraft, minecraft-mod
• Language: Java
• Homepage: https://www.curseforge.com/minecraft/mc-mods/mesh
• Size: 1.14 MB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-fabric - Mesh - A modding library with various utilities, such as auto-registration of items and blocks, or crafting recipe generation. ([Wiki](https://github.com/GlassPane/Mesh/blob/1.18/README.md)) `LGPL-3.0-only` (Uncategorized / Uncategorized)

README

        
# Mesh

*Minecraft Modding Library*

[![Build Status](https://img.shields.io/github/workflow/status/GlassPane/Mesh/Build%20Status?label=Build%20Status&logo=GitHub&style=flat-square)](https://github.com/GlassPane/Mesh/actions?query=workflow%3A%22Build+Status%22 "GitHub Actions") [![Latest Release](https://img.shields.io/github/v/release/GlassPane/Mesh?include_prereleases&label=Latest%20Release&logo=GitHub&style=flat-square)](https://github.com/GlassPane/Mesh/releases/latest "GitHub Releases") [![OnyxStudios Maven](https://img.shields.io/maven-metadata/v?label=Download%20from%20OnyxStudios%20Maven&metadataUrl=https%3A%2F%2Fmaven.onyxstudios.dev%2Fdev%2Fupcraft%2FMesh%2Fmaven-metadata.xml&style=flat-square)](https://maven.onyxstudios.dev/dev/upcraft/Mesh "maven.onyxstudios.dev") [![JitPack](https://jitpack.io/v/GlassPane/Mesh.svg?label=Download%20from%20JitPack&style=flat-square)](https://jitpack.io/#GlassPane/Mesh "Jitpack Build Status")

---




## Features

-  :globe_with_meridians: automatic loading of environment variables from `.env` files at runtime

- :zap: automatically register anything that has a registry

- :hammer: inject recipes at runtime

- :bug: wide variety of [debug features](#Notes)

## Installation

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

```gradle

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.*

```gradle

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](src/main/java/dev/upcraft/mesh/api/MeshApiOptions.java).

- **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.

---