VaultUnlocked

VaultUnlocked is a Chat, Permissions & Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves. Everything an API needs with out the driver fluff and nonsense.

Description

VaultUnlocked (Hytale)

Version: 2.19.0 Platform: Hytale / Minecraft
Category: API / Library / Developer Tools

Welcome to the sane API plugin without the caked-in fat of SQL drivers, fluff, and nonsense.

Supported Provider Plugins

This is a list of plugins that currently support VaultUnlocked as a provider. This list may not be up-to-date. Also, if you have added support and would like your plugin to be added to this list, please reach out!

Economy

The goal with economy providers is 100% support by the end of February. This will be accomplished through official implementations inside the economy plugin, or through the compatibility plugin coming soon.

Implementations being worked on:

Chat

List coming soon. Feel free to reach out directly to authors for adding support/inquiring about their support of the API.

Implementations being worked on:

Permissions

List coming soon. Feel free to reach out directly to authors for adding support/inquiring about their support of the API.

HyperPerms

Implementations being worked on:

Supported Consumer Plugins

List coming soon. Feel free to reach out directly to authors for adding support/inquiring about their support of the API.

Documentation / Getting Started

Are you a developer of a Permission, Chat, or Economy plugin, or just a plugin looking to interact with one of these plugins that already uses the VaultUnlocked API? Find out how to get start here: https://tne.gitbook.io/vaultunlocked/

Dependency Setup

VaultUnlocked is published to a public Maven repository and should be added as a provided / compile-only dependency.

Maven

<repositories>
  <repository>
    <id>codemc-creatorfromhell</id>
    <url>https://repo.codemc.io/repository/creatorfromhell/&lt;/url&gt;
  </repository>
</repositories>

<dependency>
  <groupId>net.cfh.vault</groupId>
  <artifactId>VaultUnlocked</artifactId>
  <version>2.18.3</version>
  <scope>provided</scope>
</dependency>

Gradle (Kotlin DSL)

repositories {
    maven("https://repo.codemc.io/repository/creatorfromhell/") {
        name = "VaultUnlocked"
    }
}

dependencies {
    compileOnly("net.cfh.vault:VaultUnlocked:2.18.3")
}

Gradle (Groovy DSL)

repositories {
    maven {
        url "https://repo.codemc.io/repository/creatorfromhell/"
    }
}

dependencies {
    compileOnly 'net.cfh.vault:VaultUnlocked:2.18.3'
}

Notes

Use provided (Maven) or compileOnly (Gradle)
Do not shade or bundle VaultUnlocked into your plugin
VaultUnlocked will be supplied by the server at runtime
Prevents duplicate classes and classloader conflicts

What is VaultUnlocked?

VaultUnlocked is the next-generation Vault-style API that provides a unified abstraction layer for economy, permissions, and chat systems.

This Hytale release delivers the same great VaultUnlocked API already used on Paper, Spigot, and Bukkit — now available for Hytale so developers can support multiple platforms without rewriting their integrations.

Same API.
Same concepts.
Same integrations.
Now on Hytale.

For Server Owners

Why use VaultUnlocked?

VaultUnlocked allows plugins to work together without directly depending on a specific economy, permissions, or chat plugin.

Instead of hard dependencies, plugins interact through VaultUnlocked, giving you:

Freedom to switch economy or permissions plugins
Fewer compatibility issues
Cleaner plugin stacks
A standardized and future-proof API

VaultUnlocked does not replace your economy, permissions, or chat plugin — it simply connects them.

For Developers

One API, Multiple Platforms

VaultUnlocked was built with cross-platform compatibility as a core design goal.

If your plugin already supports VaultUnlocked on:

Paper
Spigot
Bukkit

Then it will feel instantly familiar on Hytale.

No platform-specific rewrites.
No duplicated abstractions.
Minimal or zero code changes required.

API Changes in 2.18.0 (Important)

Service Registration Model Update

Starting with VaultUnlocked 2.18.0, services are now registered and accessed through:

VaultUnlockedServicesManager

This replaces the traditional registered service provider approach and aligns better with Hytale’s lifecycle and architecture.

Benefits include:

Explicit service ownership
Predictable lifecycle management
Platform-agnostic behavior
Improved clarity and debugging

Registering Services

Economy, permissions, and chat implementations are now registered directly with the service manager.

VaultUnlockedServicesManager services = VaultUnlockedServicesManager.get();

services.economy(myEconomyImplementation);
services.permission(myPermissionImplementation);
services.chat(myChatImplementation);

Each service is explicitly registered, making behavior consistent across platforms.

Accessing Services

Plugins can retrieve active services at any time using the same manager.

VaultUnlockedServicesManager services = VaultUnlockedServicesManager.get();

Economy economy = services.economyObj();
PermissionUnlocked permission = services.permissionObj();
ChatUnlocked chat = services.chatObj();

If a service is unavailable, VaultUnlocked safely handles the absence so plugins can gracefully degrade.

Why This Change?

Hytale introduces a different plugin lifecycle and service model than Bukkit-based platforms.

VaultUnlockedServicesManager:

Removes reliance on platform-specific registries
Keeps the API explicit and predictable
Enables future expansion beyond economy, permissions, and chat

Despite the internal change, the developer-facing API remains familiar and Vault-like.

What VaultUnlocked Is (and Is Not)

VaultUnlocked IS

A compatibility layer
A service abstraction API
A developer-focused interoperability tool

VaultUnlocked IS NOT

An economy plugin
A permissions plugin
A chat formatting plugin

You choose the implementations — VaultUnlocked connects them.

Version Compatibility

VaultUnlocked (Hytale): 2.18.0
API parity with Bukkit / Spigot / Paper VaultUnlocked
Designed for forward compatibility with future Hytale APIs

Who Should Use VaultUnlocked?

Plugin developers targeting Hytale
Server owners running multiple gameplay plugins
Developers maintaining cross-platform plugins
Anyone who wants a clean, standardized service API

Summary

VaultUnlocked for Hytale brings consistency, stability, and familiarity to a new ecosystem — without forcing developers to relearn or rewrite.

Same API. Same philosophy. Now for Hytale.