HologramUILib Workspace

This repository is a multi-project Gradle workspace for developing and building both the Fabric HologramUILib client mod and the Spigot-HologramUILib server API.

Project Structure

• Fabric-HologramUILib/ : Minecraft client mod (Fabric)
• Spigot-HologramUILib/ : Spigot server API and plugin
• documentation/ : Centralized documentation (GitBook format)

Documentation

Full technical and user documentation is available in the documentation/ folder, organized into three main sections:

• Mod Overview — General features and concepts
• Spigot Integration Guide — For Spigot plugin developers (server-side API)
• Fabric Mod API Reference — For Fabric mod developers (client-side API)

Important

• If you are developing a Spigot plugin, use the Spigot Integration Guide.
• If you are developing a Fabric mod, use the Fabric Mod API Reference.

For any questions, please refer to the documentation or open an issue on GitHub.

Quick Start

1. Installation

# Clone the workspace
git clone <repository>
cd HologramUILib-Workspace

# Check the setup
./gradlew projectInfo

2. Building Both Projects

# Full build (recommended)
./gradlew build

# Or build individually
./gradlew :Fabric-HologramUILib:build
./gradlew :Spigot-HologramUILib:build

3. Build Artifacts

Compiled JARs are available in:

• Fabric-HologramUILib/build/libs/HologramUILib-1.0-SNAPSHOT.jar
• Spigot-HologramUILib/build/libs/spigot-hologramuilib-1.0-SNAPSHOT.jar

Notes

• All technical and user documentation is centralized in the documentation/ folder.
• Please read the documentation and development guides before contributing.

---

Version: 1.0
Last updated: January 2026