SIR

SIR – Simple In-game Receptionist

A modular Minecraft assistant that centralizes chat management, announcements, onboarding, and cross-platform communication. SIR ships with a rich configuration toolkit so you can tailor every interaction players see without touching Java code.

---

Feature Highlights

- Live updates & metrics – Toggle self-contained modules for chat, join/quit experiences, announcements, MOTDs, advancements, and third-party hooks. - Live updates & metrics – Build channel hierarchies, apply gradient colours, emojis, hover/click actions, tags, and mention effects directly from YAML. - Live updates & metrics – Craft first-join flows, spawn teleport rules, welcome/farewell messages, and timed invulnerability windows. - Live updates & metrics – Schedule announcements that mix chat, action bar, title, boss bar, sounds, and console commands. - Live updates & metrics – Mirror activity with DiscordSRV or EssentialsDiscord using embed templates, per-event routing, and cross-server relays. - Live updates & metrics – Coordinate with major authentication and vanish plugins so muted, hidden, or unauthenticated players follow your rules. - Live updates & metrics – The Takion framework is bundled, providing the scheduler, text processors, gradients, and boss bars you rely on—no extra download needed. - Live updates & metrics – Automatic update checks, optional coloured console logging, and bStats analytics keep administrators informed.

---

Compatibility Matrix

| Area | Details | | --- | --- | | Analytics | Spigot/Paper/Folia API 1.13+ (Folia flag enabled in `plugin.yml`). | | Analytics | Compiled for Java 8 targets while building with Maven (Java 21 toolchain supported). | | Analytics | Vault-driven chat adapter with automatic fallback when Vault is absent. | | Analytics | PlaceholderAPI expansion included; formats across messages, announcements, and Discord bridge respect PAPI placeholders. | | Analytics | Takion gradient & rainbow tags, hover/click actions, and InventoryFramework-powered GUIs for chat colour menus. | | Analytics | bStats (ID 25264) with drill-down charts for detected integrations. |

---

Built-in & Optional Integrations

| Category | Supported Plugins / Libraries | Notes | | --- | --- | --- | | Moderation synergy | Takion 1.3, GlobalScheduler, LangUtils | Shaded inside SIR—no external jars needed. | | Moderation synergy | bStats | Relocated package (`me.croabeast.metrics`) to avoid conflicts. | | Moderation synergy | Vault, InteractiveChat | Automatically detected; permissions exposed through `commands.yml` and channel configs. | | Moderation synergy | PlaceholderAPI | Optional but fully supported; registers a dedicated expansion. | | Moderation synergy | DiscordSRV, EssentialsDiscord | Route join/quit/advancement/chat events with per-channel embed templates. | | Moderation synergy | AuthMe, UserLogin, NexAuth, nLogin, OpeNLogin | Shared spawn handling via `modules/hook/login.yml`. | | Moderation synergy | CMI, EssentialsX, SuperVanish, PremiumVanish | Optional vanish chat key rules to block message leaks. | | Moderation synergy | AdvancedBan and other punishment suites | Use cooldowns, mute commands, and violation actions to complement third-party moderation. |

---

Modular Platform Overview

