CrystalShard API

GitHub Release GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub Actions Workflow Status

CrystalShard is an open-source Minecraft library that provides packet handling, utilities, and server-side helpers to help you build plugins faster and cleaner.

It supports both PaperMC and Velocity, offering modular packages for GUIs, NPCs, resource packs, custom elements, and more.

Modules

Platform ID Description
ALL common Common utils and extensions for crystalshard
PAPER paper-core Core methods and extensions for PaperMC
PAPER paper-box Package-based GUI library for PaperMC (WIP)
PAPER paper-custom Utility library for custom elements and enhancements for Paper & Bukkit
PAPER paper-dhl Package library with factories and helpers for PaperMC (BETA)
PAPER paper-pack Resource pack utilities and helpers for PaperMC
PAPER paper-panic Experimental library for unsafe and unstable PaperMC/Bukkit features
PAPER paper-simulacrum Fancy NPCs, displays, and visual entities
VELOCITY velocity Core utilities and extensions for Velocity

Installation

CrystalShard is available via the public Maven repository:

Repository:
https://repo.xyzhub.link/#/releases/net/crystopia/crystalshard

Add it to your build.gradle.kts:

maven {
    name = "xyzReleases"
    url = uri("https://repo.xyzhub.link/releases")
}

Dependencies

// Common
implementation("net.crystopia.crystalshard:paper-common:<version>")

// Paper
implementation("net.crystopia.crystalshard:paper-core:<version>")
implementation("net.crystopia.crystalshard:paper-box:<version>")       // 🚧 NOT DONE!
implementation("net.crystopia.crystalshard:paper-custom:<version>")
implementation("net.crystopia.crystalshard:paper-dhl:<version>")       // 🧪 BETA!
implementation("net.crystopia.crystalshard:paper-pack:<version>")
implementation("net.crystopia.crystalshard:paper-panic:<version>")
implementation("net.crystopia.crystalshard:paper-simulacrum:<version>")

// Velocity
implementation("net.crystopia.crystalshard:velocity:0.3.1")

License

CrystalShard is licensed under the MIT License, meaning it’s free to use, modify, and distribute. See the LICENSE file for more details.

Credits

Special thanks to the following projects and developers for inspiration and ideas:

Made with ❤️ for the Minecraft developer community.