Lucent

A modern config library & High-performance visual toolkit for Fabric. Features NanoVG hardware acceleration, profile isolation, and dynamic HUD systems.

Documentation · Report Bug · Request Feature

🇰🇷 한국어 문서

---

lucent-preview1.mp4

Documentation

Explore Lucent through focused documentation guides for each system and feature.

⚙️ Configuration

• Config Integration Guide
  Annotation-driven config managers, modules, saving/loading, and settings GUI integration.
  Example: ExampleMod.java
• Event System Guide
  Subscribe to game events such as chat messages, ticks, rendering, network packets, and entities.

📺 HUD System

• HUD Configuration Guide
  Create draggable, scalable in-game HUD elements and widgets.
  Example: ExampleHUD.java

🎨 UI & Styling

• UI Widgets Guide
  Ready-to-use widgets including Toggles, Sliders, Dropdowns, TextBoxes, and Color Pickers.

• Theme Configuration Guide
  Customize UI appearance with themes like Midnight Cyan, Glass Morphic, and Crimson Aurora.

🔤 Rendering

• Font Rendering Guide
  Render bundled Pretendard fonts inside NanoVG and Minecraft rendering pipelines.

• Utility Classes & NanoVG Guide
  GPU-accelerated rendering utilities, gradients, shadows, shapes, and Minecraft helper classes.

👥 Profiles

• Profile Management Guide
  Manage configuration profiles and per-profile HUD layouts.

Why Use Lucent?

Recommended for: Client-side mod development, Hypixel SkyBlock mod development.

👨‍💻 For Developers

• Reduces mod size and redundant computation. When multiple mods share Lucent, duplicated code and repeated calculations are eliminated across all of them.
• Smart built-in events. Lucent's events pre-handle null checks and common calculations so you don't repeat expensive logic on every use — improving performance and keeping your code clean and readable.
• Rich utility toolset. Packed with developer-friendly utilities that speed up development and reduce boilerplate.
• Version-resilient APIs. Lucent's utils and events are designed to stay compatible across Minecraft versions, so you rarely need to update your mod code when Minecraft updates.
• Effortless config management. A simple, annotation-driven config system handles saving, loading, and GUI — no config headaches.
• Suitable for all levels. From simple features to fine-grained advanced functionality, Lucent fits mods and developers of any scale.

🎮 For Users

• Lightweight with no performance impact. Lucent is optimized to have minimal overhead.
• Clean, modern UI/UX. Unlike typical config libraries, Lucent provides a polished and intuitive settings interface that enhances the user experience.
• Unified management. Multiple mods and their HUD elements can all be managed from a single, convenient interface.
• Independent config storage. Lucent stores config in an independent local file, so your settings carry over across Minecraft version changes and launcher profile switches on the same PC. Whether you use multiple profiles in Prism Launcher or switch between different Minecraft Launchers, a single config works everywhere. You can also create multiple profiles within Lucent itself and switch between them in-game with a single click.

---

Requirements

🟢 Minecraft 1.21.11 Environment

Dependency	Version
Minecraft	1.21.11
Fabric Loader	>= 0.18.4
Fabric API	>= 0.141.3+1.21.11
LWJGL NanoVG	3.3.3 (bundled)

🟡 Minecraft 26.2 Environment

Dependency	Version
Minecraft	26.2
Fabric Loader	>= 0.19.3
Fabric API	>= 0.152.2+26.2
LWJGL NanoVG	3.3.4 (bundled)

---

Integration

Build Types

Type	Description
[0] Mod	Full standalone mod build with bundled NanoVG. Users must install Lucent separately. Reduces final mod size.
[1] Library	Embedded library build without NanoVG. Lucent is bundled directly into your mod using JIJ, so users do not need a separate installation.

Latest Version

Version Format

[Lucent Version]-[Minecraft Version]-[Build Type]

• Lucent Version: The unique distribution version of the library (e.g., 1.0.0)
• Minecraft Version: The target Minecraft environment (e.g., 1.21.11 or 26.2)
• Build Type: 0 for Standalone Mod, 1 for Embedded Library

💡 Examples:

• 1.0.0-1.21.11-0 (Standalone mod build for 1.21.11)
• 1.0.0-26.2-1 (Embedded library build for 26.2)

---

Gradle Setup

Add the Lucent Maven repository to your build.gradle:

repositories {
	maven {
		url "https://SILENCE-SIMSOOL.github.io/maven-repo/"
	}
}

Then add one of the following dependency setups:

[0] Standalone Mod

dependencies {
	modImplementation "com.github.SILENCE-SIMSOOL:lucent:1.0.0-1.21.11-0"
}

[1] Embedded Library (JIJ)

dependencies {
	modImplementation "com.github.SILENCE-SIMSOOL:lucent:1.0.0-1.21.11-1"
	include "com.github.SILENCE-SIMSOOL:lucent:1.0.0-1.21.11-1"
}

---

Credits

• Config screen UI design was inspired by OneConfig by Polyfrost.
• NanoVG rendering structures and utility drawing systems were inspired by Odin by odtheking.
• Built for Minecraft using the Fabric Project modding ecosystem.

---

License

Licensed under the SILENCE License.
See LICENSE for more information.