Skip to content
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.
/ Equator Public archive

A simple rendering library for Minecraft.

License

Notifications You must be signed in to change notification settings

KrLite/Equator

Repository files navigation

Banner

Note This repository is stale since Equator has updated into version 2.
See Equator v2

A Simple Rendering Library for Minecraft.

Equator is a lightweight library designed to make rendering in Minecraft easier.

With Equator, you can render and manage texture resources with ease, and get access to many useful rendering utilities.

TL;DR

1. Implement Equator in your build.gradle

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

dependencies {
    modImplementation "com.github.KrLite:Equator:{a.b.c}+{v1}"
    implementation include("com.github.KrLite:Equator-Utils:{v2}")
}

In above:

2. Add Equator as a mod dependent

"depends": {
  "equator": "*"
}

Features

  • Equator - The main class for rendering, including Renderer for sprites, Painter for colors and shapes, and ItemModel and BlockModel to render models in ease.
  • Math - Access easing functions and analyse angles, coordinates, etc.
  • Utilities - Use Pusher and Timer to handle animations and rendering rules in a simpler way.
  • Management - Manage your textures as IdentifierSprites and render them with Rects and TintedRects.
  • More - Equator Lib is in active development! More features will be added soon.

Implementation

You can use Modrinth Maven to implement Equator, or use JitPack to implement both Equator and Equator Utils.

Add the content below to your build.gradle:

  • Modrinth Maven
repositories {
    maven { url = "https://api.modrinth.com/maven" }
    maven { url 'https://jitpack.io' }
}

dependencies {
    modImplementation "maven.modrinth:equator:{v1}"
    implementation include("com.github.KrLite:Equator-Utils:{v2}")
}

In above:

For example: {v1} → v1.0 {v2} → v1.0.0

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

dependencies {
    modImplementation "com.github.KrLite:Equator:{a.b.c}+{v1}"
    implementation include("com.github.KrLite:Equator-Utils:{v2}")
}

In above:

For example: {a.b.c}+{v1} → 1.19.3+v1.0 {v2} → v1.0.0

If you do not implement Equator Utils, Equator can still function fully, but you may not be able to access many convenient methods that Equator uses.

Dependency

Finally, don't forget to add Equator as a mod dependent in your fabric/quilt.mod.json:

  • Fabric
"depends": {
  "equator": "*"
}
  • Quilt
"depends": [
  {
    "id": "equator",
    "versions": "*"
  }
]