What is Vault Unlocked?

Note this is a fork of the original Vault, see the Enhanced Functionality section for what this provides over the original Vault

VaultUnlocked is a versatile API designed to streamline the integration of permissions, chat, and economy systems for plugins. It provides developers with a unified interface, eliminating the need to individually hook or depend on each plugin. This tool was created as a response to the shortcomings of existing APIs like Register and other Permissions systems, which often suffer from either a lack of necessary features or overly complex implementations. VaultUnlocked's goal is to simplify the process, making it more intuitive for developers to support various systems seamlessly.

With its user-friendly approach, VaultUnlocked offers extensive support for different systems, allowing plugins to operate smoothly within diverse environments. The API’s design prioritizes simplicity and effectiveness, addressing the frustrations developers faced with previous solutions. By providing a cohesive and easy-to-use platform, VaultUnlocked enhances the functionality of plugins, ensuring that they can easily connect with permissions, chat, and economy systems without the need for cumbersome workarounds or dependencies.

Enhanced Functionality(What VaultUnlocked Provides that Vault doesn't):

VaultUnlocked offers significant improvements over the existing plugin, particularly for those that implement the updated API. It brings a range of enhanced functionalities, making it a more powerful and flexible tool for developers.

Why VaultUnlocked

Choosing VaultUnlocked over Vault offers a range of benefits that make it a superior choice for plugin developers and server administrators. VaultUnlocked builds upon the foundation of Vault but introduces enhanced features, such as multicurrency support, better compatibility with popular plugins, and the ability to work seamlessly with advanced server frameworks like Folia. Additionally, VaultUnlocked is actively developed, ensuring that it stays up-to-date with the latest advancements and provides more reliable, precise operations, especially in complex economic systems. This combination of modern features and ongoing support makes VaultUnlocked the more robust and future-proof option for managing permissions, chat, and economy systems in your server environment.

Additional Functionality:

• Multicurrency Support: Allows for the management of multiple currencies within the same environment.
• Active Development: Ensures continuous improvements and updates to the API.
• Folia Support: Provides compatibility with the Folia server framework.
• Better Compatibility: Improved integration with plugins like Towny, enhancing overall performance.
• UUID Support: Facilitates the use of universally unique identifiers, thanks to contributions from LlmDl.
• BigDecimal Support: Enables precise and accurate currency calculations, also contributed by LlmDl.

Multicurrency Support

VaultUnlocked introduces multicurrency support, allowing servers to manage and operate with multiple currencies simultaneously. This functionality is particularly useful in complex economic systems where different regions or factions might use different types of currency. By providing a seamless way to handle various currencies, VaultUnlocked ensures that economic transactions are both flexible and accurate, catering to diverse gameplay needs.

Active Development

One of the key strengths of VaultUnlocked is its ongoing active development. The developers behind VaultUnlocked are committed to continuously improving and updating the API, ensuring it remains compatible with the latest plugins and server frameworks. This active development approach guarantees that users benefit from the latest features, bug fixes, and optimizations, keeping the API relevant and reliable in the ever-evolving landscape of Minecraft plugins.

Folia Support

VaultUnlocked also provides compatibility with Folia, a server framework known for its enhanced performance and scalability. Folia support means that plugins using VaultUnlocked can fully leverage the advanced capabilities of this framework, resulting in smoother and more efficient server operations. This makes VaultUnlocked an ideal choice for servers that prioritize high performance and stability.

Better Compatibility

Improved compatibility with popular plugins, such as Towny, is another standout feature of VaultUnlocked. By ensuring better integration with these plugins, VaultUnlocked enhances the overall performance and user experience. This compatibility means fewer conflicts and smoother interactions between different plugins, allowing server administrators to build more cohesive and stable server environments.

UUID Support

VaultUnlocked includes support for Universally Unique Identifiers (UUIDs), thanks to contributions from LlmDl. UUID support is crucial for modern Minecraft servers, as it ensures that player data remains consistent and accurate, even when players change their usernames. This feature enhances the reliability of player identification across various systems within the server, reducing the risk of errors or data loss.

BigDecimal Support

VaultUnlocked introduces BigDecimal support, also contributed by LlmDl. This feature allows for precise and accurate currency calculations, which is essential in servers with complex economies. By using BigDecimal, VaultUnlocked can handle large numbers and fractional values with high precision, ensuring that all financial transactions within the server are accurate and reliable.

License

VaultUnlocked is licensed under the LGPLv3 License. You can find more here.

Configurations/Permissions

Config:

• update-check
• turns the update checker on/off

Permissions:

• vault.admin
• Allows access to vault info, and conversion commands
• Defaults to OP

API/Source

• VaultUnlocked Source: https://github.com/TheNewEconomy/VaultUnlocked
• VaultUnlocked API Source: https://github.com/TheNewEconomy/VaultUnlockedAPI

bStats Collection

VaultUnlocked utilizes bStats to collect various metrics similar to the original Vault plugin. These include:

• A unique identifier
• The server's version of Java
• Whether the server is in offline or online mode
• Plugin's version
• Server's version
• OS version/name and architecture
• core count for the CPU
• number of players online
• Metrics version
• Which Chat, Economy, and Permission hook is currently being used

You may opt out of the bStats metrics collection by editing plugins/bstats/config.yml and changing opt-out to true.

Linking VaultUnlocked For information on implementing VaultUnlocked please refer to: https://github.com/TheNewEconomy/VaultUnlockedAPI