Equator Lib

Equator Lib

A Simple Rendering Library.

Client Library

1,244 downloads
1 follower
Created 2 months ago
Updated 13 days ago

External resources



Project members

KrLite

Owner


Technical information

License
Client side
required
Server side
unsupported
Project ID

Banner

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

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

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

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 and JitPack to implement Equator Utils.

Add the content below to your build.gradle:

repositories {
    // Modrinth Maven, for the mod Equator
    maven { url = "https://api.modrinth.com/maven" }
    
    // JitPack, for Equator Utils(you probably want this too)
    maven { url 'https://jitpack.io' }
}

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

In above:

  • v{x} in maven.modrinth:equator:{x} should be the latest version id of Equator, equals to the tag name.
  • v{x} in com.github.KrLite:Equator-Utils:v{x} should be the latest tag name of Equator Utils.

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. To only implement Equator, refer to the content below:

repositories {
    maven { url = "https://api.modrinth.com/maven" }
}

dependencies {
    modImplementation "maven.modrinth:equator:{x}"
}

Dependency

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

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

And Quilt, in your quilt.mod.json:

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