Modrinth · Fabric · Client mod

OverlayLib

OverlayLib is a client-side mod. Install it on your computer; the server does not need it.

Library for rendering live info-overlays

Downloads
571.2K
Author
lugosieben
Loader
Fabric
Minecraft
1.21.11 – 26.3
Updated
–

Setup

Install OverlayLib on your client

Client-side mods only run on your computer. More server RAM does not change their performance.

  1. 01

    Install the loader locally

    Install Fabric for your Minecraft version in your launcher.

  2. 02

    Download the file

    Download the OverlayLib file for your loader and your exact Minecraft version, for example 26.3.

  3. 03

    Add it to the mods folder

    Put the .jar file in your local .minecraft/mods folder and remove older duplicates.

  4. 04

    Launch

    Launch Minecraft with the loader profile. Nothing needs to change on the server.

On the server
Not needed
On the client
Required
Loader
Fabric
Minecraft
26.3, 26.2, 26.1.2 +3 more
License
Creative Commons Attribution Non Commercial Share Alike 4.0 International

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

OverlayLib · Modrinth
Original description by the project author

OverlayLib

A rendering library for live info-overlays

Overlays

This mod allows other mods to create "Overlays", which can render textures on some or even all blocks with variable color, texture and more, built with informative overlays in mind (e.g. a light level overlay).

This is a LIBRARY mod.

This is a library mod, so only installing this without any other mods won't do anything.

Some features

  • All rendering is done for you with custom shaders and pipelines
  • Configurable yet simple computing of overlay information
  • Caching of overlay data to prevent recomputation every frame
  • Presets for OverlayRenderers and OverlayManagers so you don't have to! (You can code your own too though)

Documentation

There isn't proper documentation for this mod (yet). If you wan't to learn how to use it to create your own mod, you can send me a DM on Discord: @lugosieben

Implementing in your project

Add OverlayLib to your fabric dependencies:

{
  "depends": {
    "overlaylib": "VERSION" // Replace VERSION with a version selector
  }
}

Add the modrinth maven to your repositories in build.gradle:

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

Add OverlayLib to your gradle dependencies:

dependencies {
    modApi "maven.modrinth:overlaylib:VERSION" // Replace VERSION with a version number
}

Now you can start using OverlayLib:

import net.lugo.overlaylib.Overlay

Overlay myOverlay = new Overlay(...);
myOverlay.register();

FAQ

OverlayLib questions

Question not listed? Ask our team.

Does OverlayLib need to be installed on the Minecraft server?

No. Modrinth marks OverlayLib as unsupported on the server side. Install it only in your local mods folder. Your server can stay unchanged unless the project page lists an additional dependency.

Which version and loader does OverlayLib require?

Use a file for Fabric and your exact Minecraft version. Supported versions include 26.3, 26.2, 26.1.2. Files for different loaders are not interchangeable.

OverlayLib is not working – what should I check?

First check the Minecraft version, loader version and required dependencies. Because the mod is client-side, more server RAM will not fix it.

Looking for mods for your own server?

The catalog lists mods that run on Minecraft servers.

Browse all mods