Mineforgian
SIR
A simple chat plugin that have a lot of functions to customize your server.
- Загрузки
- 646
- Подписчики
- 9
- Обновлён
- 2 июля 2026 г.
- Лицензия
- GPL-3.0-only
Опубликован 24 мая 2023 г.
Text Description
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
- Modular architecture – Toggle self-contained modules for chat, join/quit experiences, announcements, MOTDs, advancements, and third-party hooks.
- Deep chat customization – Build channel hierarchies, apply gradient colours, emojis, hover/click actions, tags, and mention effects directly from YAML.
- Player journey controls – Craft first-join flows, spawn teleport rules, welcome/farewell messages, and timed invulnerability windows.
- Automated outreach – Schedule announcements that mix chat, action bar, title, boss bar, sounds, and console commands.
- Discord-ready – Mirror activity with DiscordSRV or EssentialsDiscord using embed templates, per-event routing, and cross-server relays.
- Login & vanish awareness – Coordinate with major authentication and vanish plugins so muted, hidden, or unauthenticated players follow your rules.
- Takion-powered runtime – 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 |
|---|---|
| Minecraft server | Spigot/Paper/Folia API 1.13+ (Folia flag enabled in plugin.yml). |
| Java runtime | Compiled for Java 8 targets while building with Maven (Java 21 toolchain supported). |
| Permissions | Vault-driven chat adapter with automatic fallback when Vault is absent. |
| Placeholder support | PlaceholderAPI expansion included; formats across messages, announcements, and Discord bridge respect PAPI placeholders. |
| Text effects | 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 |
|---|---|---|
| Bundled libraries | Takion 1.3, GlobalScheduler, LangUtils | Shaded inside SIR—no external jars needed. |
| Metrics | bStats | Relocated package (me.croabeast.metrics) to avoid conflicts. |
| Chat & permissions | Vault, InteractiveChat | Automatically detected; permissions exposed through commands.yml and channel configs. |
| Placeholder system | PlaceholderAPI | Optional but fully supported; registers a dedicated expansion. |
| Discord bridge | DiscordSRV, EssentialsDiscord | Route join/quit/advancement/chat events with per-channel embed templates. |
| Authentication | AuthMe, UserLogin, NexAuth, nLogin, OpeNLogin | Shared spawn handling via modules/hook/login.yml. |
| Vanish handling | 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 |
|---|---|---|
| Join/Quit | Welcomes players, controls vanilla join/quit spam, and manages spawn & invulnerability. | modules/join_quit/config.yml, modules/join_quit/messages.yml |
| Announcements | Time-based broadcasts mixing chat, titles, action bars, sounds, and commands. | modules/announcements/config.yml, modules/announcements/announces.yml |
| MOTD | Rotates server list MOTDs and icons with custom counters. | modules/motd/config.yml, modules/motd/motds.yml |
| Advancements | Broadcasts achievements with rewards and per-world/mode filters. | modules/advancements/config.yml, modules/advancements/messages.yml |
| Chat – Channels | Hierarchical global/local channels with inheritance and colour governance. | modules/chat/channels.yml (see wiki guide) |
| Chat – Cooldowns | Anti-spam timers and scripted punishments. | modules/chat/cooldowns.yml |
| Chat – Emojis & Tags | Replace shortcuts with formatted text and manage permission-based tags. | modules/chat/emojis.yml, modules/chat/tags.yml |
| Chat – Mentions | Highlight recipients with sounds, hover/click actions, and custom outputs. | modules/chat/mentions.yml |
| Chat – Moderation | Filter swears, caps, links, and enforce format standards. | modules/chat/moderation.yml |
| Hooks – Discord | 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
- Message prefixing: Define the main plugin prefix, centred text tag, and line separators in
config.yml. - Gradient & rainbow tags: Use
<G:#RRGGBB:#RRGGBB>or<R:n>syntax anywhere the plugin parses text. - Interactive components: Attach hover lists and click actions across messages, announcements, and mentions.
- Sound design: Assign unique join/quit, mention, and announcement sounds using vanilla sound keys.
- Spawn logic: 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
- Drop SIR into
plugins/– No external dependencies are required; Takion is already shaded inside the jar. - Start your server once – Configuration files populate under
plugins/SIR/resources/. - Review
config.ymlandmodules/modules.yml– Toggle features and adjust update checks. - Tailor modules – Edit the YAML files under each module directory to match your server’s tone and rules.
- Grant permissions – Use your permission manager (Vault-compatible) to assign command and channel access.
- Reload or restart –
/sir reloadapplies configuration changes without a full reboot.
Need more detail? The wiki pages below dive into each subsystem with copy-paste-ready examples.
Documentation & Support
- Wiki: https://github.com/CroaBeast/SIR/wiki
- Community Discord: https://discord.gg/s9YFGMrjyF
- Issue tracker: https://github.com/CroaBeast/SIR/issues
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.
Ченджлог
2.4.4Релиз26.1, 26.1.1, 26.1.2 · 2 июля 2026 г.
Discord Relay Webhook Updates
Discord relay update focused on cleaner webhook names and better chat placeholder output.
Added
- Added a
nameoption for Discord message templates whenplayer-webhookis enabled. - Webhook names can now use placeholders, or stay empty to keep using the Minecraft username.
Fixed
- Fixed Discord chat relay formatting so player prefix and suffix placeholders are handled correctly.
- Channel-specific prefix and suffix values remain available through the SIR channel placeholders.
Notes
- No configuration reset is required.
- Restart your server after updating.
- If you use Discord webhooks, review the new
nameoption in the Discord config.
2.4.3Релиз26.1, 26.1.1, 26.1.2 · 27 июня 2026 г.
Scoreboard Timing Key Support
Small scoreboard compatibility update focused on clearer animation timing keys.
Fixed
- Scoreboard title and line animations now support the
interval-tickskey. - Existing
intervalandupdate-tickskeys are still accepted, so older configs continue to work. - Updated the default scoreboard profile examples to use
interval-ticksfor clearer timing setup.
Notes
- No configuration reset is required.
- Restart your server after updating.
- You can keep old scoreboard timing keys, but
interval-ticksis now the recommended key for new configs.
2.4.2Релиз26.1, 26.1.1, 26.1.2 · 20 июня 2026 г.
Channels Startup Compatibility
Compatibility hotfix for Channels on servers that use other chat-formatting plugins.
Fixed
- Fixed channel formatting and routing not reliably taking effect after startup when another chat plugin registers at the same listener priority.
- Channels now refreshes its chat handling after server startup to keep the expected processing order.
Notes
- No configuration changes are required.
- Restart your server after updating.
2.4.1Релиз26.1, 26.1.1, 26.1.2 · 17 июня 2026 г.
Channels Relay & Scoreboard Deployment Fix
Small update focused on Channels controls and making sure the new Scoreboard module is included in published builds.
Recommended: Restart your server after updating.
Added
- Added per-channel Discord relay control with
relay-to-discord. - Added per-channel MiniMessage control for player messages.
- Added default Channels examples for the new relay and MiniMessage options.
Changed
- Updated Channels migration/export handling so the new relay and MiniMessage settings are preserved.
Fixed
- Fixed the Scoreboard module missing from published module deployment.
- Improved blank-message checks for messages that only contain formatting tags.
Notes / Recommendations
- No full configuration reset is required.
- Existing channels will not automatically relay to Discord; enable
relay-to-discordonly on channels you want to send to Discord. - Keep
relay-to-discorddisabled for staff or private channels unless you explicitly want them relayed. - Review the latest
channels.ymlexample if you want to use MiniMessage in player chat.
2.4.0Релиз26.1, 26.1.1, 26.1.2 · 16 июня 2026 г.
Scoreboard Module & Chat Stability Update
Major update focused on the new Scoreboard module, safer optional integrations, and chat-processing stability.
Recommended: Back up your SIR folder and restart your server after updating.
Added
- Added the new Scoreboard module with configurable sidebar profiles.
- Added support for animated scoreboard titles and lines.
- Added scoreboard profile conditions by permission and world.
- Added
/scoreboardcommands fortoggle,reload,refresh, anddebug. - Added default Scoreboard config, profiles, command, and language files.
Changed
- Improved chat handling so Moderation, Cooldowns, Vanish chat checks, and config-editor chat input use the same processing flow.
- Refreshed the startup report output.
- Updated the default SIR prefix styling.
Fixed
- Fixed optional login, vanish, mute-status, and Discord integrations being too fragile when a backend plugin is missing, disabled, outdated, or using a different API.
- Fixed chat checks being skipped in newer chat-processing paths.
- Fixed latest startup diagnostics not refreshing cleanly in
logs/latest. - Fixed Discord backend handling for supported DiscordSRV and EssentialsDiscord setups.
Notes / Recommendations
- This release includes the unpublished
2.3.10changes. - No full configuration reset is required.
- If you do not want the new sidebar, disable the Scoreboard module after updating.
- Review the generated Scoreboard config and profiles before using it on a live server.
2.3.9Релиз26.1, 26.1.1, 26.1.2 · 12 июня 2026 г.
Chat Suggestions & Module Config Hotfix
Small hotfix focused on chat suggestions, invalid command messages, and module config menu detection.
Recommended: Restart your server after updating.
Changed
- Chat completion failures now log a clearer warning for easier troubleshooting.
Fixed
- Fixed mention/chat suggestions not refreshing correctly for online players after someone joins or leaves.
- Fixed invalid command arguments not using the configured command message.
- Fixed the modules menu detecting config editors from the wrong bundled resource, which could show config actions when a module did not actually have its own
config.yml.
Notes / Recommendations
- No configuration changes are required.
2.3.8Релиз26.1, 26.1.1, 26.1.2 · 11 июня 2026 г.
Chat Suggestions & Channel Color Update
Small update focused on chat suggestions for emojis and mentions, plus better channel color placeholders.
Recommended: Restart your server after updating.
Added
- Added chat tab-completion support for configured emoji keys.
- Added chat tab-completion support for mentions, suggesting visible and non-ignored online players.
- Added
{chat-color},{color-start}, and{color-end}placeholders for Channels formats.
Changed
{color}can now fall back to the sender's chat color when no channel default color is set.- Updated the default Channels comments to document the new chat color placeholders.
Fixed
- Fixed emoji replacements not fully respecting configured permission groups.
Notes / Recommendations
- No full configuration reset is required.
- Chat suggestions require server support for custom chat completions; older servers will keep normal chat behavior.
- Regex-based emoji rules still work, but they are not added as chat suggestions.
- Review the latest
channels.ymlexample if you want to use the new color placeholders.
2.3.7Релиз26.1, 26.1.1, 26.1.2 · 11 июня 2026 г.
Chat and Moderation Fixes
Update focused on safer chat handling, better Channels permissions, and expanded Swearing filter support.
Added
- Added support for remote JSON word lists in the Swearing filter using the new
[json]source format. - Updated the default
swearing.ymlcomments with an example for JSON word lists.
Fixed
- Fixed Channels recipient permissions so send permissions do not accidentally restrict who can receive global-style messages.
- Fixed color-only or formatting-only channel messages being treated as valid messages.
- Fixed Announcement task handling when no announcements are configured.
- Fixed MOTD ping handling when MOTD entries or icons are missing.
- Fixed Mentions replacement to handle multiple mentions more safely.
Notes / Recommendations
- Restart your server after updating.
- No full configuration reset is required.
- If you use custom Channels configs, review audience permission settings after updating.
- If you use remote Swearing word lists, the source must be a reachable HTTP/HTTPS JSON array of strings.
Комментарии
Загружаем…