TsunamiLib

!Security Notice

!Banner

!Divider

📖 About

TsunamiLib (TL) is a library plugin developed by Voiid Studios to provide shared utilities and systems for plugins that integrate with it.

TsunamiLib does not add gameplay content or standalone features to a server. Instead, it provides reusable functionality that dependent plugins can use, helping keep common systems consistent between projects.

For server administrators, TsunamiLib only needs to be installed when a plugin requires it as a dependency. Plugins that depend on TsunamiLib may not function correctly without the library installed.

For developers, TsunamiLib currently provides JDocs covering its available classes and methods. The library is open source, and its implementation can also be explored through the TsunamiLib source code.

!Divider

✨ Features

• 🧩 Reusable Library: Provides common utilities and systems that plugin developers can integrate into their own projects.
• 🖥️ Platform Support: Provides platform detection and scheduling utilities for Paper, Spigot, and Folia-compatible environments.
• 🎨 Adventure-Powered Messages: Provides a YAML-based message system with multiple-language support and per-plugin prefixes.
• 🖼️ TsunamiGui: Provides reusable inventory GUI components, including pagination, scrolling, storage interfaces, item builders, and NBT utilities.
• 📋 Structured Logging: Provides a unified logging system for plugins using TsunamiLib.
• 🔄 Update Checking: Provides update-checking functionality that dependent plugins can use to check for newer versions.
• 📦 Lightweight Foundation: Provides shared functionality without adding gameplay content to the server.

!Divider

📦 Installation

1. Download the latest version.
2. Place the downloaded .jar file in your server's plugins/ folder
3. Restart the server, TsunamiLib is ready! 🌊

!Divider

📚 Voiid Studios projects using TsunamiLib

TsunamiLib is currently used internally by Voiid Studios and is planned to be integrated into additional projects.

Plugin Name	Status	Planned Use
WonderEvents	✅ Required	Starting with WonderEvents 26.10.0, TsunamiLib is a required dependency.
Voiid Countdown Timer	⚠ In Development	Currently being reworked to use TsunamiLib for shared functionality.
DynamicAPI	⚠ Coming Soon	Use TsunamiLib for shared functionality where applicable.
Waiting Screen	❌ Not Planned	Uses a different implementation and does not require TsunamiLib.
QuestMaster	❌ Not Planned	Uses a different implementation and does not require TsunamiLib.

!Divider

⚡ fastStats