OverlayLib

# 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: ```json { "depends": { "overlaylib": "VERSION" // Replace VERSION with a version selector } } ``` Add the modrinth maven to your repositories in `build.gradle`: ```groovy repositories { maven { url "https://api.modrinth.com/maven" } } ``` Add OverlayLib to your gradle dependencies: ```groovy dependencies { modApi "maven.modrinth:overlaylib:VERSION" // Replace VERSION with a version number } ``` Now you can start using OverlayLib: ```java import net.lugo.overlaylib.Overlay Overlay myOverlay = new Overlay(...); myOverlay.register(); ```