# NiveriaAPI<\/p>\n
 <\/p>\n
NiveriaAPI is a lightweight helper library for Paper plugins that speeds up development with reusable menus, localization, cooldowns, MongoDB persistence, and utilities. Always maintained for 1.21.4-1.21.11 Minecraft releases.
\n!!! This plugin only supports Paper servers or forks !!!<\/p>\n
## Table of Contents
\n– [Features](#features)
\n– [Installation](#installation)
\n– [Usage](#usage)
\n– [Getting started (examples)](#getting-started-examples)
\n– [Contributing](#contributing)
\n– [License](#license)
\n– [Acknowledgements](#acknowledgements)<\/p>\n
## Features<\/p>\n
### Menu System
\n– Component-based menu system
\n– Includes built-in components (Grid, Button, Icon, ProgressBar, Toggle, etc.), exhaustive list can be found here
\n– Easily customizable and extendable with your own components
\n– Supports pagination and dynamic content loading
\n– Examples can be found here<\/p>\n
### Language System
\n– Language system for easy localization
\n– Supports multiple languages
\n– Language files are stored in a simple YAML format for easy editing
\n– Can be based on the player locale or a defined one by you
\n– Features special tags to easily format messages (prefixes, colors)<\/p>\n
### Cooldown System
\n– Easily manage cooldowns for players
\n– Set cooldowns for specific actions or commands
\n– Check if a player is on cooldown and get remaining time
\n– Automatically handle cooldown expiration
\n– Can be persistent across server restarts<\/p>\n
### Database System
\n– Simple database abstraction layer
\n– Only supports MongoDB
\n– Make queries using a simple and intuitive API
\n– Supports asynchronous operations for better performance<\/p>\n
### Utilities
\n– Various utility classes and methods to simplify common tasks
\n– ItemBuilder, Pair, Task, NMSUtils, etc.
\n– All the utilities classes can be found here<\/p>\n
## Installation
\n1. Download the latest release of NiveriaAPI from the releases page.
\n2. Place the downloaded JAR file in your server’s `plugins` directory.
\n3. Restart your server to load the plugin.<\/p>\n
## Usage **Gradle** dependencies { ### Plugin YML **Paper plugin** ## Getting started (examples) “`java @Override @Override \/\/ Create a grid layout and add the button to it “`java \/\/ Get a localized message as a Component or as a String \/\/ Send a localized message to a player “`java \/\/ Create cooldown keys \/\/ Register a persistent cooldown (default behavior) \/\/ Register another persistent cooldown (explicitly persistent) \/\/ Register a non-persistent cooldown (in-memory only) \/\/ Check if player is in cooldown ## Contributing ## License ## Acknowledgements An API I use for all the plugins I make for Niveria, my minecraft server :3<\/p>\n","protected":false},"featured_media":111213,"template":"","meta":{"_minecraft_slug":"niveriaapi","_minecraft_project_id":"ll0lc5oW","_minecraft_author":"PuppyTransGirl","_minecraft_license":"GPL-3.0-only","_minecraft_downloads":81,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"niveriaapi.zip","_minecraft_size_bytes":1750066,"_minecraft_version_count":7,"_minecraft_updated_at":"2026-05-15T20:09:23.869810Z","_minecraft_date_created":"2026-01-22T06:47:53.593346Z","_minecraft_date_modified":"2026-02-21T22:31:16.986453Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/niveriaapi","_minecraft_icon_attachment_id":111213,"_minecraft_imported_at":"2026-06-06T12:58:01+00:00","_minecraft_import_hash":"42222397492b6545328c31a656891ecb","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[125,873,127,128],"mod_loader":[131,132,133],"minecraft_version":[40,41,38,78,79,80,81,82],"class_list":["post-111212","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-folia","mod_category-library","mod_category-paper","mod_category-purpur","mod_loader-folia","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n**Maven**
\n“`xml
\n
\n
\n
\n<\/repository><\/p>\n
\n
\n
\n
\n
\n<\/dependency>
\n“`<\/p>\n
\n“`kotlin
\nrepositories {
\n maven(“https:\/\/www.jitpack.io”)
\n}<\/p>\n
\n compileOnly(“com.github.PuppyTransGirl:NiveriaAPI:VERSION”)
\n}
\n“`
\nReplace `VERSION` with the latest release version.<\/p>\n
\n**Bukkit plugin**
\n“`yaml
\ndepend: [NiveriaAPI]
\n“`<\/p>\n
\n“`yaml
\ndependencies:
\n server:
\n NiveriaAPI:
\n load: BEFORE
\n required: true
\n“`<\/p>\n
\nMinimal snippets to get you started with NiveriaAPI features.<\/p>\nSimple menu with button<\/summary>\n
\npublic class MenuTest extends Menu {
\n public MenuTest(@NotNull Player player) {
\n super(player);
\n }<\/p>\n
\n protected @NotNull Component title() {
\n return Component.text(“My menu :3”);
\n }<\/p>\n
\n protected @NotNull MenuComponent root(@NotNull MenuContext context) {
\n \/\/ Create a button that sends a message when clicked
\n Button button = Button.create()
\n .item(ItemBuilder.of(Material.DIAMOND_BLOCK)
\n .name(Component.text(“Click me !”, NamedTextColor.AQUA))
\n .build()
\n )
\n .onClick(event -> {
\n event.player().sendMessage(Component.text(“Button clicked !”, NamedTextColor.GREEN));
\n })
\n .build();<\/p>\n
\n return Grid.create()
\n .size(9, 3)
\n .add(13, button)
\n .build();
\n }
\n}
\n“`
\n<\/details>\nLanguage system example<\/summary>\n
\n\/\/ Load language files (usually done in your plugin’s onEnable method)
\nLang.load(yourPluginInstance);<\/p>\n
\nComponent message = Lang.get(“welcome_message”);
\nString stringMessage = Lang.getString(“welcome_message”);<\/p>\n
\nPlayer player = …; \/\/ Get the player instance
\nLang.send(player, “welcome_message”);
\n“`
\n<\/details>\nCooldown system example<\/summary>\n
\nCooldownManager cooldownManager = NiveriaAPI.instance().cooldownManager();<\/p>\n
\nKey fireballKey = Key.key(“plugin_name”, “ability_fireball”);
\nKey teleportKey = Key.key(“plugin_name”, “ability_teleport”);
\nKey sprintKey = Key.key(“plugin_name”, “ability_sprint”);<\/p>\n
\ncooldownManager.setCooldown(player, fireballKey, Duration.ofSeconds(30));<\/p>\n
\ncooldownManager.setCooldown(player, teleportKey, Duration.ofHours(1), true);<\/p>\n
\ncooldownManager.setCooldown(player, sprintKey, Duration.ofSeconds(5), false);<\/p>\n
\nif(cooldownManager.inCooldown(player, fireballKey)){
\n long remainingSeconds = cooldownManager.remainingTime(player, fireballKey).getSeconds();
\n player.sendMessage(Component.text(“You must wait ” + remainingSeconds + ” seconds to use this ability again!”, NamedTextColor.RED));
\n return;
\n}
\n“`
\n<\/details>\n
\nContributions are welcome !
\nPlease feel free to submit a pull request or open an issue for any bugs or feature requests :3<\/p>\n
\nThis project is licensed under the GNU General Public License v3.0. See the [LICENSE]([LICENSE](https:\/\/github.com\/PuppyTransGirl\/NiveriaAPI\/blob\/master\/LICENSE)) file for details.<\/p>\n
\n– Thanks to Nirbose for helping me to make the MockBukkit unit tests work with NiveriaAPI.<\/p>\n","protected":false},"excerpt":{"rendered":"