ShiroCore

<p align="center"> <a href="https://github.com/tantaihaha4487/ShiroVerse/actions/workflows/build-plugin.yml" style="text-decoration:none;"><img src="https://github.com/tantaihaha4487/QDropConfirm/actions/workflows/build-plugin.yml/badge.svg" alt="Build Status"></a> <a href="https://github.com/tantaihaha4487/ShiroVerse/releases/latest" style="text-decoration:none;"><img src="https://img.shields.io/github/v/release/tantaihaha4487/ShiroVerse?style=flat-square" alt="Latest Release"></a> <a href="https://jitpack.io/#tantaihaha4487/ShiroVerse" style="text-decoration:none;"><img src="https://jitpack.io/v/tantaihaha4487/ShiroVerse.svg" alt="jitpack badge"></a> </p> # ShiroCore **ShiroCore** is a powerful library plugin for Minecraft (Spigot/Paper) designed to simplify the creation of complex, interactive player abilities. It provides a robust framework for shift-activated skills, complete with progress bars, event handling, and a clean API, allowing developers to focus on building unique gameplay mechanics. --- ## 🛠️ Understanding the Components: Engine vs. API The ShiroVerse project is composed of two key modules that work together: `ShiroCore` (the engine) and `shiro-api` (the developer kit). Understanding their distinct roles is crucial for using the framework effectively. ### **`ShiroCore` — The Engine** - **What It Is:** The actual Spigot/Paper plugin that you install on your Minecraft server. It's the heart of the system. - **What It Does:** It contains all the core logic for detecting player actions (like shift-spamming), managing ability states, handling cooldowns, and displaying visual feedback like action bar progress bars. - **Who It's For:** - **Server Owners:** You install this single plugin in your `plugins` folder. It's the powerhouse that makes all dependent plugins work. - **Developers:** Your plugins require `ShiroCore` to be present on the server to function. It's the runtime environment for your creations. ### **`shiro-api` — The Developer Kit** - **What It Is:** A lightweight Java library (`.jar`) that developers use to write their own plugins that integrate with `ShiroCore`. - **What It Does:** It provides a clean and simple API to register custom abilities, listen to events, and control the activation system without needing to access the complex internal code of the engine. Key components include: - `AbilityManager`: For registering and managing your custom abilities. - `ShiftAbility`: An abstract class you extend to create your own shift-activated skills quickly. - `ActionbarMessage`: A utility for creating stylish progress bars and alerts. - `DependencyLogger`: A utility for professional, consistent dependency error logging. - **Who It's For:** - **Developers:** You include `shiro-api` as a dependency in your plugin's `pom.xml` (or other build system). It is your toolbox for building new gameplay features on top of the ShiroCore engine. --- ## 🌟 Core Features ### **1. Shift Activation System** Create abilities that activate through rapid shift-key spamming (configurable threshold). - 🎯 **Configurable Progress** - Set custom shift count requirements - 📊 **Progress Events** - Track activation progress in real-time - 🎨 **Action Bar Integration** - Beautiful progress bars with mini-font support - ⚡ **Material-Based Registration** - Register specific materials for activation ### **2. Ability Manager API** Simplified API for creating and managing shift-activated abilities. - 🔌 **Plugin-Friendly** - Easy integration with any Spigot/Paper plugin - 🔄 **Automatic State Management** - Handles activation/deactivation automatically - 🎮 **Event-Driven** - Built-in event handling for abilities - 🛡️ **Thread-Safe** - Concurrent-safe ability tracking ### **3. Action Bar Utilities** Create stylish action bar messages with multiple design options. - 🎨 **Multiple Styles** - Default, gradient, and minimalist loading bars - 🔤 **Mini-Font Support** - Small, clean text rendering - 🌈 **Custom Colors** - Full color customization - ⚡ **Alert Messages** - Pre-formatted alert system ### **4. Dependency Logger** Professional, consistent dependency error messaging for your plugins. - 📦 **Standardized Messages** - Beautiful bordered error boxes - 🎯 **Version Checking** - Built-in version mismatch warnings - 🔗 **Helpful Links** - Automatic ShiroCore download links - ♻️ **Reusable** - Use across all your ShiroCore-dependent plugins --- ## 📦 Installation ### **As a Server Plugin** 1. Download the latest JAR from (https://github.com/tantaihaha4487/ShiroVerse/releases) 2. Place in your server's `plugins` folder 3. Restart the server ### **As a Dependency** Add to your `pom.xml`: ```xml <repositories> <repository> <id>jitpack.io</id> <url>https://jitpack.io</url> </repository> </repositories> <dependencies> <dependency> <groupId>com.github.tantaihaha4487.ShiroVerse</groupId> <artifactId>shiro-api</ar