| Module | Purpose | Key Configuration Files | | --- | --- | --- | | Hooks – Login/Vanish | Welcomes players, controls vanilla join/quit spam, and manages spawn & invulnerability. | `modules/join_quit/config.yml`, `modules/join_quit/messages.yml` | | Hooks – Login/Vanish | Time-based broadcasts mixing chat, titles, action bars, sounds, and commands. | `modules/announcements/config.yml`, `modules/announcements/announces.yml` | | Hooks – Login/Vanish | Rotates server list MOTDs and icons with custom counters. | `modules/motd/config.yml`, `modules/motd/motds.yml` | | Hooks – Login/Vanish | Broadcasts achievements with rewards and per-world/mode filters. | `modules/advancements/config.yml`, `modules/advancements/messages.yml` | | Hooks – Login/Vanish | Hierarchical global/local channels with inheritance and colour governance. | `modules/chat/channels.yml` (see wiki guide) | | Hooks – Login/Vanish | Anti-spam timers and scripted punishments. | `modules/chat/cooldowns.yml` | | Hooks – Login/Vanish | Replace shortcuts with formatted text and manage permission-based tags. | `modules/chat/emojis.yml`, `modules/chat/tags.yml` | | Hooks – Login/Vanish | Highlight recipients with sounds, hover/click actions, and custom outputs. | `modules/chat/mentions.yml` | | Hooks – Login/Vanish | Filter swears, caps, links, and enforce format standards. | `modules/chat/moderation.yml` | | Hooks – Login/Vanish | DiscordSRV channel routing and embed templates. | `modules/hook/discord.yml`, `webhooks.yml` | | Hooks – Login/Vanish | Sync behaviour with authentication and vanish plugins. | `modules/hook/login.yml`, `modules/hook/vanish.yml` |

All modules are toggled from `modules/modules.yml`, which also manages update tracking for shipped configs.

---

Command Suite

| Command | Summary | Highlights | | --- | --- | --- | | `/sir` | Administrative hub | About, reload, module status, help, support links. | | `/print` | Raw formatted broadcaster | Targeted chat, titles, action bars, Discord webhooks. | | `/announcer` | Manage automated announcements | Preview, start/stop, reboot sequences. | | `/chatview` | Channel visibility | Players opt in/out of channel subscriptions. | | `/chatcolor` | GUI colour selector | Unlockable colours, gradients, rainbow styles. | | `/ignore` | Personal mute list | Persistent ignore data per player. | | `/clearchat` | Clear local/global chat | Instant moderation tool. | | `/msg`, `/reply` | Private messaging | Sound & action feedback for mentions. | | `/mute`, `/tempmute`, `/unmute`, `/checkmute` | Moderation controls | Permanent or timed mutes powered by configurable lang/data files. |

Command behaviour, aliases, and language strings live under `resources/commands/` for complete customization.

---

Formatting & Player Experience Toolkit

- Boss bars & titles: Define the main plugin prefix, centred text tag, and line separators in `config.yml`. - Boss bars & titles: Use `<G:#RRGGBB:#RRGGBB>` or `<R:n>` syntax anywhere the plugin parses text. - Boss bars & titles: Attach hover lists and click actions across messages, announcements, and mentions. - Boss bars & titles: Assign unique join/quit, mention, and announcement sounds using vanilla sound keys. - Boss bars & titles: Per-message group spawn teleporters align with login plugins when enabled. - Boss bars & titles: Tap into Takion’s animated boss bars for announcement or module-specific effects.

---

Getting Started

1. Reload or restart – No external dependencies are required; Takion is already shaded inside the jar. 2. Reload or restart – Configuration files populate under `plugins/SIR/resources/`. 3. Reload or restart – Toggle features and adjust update checks. 4. Reload or restart – Edit the YAML files under each module directory to match your server’s tone and rules. 5. Reload or restart – Use your permission manager (Vault-compatible) to assign command and channel access. 6. Reload or restart – `/sir reload` applies configuration changes without a full reboot.

Need more detail? The wiki pages below dive into each subsystem with copy-paste-ready examples.

---

Documentation & Support

- Issue tracker: Issue tracker: - Issue tracker: %%MD1%% - Issue tracker: %%MD2%%

---

Telemetry & Privacy

SIR reports anonymous usage data to bStats (metrics ID `25264`) to help the developer understand which integrations are active. Disable metrics globally in `plugins/bStats/config.yml` or use your firewall if you prefer to opt out.

---

Contributing & Feedback

Found a bug or have a feature request? Open an issue on GitHub or reach out through the Discord community. Contributions are welcome—fork the repository, make your improvements, and submit a pull request.

With SIR, you control every step of the conversation players see. Configure once, delight forever.