Takion

<p align="center"> <a href="https://discord.com/invite/gzzhVqgy3b" alt="Support Server"> <img alt="Discord" src="https://img.shields.io/discord/826555143398752286?style=for-the-badge&logo=discord&label=Support%20Server&color=635aea"> </a> </p> # ✨ Takion Takion is an all-in-one toolkit for building premium chat and text experiences on top of the Spigot and Paper Minecraft APIs. From rich message formatting to per-channel moderation rules, Takion ships with a curated set of managers, adapters, and utilities so you can focus on gameplay instead of infrastructure. > **TL;DR**: Drop Takion into your plugin to gain a scheduler-aware messaging layer, powerful placeholder resolution, flexible channel routing, and plenty of formatting sugar out-of-the-box. 🧙‍♂️ --- ## 📚 Table of Contents 1. (#-highlights) 2. (#-module-overview) 3. (#-ecosystem--bundled-apis) 4. (#-installation) 5. (#-quickstart) 6. (#-feature-tour) 7. (#-building-from-source) 8. (#-contributing) 9. (#-license) --- ## 🚀 Highlights - **Production-ready chat core** featuring color pipelines, rich components, and consistent alignment logic. - **Channel, placeholder, and rule management** baked directly into the `TakionLib` entry point for one-line access in your plugin lifecycle. - **Scheduler integration** via `GlobalScheduler`, making it trivial to run asynchronous or delayed messaging tasks without boilerplate. - **Drop-in metrics** (bstats) and optional Vault/chat bridges when using the plugin distribution. - **Ready for shading**—choose between the lightweight core API, the shaded binary, the `shaded:all` variant with extra bundled libraries, or the demonstration plugin module. --- ## 🧩 Module Overview Takion is a multi-module Gradle project. Pick the artifact that matches your distribution strategy: | Module | Description | Ideal For | |----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| | `common` | Shared utilities under `me.croabeast.common`, including builders, reflection helpers, time utilities, dependency loading, and GUI helpers. | Reusing utility APIs independently from the main Takion API. | | `core` | The primary Takion API containing `TakionLib` and managers. Optional when you only need to compile against the exposed API or validate the core sources. | Compiling against Takion's main API or shading it yourself. | | `shaded` | Repackages `common` and `core` together with required libraries (PrismaticAPI, GlobalScheduler, YAML-API) and also publishes an `all` classifier with extra bundled libraries. | Shipping a single jar without configuring repositories in your consumer. | | `plugin` | Example/production-ready plugin bundle that brings in optional adapters (Vault, bStats) and relocates packages using Shadow. | Deploying Takion directly on a server or as a base plugin for further customization. | All modules target **Java 8** using Gradle toolchains, so you can build and run on modern JDKs while remaining compatible with legacy Minecraft hosts. --- ## 🌐 Ecosystem & Bundled APIs Takion leans on several battle-tested libraries created by the same author: - (https://github.com/CroaBeast/PrismaticAPI) - color gradients, RGB conversion and interactive chat components. - (https://github.com/CroaBeast/YAML-API) – lightweight YAML configuration helpers and file management. - (https://github.com/CroaBeast/GlobalScheduler) – abstraction for Paper/Spigot task scheduling. - (https://github.com/CroaBeast/VaultAdapter) *(plugin module)* – bridges Vault chat/permissions into Takion placeholders. - (https://github.com/CroaBeast/CommandFramework) and (https://github.com/CroaBeast/AdvancementInfo)** (via the `shaded:all` classifier) – extendable command and advancement utilities. - (https://bstats.org/) *(plugin module)* – anonymous usage metrics (relocated to avoid conflicts). Optional integrations such as **InteractiveChat** or **Vault** can be toggled inside the plugin module without affecting the core API. --- ## 📦 Installation Add the public repository and choose the dependency that fits your workflow. As of **Takion 1.6.3**, artifacts live under the `me.croabea