![\"Build](\"https:\/\/github.com\/tantaihaha4487\/QDropConfirm\/actions\/workflows\/build-plugin.yml\/badge.svg\"){kind=icon}
\n
\n
![\"jitpack](\"https:\/\/jitpack.io\/v\/tantaihaha4487\/ShiroVerse.svg\")
\n<\/p>\n\n
\n
\n \n<\/p>\n
# ShiroCore<\/p>\n
**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.<\/p>\n
—<\/p>\n
## \ud83d\udee0\ufe0f Understanding the Components: Engine vs. API<\/p>\n
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.<\/p>\n
### **`ShiroCore` \u2014 The Engine**<\/p>\n
– **What It Is:** The actual Spigot\/Paper plugin that you install on your Minecraft server. It’s the heart of the system.
\n– **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.
\n– **Who It’s For:**
\n – **Server Owners:** You install this single plugin in your `plugins` folder. It’s the powerhouse that makes all dependent plugins work.
\n – **Developers:** Your plugins require `ShiroCore` to be present on the server to function. It’s the runtime environment for your creations.<\/p>\n
### **`shiro-api` \u2014 The Developer Kit**<\/p>\n
– **What It Is:** A lightweight Java library (`.jar`) that developers use to write their own plugins that integrate with `ShiroCore`.
\n– **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:
\n – `AbilityManager`: For registering and managing your custom abilities.
\n – `ShiftAbility`: An abstract class you extend to create your own shift-activated skills quickly.
\n – `ActionbarMessage`: A utility for creating stylish progress bars and alerts.
\n – `DependencyLogger`: A utility for professional, consistent dependency error logging.
\n– **Who It’s For:**
\n – **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.<\/p>\n
—<\/p>\n
## \ud83c\udf1f Core Features<\/p>\n
### **1. Shift Activation System**
\nCreate abilities that activate through rapid shift-key spamming (configurable threshold).<\/p>\n
– \ud83c\udfaf **Configurable Progress** – Set custom shift count requirements
\n– \ud83d\udcca **Progress Events** – Track activation progress in real-time
\n– \ud83c\udfa8 **Action Bar Integration** – Beautiful progress bars with mini-font support
\n– \u26a1 **Material-Based Registration** – Register specific materials for activation<\/p>\n
### **2. Ability Manager API**
\nSimplified API for creating and managing shift-activated abilities.<\/p>\n
– \ud83d\udd0c **Plugin-Friendly** – Easy integration with any Spigot\/Paper plugin
\n– \ud83d\udd04 **Automatic State Management** – Handles activation\/deactivation automatically
\n– \ud83c\udfae **Event-Driven** – Built-in event handling for abilities
\n– \ud83d\udee1\ufe0f **Thread-Safe** – Concurrent-safe ability tracking<\/p>\n
### **3. Action Bar Utilities**
\nCreate stylish action bar messages with multiple design options.<\/p>\n
– \ud83c\udfa8 **Multiple Styles** – Default, gradient, and minimalist loading bars
\n– \ud83d\udd24 **Mini-Font Support** – Small, clean text rendering
\n– \ud83c\udf08 **Custom Colors** – Full color customization
\n– \u26a1 **Alert Messages** – Pre-formatted alert system<\/p>\n
### **4. Dependency Logger**
\nProfessional, consistent dependency error messaging for your plugins.<\/p>\n
– \ud83d\udce6 **Standardized Messages** – Beautiful bordered error boxes
\n– \ud83c\udfaf **Version Checking** – Built-in version mismatch warnings
\n– \ud83d\udd17 **Helpful Links** – Automatic ShiroCore download links
\n– \u267b\ufe0f **Reusable** – Use across all your ShiroCore-dependent plugins<\/p>\n
—<\/p>\n
## \ud83d\udce6 Installation<\/p>\n
### **As a Server Plugin**
\n1. Download the latest JAR from Releases
\n2. Place in your server’s `plugins` folder
\n3. Restart the server<\/p>\n
### **As a Dependency**<\/p>\n
Add to your `pom.xml`:<\/p>\n
“`xml Add to your `plugin.yml`: —<\/p>\n ## \ud83d\ude80 Quick Start<\/p>\n ### **Example 1: Create a Shift-Activated Ability**<\/p>\n “`java public class MyPlugin extends JavaPlugin {<\/p>\n @Override \/\/ Register your custom ability \/\/ Custom ability class public SuperJumpAbility() { @Override @Override @Override **That’s it!** The ability will: —<\/p>\n ### **Example 2: Action Bar Messages**<\/p>\n “`java \/\/ Simple loading bar \/\/ Stylized gradient bar \/\/ Minimalist dot bar \/\/ Alert message **Output Examples:** —<\/p>\n ### **Example 3: Dependency Checking**<\/p>\n “`java public class MyPlugin extends JavaPlugin {<\/p>\n private static final String REQUIRED_SHIROCORE_VERSION = “2.0.0”;<\/p>\n @Override \/\/ Initialize ShiroCore features private boolean checkShiroCore() { if (shiroCore == null) { String version = shiroCore.getPluginMeta().getVersion(); return true; private void logShiroCoreNotFound() { private void logIncompatibleVersion(String foundVersion) { **Benefits:** —<\/p>\n ## \ud83d\udcda API Documentation<\/p>\n ### **AbilityManager**<\/p>\n “`java \/\/ Register an ability \/\/ Unregister an ability \/\/ Get a player’s active ability \/\/ Check if player has any ability active \/\/ Deactivate all abilities for a player ### **ShiftActivation (Low-Level API)**<\/p>\n “`java \/\/ Set shift count required \/\/ Register materials for shift activation \/\/ Check if material is registered ### **Events**<\/p>\n “`java \/\/ Cancel to prevent default behavior \/\/ Listen to shift activation \/\/ Your custom logic ### **DependencyLogger**<\/p>\n “`java \/\/ Log when ShiroCore is not found \/\/ Log when ShiroCore version is incompatible \/\/ Log custom dependency errors \/\/ Get ShiroCore download URL **Output Example:** **Best Practice – Use with try-catch:** —<\/p>\n ## \ud83c\udfa8 Action Bar Styles<\/p>\n ShiroCore provides **three beautiful loading bar styles**:<\/p>\n ### **1. Default Style** **Features:** ### **2. Gradient Style** **Features:** ### **3. Minimalist Dots** **Features:** —<\/p>\n ## \ud83c\udfd7\ufe0f Architecture<\/p>\n “` —<\/p>\n ## \ud83d\udca1 Use Cases<\/p>\n ### **What You Can Build**<\/p>\n – \ud83d\udd28 **Super Tools** – Pickaxes with 3×3 mining, shovels with area digging ### **Real World Example: SuperPickaxe**<\/p>\n Check out the SuperPickaxe-Prototype plugin that uses ShiroCore:<\/p>\n – \ud83d\udd28 3×3 block breaking —<\/p>\n ## \ud83e\udd1d Contributing<\/p>\n Contributions are welcome! Please feel free to submit a Pull Request.<\/p>\n 1. Fork the project —<\/p>\n ## \ud83d\udcc4 License<\/p>\n This project is licensed under the MIT License – see the LICENSE file for details.<\/p>\n —<\/p>\n ## \ud83d\udd17 Links<\/p>\n – **GitHub**: tantaihaha4487\/ShiroVerse —<\/p>\n ## \u2728 Credits<\/p>\n Created by **tantaihaha4487** for the ShiroVerse project.<\/p>\n Special thanks to all contributors and the Minecraft development community!<\/p>\n —<\/p>\n \n Built with \u2764\ufe0f for the Minecraft community<\/sub><\/p>\n","protected":false},"excerpt":{"rendered":" Library for ShiroVerse project<\/p>\n","protected":false},"featured_media":138747,"template":"","meta":{"_minecraft_slug":"shirocore","_minecraft_project_id":"Zxu6cKYi","_minecraft_author":"tantaihaha4487","_minecraft_license":"MIT","_minecraft_downloads":110,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"shirocore.zip","_minecraft_size_bytes":129847,"_minecraft_version_count":5,"_minecraft_updated_at":"2026-05-15T19:28:53.143085Z","_minecraft_date_created":"2025-12-02T04:30:52.437237Z","_minecraft_date_modified":"2025-12-06T19:31:28.615256Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/shirocore","_minecraft_icon_attachment_id":138747,"_minecraft_imported_at":"2026-06-08T05:05:11+00:00","_minecraft_import_hash":"d32d0ec47d5a42ead8bdbe9af181a9f8","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[89,873,126,127,128],"mod_loader":[132,133],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-138746","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-game-mechanics","mod_category-library","mod_category-management","mod_category-paper","mod_category-purpur","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","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
\n
\n
\n
\n <\/repository>
\n<\/repositories><\/p>\n
\n
\n
\n
\n
\n
\n <\/dependency>
\n<\/dependencies>
\n“`<\/p>\n
\n“`yaml
\ndepend: [ShiroCore]
\n“`<\/p>\n
\nimport net.thanachot.ShiroCore.api.ability.AbilityManager;
\nimport net.thanachot.ShiroCore.api.ability.ShiftAbility;<\/p>\n
\n public void onEnable() {
\n \/\/ Get the AbilityManager
\n AbilityManager manager = AbilityManager.getOrThrow();<\/p>\n
\n manager.registerAbility(new SuperJumpAbility());
\n }
\n}<\/p>\n
\npublic class SuperJumpAbility extends ShiftAbility {
\n private final Set
\n super(“superjump”, item ->
\n item != null && item.getType() == Material.FEATHER
\n );
\n }<\/p>\n
\n public void onActivate(Player player, ItemStack item) {
\n activePlayers.add(player.getUniqueId());
\n player.sendActionBar(Component.text(“Super Jump Activated!”)
\n .color(NamedTextColor.GREEN));
\n player.addPotionEffect(new PotionEffect(
\n PotionEffectType.JUMP,
\n Integer.MAX_VALUE,
\n 2
\n ));
\n }<\/p>\n
\n public void onDeactivate(Player player) {
\n activePlayers.remove(player.getUniqueId());
\n player.removePotionEffect(PotionEffectType.JUMP);
\n }<\/p>\n
\n public boolean isActive(Player player) {
\n return activePlayers.contains(player.getUniqueId());
\n }
\n}
\n“`<\/p>\n
\n– \u2705 Automatically listen for shift-spam events
\n– \u2705 Show progress bar on action bar
\n– \u2705 Activate when threshold is reached
\n– \u2705 Deactivate when item is swapped<\/p>\n
\nimport net.thanachot.ShiroCore.api.text.ActionbarMessage;<\/p>\n
\nComponent loadingBar = ActionbarMessage.getLoadingBar(currentProgress, maxProgress);
\nplayer.sendActionBar(loadingBar);<\/p>\n
\nComponent gradientBar = ActionbarMessage.getStylizedLoadingBar(
\n current,
\n max,
\n NamedTextColor.AQUA, \/\/ filled color
\n NamedTextColor.GRAY \/\/ empty color
\n);<\/p>\n
\nComponent dotBar = ActionbarMessage.getDotLoadingBar(current, max);<\/p>\n
\nComponent alert = ActionbarMessage.getAlert(“Warning!”, NamedTextColor.RED);
\n“`<\/p>\n
\n“`
\n\u255e\u2550\u2550\u2550\u25b0\u2550\u2550\u2550\u2550\u2561 40% (Default)
\n\u3010\u2588\u2593\u2592\u2591\u2591\u2591\u2591\u2591\u2591\u2591\u3011 40% (Gradient)
\n\u25cf\u25cf\u25cf\u25cf\u25cb\u25cb\u25cb\u25cb\u25cb\u25cb 40% (Dots)
\n(i) Warning! (Alert)
\n“`<\/p>\n
\nimport net.thanachot.shiroverse.api.util.DependencyLogger;
\nimport org.bukkit.plugin.Plugin;<\/p>\n
\n public void onEnable() {
\n if (!checkShiroCore()) {
\n \/\/ Plugin will continue but without ShiroCore features
\n return;
\n }<\/p>\n
\n initializeAbilities();
\n }<\/p>\n
\n Plugin shiroCore = getServer().getPluginManager().getPlugin(“ShiroCore”);<\/p>\n
\n logShiroCoreNotFound();
\n return false;
\n }<\/p>\n
\n if (!version.contains(REQUIRED_SHIROCORE_VERSION)) {
\n logIncompatibleVersion(version);
\n return false;
\n }<\/p>\n
\n }<\/p>\n
\n try {
\n DependencyLogger.logShiroCoreNotFound(
\n getLogger(),
\n “MyPlugin”,
\n REQUIRED_SHIROCORE_VERSION
\n );
\n } catch (NoClassDefFoundError e) {
\n getLogger().warning(“ShiroCore NOT FOUND! MyPlugin requires ShiroCore v”
\n + REQUIRED_SHIROCORE_VERSION + “+”);
\n }
\n }<\/p>\n
\n try {
\n DependencyLogger.logIncompatibleVersion(
\n getLogger(),
\n foundVersion,
\n REQUIRED_SHIROCORE_VERSION
\n );
\n } catch (NoClassDefFoundError e) {
\n getLogger().warning(“INCOMPATIBLE ShiroCore VERSION! Found: ”
\n + foundVersion + “, Required: v” + REQUIRED_SHIROCORE_VERSION + “+”);
\n }
\n }
\n}
\n“`<\/p>\n
\n– \u2705 Professional, consistent error messages
\n– \u2705 Clear instructions for server admins
\n– \u2705 Graceful degradation if DependencyLogger unavailable
\n– \u2705 Reusable across all your plugins<\/p>\n
\n\/\/ Get the manager
\nAbilityManager manager = AbilityManager.getOrThrow();<\/p>\n
\nmanager.registerAbility(ShiftAbility ability);<\/p>\n
\nmanager.unregisterAbility(String abilityId);<\/p>\n
\nOptional
\nboolean hasAbility = manager.hasActiveAbility(Player player);<\/p>\n
\nmanager.deactivateAll(Player player);
\n“`<\/p>\n
\n\/\/ Get the service
\nShiftActivation shift = ShiftActivation.getOrThrow();<\/p>\n
\nshift.setMaxProgress(10);<\/p>\n
\nshift.register(handler, Material.NETHERITE_PICKAXE, Material.DIAMOND_SWORD);<\/p>\n
\nboolean registered = shift.isRegistered(Material.NETHERITE_PICKAXE);
\n“`<\/p>\n
\n\/\/ Listen to shift progress
\n@EventHandler
\npublic void onShiftProgress(ShiftProgressEvent event) {
\n Player player = event.getPlayer();
\n int progress = event.getPercentage();
\n Component message = event.getActionBarMessage();<\/p>\n
\n event.setCancelled(true);
\n}<\/p>\n
\n@EventHandler
\npublic void onShiftActivation(ShiftActivationEvent event) {
\n Player player = event.getPlayer();
\n ItemStack item = event.getItem();<\/p>\n
\n}
\n“`<\/p>\n
\nimport net.thanachot.shiroverse.api.util.DependencyLogger;<\/p>\n
\nDependencyLogger.logShiroCoreNotFound(
\n getLogger(),
\n “YourPlugin”, \/\/ Your plugin name
\n “2.0.0” \/\/ Required ShiroCore version
\n);<\/p>\n
\nDependencyLogger.logIncompatibleVersion(
\n getLogger(),
\n “1.0.0”, \/\/ Found version
\n “2.0.0” \/\/ Required version
\n);<\/p>\n
\nDependencyLogger.logDependencyError(
\n getLogger(),
\n “DEPENDENCY ERROR!”,
\n “ShiroCore API is required.”,
\n “Please install ShiroCore v2.0.0+”
\n);<\/p>\n
\nString url = DependencyLogger.getShiroCoreUrl();
\n“`<\/p>\n
\n“`
\n\u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557
\n\u2551 ShiroCore NOT FOUND! \u2551
\n\u2551 YourPlugin requires ShiroCore v2.0.0+ \u2551
\n\u2551 for abilities to work. \u2551
\n\u2551 \u2551
\n\u2551 The plugin will continue without ability features. \u2551
\n\u2551 \u2551
\n\u2551 Download ShiroCore from: \u2551
\n\u2551 \u2192 https:\/\/modrinth.com\/plugin\/shirocore \u2551
\n\u255a\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255d
\n“`<\/p>\n
\n“`java
\nprivate void checkDependencies() {
\n try {
\n DependencyLogger.logShiroCoreNotFound(
\n getLogger(), “MyPlugin”, “2.0.0”
\n );
\n } catch (NoClassDefFoundError e) {
\n \/\/ Fallback if DependencyLogger isn’t available
\n getLogger().warning(“ShiroCore required!”);
\n }
\n}<\/p>\n
\n“`java
\nActionbarMessage.getLoadingBar(current, max)
\n“`
\n`\u255e\u2550\u2550\u2550\u25b0\u2550\u2550\u2550\u2550\u2561 40%`<\/p>\n
\n– Smooth transition character (\u25b0)
\n– Green filled, black empty
\n– Clean, modern look<\/p>\n
\n“`java
\nActionbarMessage.getStylizedLoadingBar(current, max, filledColor, emptyColor)
\n“`
\n`\u3010\u2588\u2593\u2592\u2591\u2591\u2591\u2591\u2591\u2591\u2591\u3011 40%`<\/p>\n
\n– Multi-level gradient effect (\u2588 \u2593 \u2592 \u2591)
\n– Custom color support
\n– Asian-style brackets<\/p>\n
\n“`java
\nActionbarMessage.getDotLoadingBar(current, max)
\n“`
\n`\u25cf\u25cf\u25cf\u25cf\u25cb\u25cb\u25cb\u25cb\u25cb\u25cb 40%`<\/p>\n
\n– Clean, simple design
\n– Filled\/empty dot indicators
\n– Minimal visual noise<\/p>\n
\nShiroCore
\n\u251c\u2500\u2500 api\/
\n\u2502 \u251c\u2500\u2500 ability\/
\n\u2502 \u2502 \u251c\u2500\u2500 ShiftAbility.java (Abstract base class)
\n\u2502 \u2502 \u2514\u2500\u2500 AbilityManager.java (Service API)
\n\u2502 \u251c\u2500\u2500 event\/
\n\u2502 \u2502 \u251c\u2500\u2500 ShiftProgressEvent.java
\n\u2502 \u2502 \u251c\u2500\u2500 ShiftActivationEvent.java
\n\u2502 \u2502 \u2514\u2500\u2500 ShiftEvent.java
\n\u2502 \u251c\u2500\u2500 text\/
\n\u2502 \u2502 \u2514\u2500\u2500 ActionbarMessage.java
\n\u2502 \u251c\u2500\u2500 util\/
\n\u2502 \u2502 \u2514\u2500\u2500 DependencyLogger.java (Dependency logging)
\n\u2502 \u2514\u2500\u2500 ShiftActivation.java
\n\u2514\u2500\u2500 internal\/
\n \u251c\u2500\u2500 ability\/
\n \u2502 \u251c\u2500\u2500 AbilityManagerImpl.java (Implementation)
\n \u2502 \u2514\u2500\u2500 AbilityListener.java (Event handling)
\n \u251c\u2500\u2500 handler\/
\n \u2502 \u2514\u2500\u2500 ShiftActivationHandler.java
\n \u2514\u2500\u2500 system\/
\n \u2514\u2500\u2500 ShiftActivationService.java
\n“`<\/p>\n
\n– \u2694\ufe0f **Combat Abilities** – Swords with special attacks, bows with enhanced arrows
\n– \ud83c\udfc3 **Movement Skills** – Speed boots, jump abilities, teleportation
\n– \ud83d\udee1\ufe0f **Defensive Powers** – Shields with absorption, armor with resistance
\n– \ud83c\udfaf **Custom Mechanics** – Anything that activates via shift-spam!<\/p>\n
\n– \ud83c\udfa8 Beautiful activation effects
\n– \u26a1 Only ~80 lines of code (thanks to ShiroCore!)<\/p>\n
\n2. Create your feature branch (`git checkout -b feature\/AmazingFeature`)
\n3. Commit your changes (`git commit -m ‘Add some AmazingFeature’`)
\n4. Push to the branch (`git push origin feature\/AmazingFeature`)
\n5. Open a Pull Request<\/p>\n
\n– **JitPack**: ShiroCore on JitPack
\n– **Issues**: Report a Bug<\/p>\n