WelcomeMat

A friendly way to roll out the welcome mat for your players!

📥 Download

WelcomeMat is available on Modrinth! Click the button below to download:

🔄 Compatibility

WelcomeMat is compatible with Minecraft versions 1.13 through 1.21.10 and is fully tested on Bukkit/Spigot, Paper, Purpur, and Folia (regionized multithreading). The Folia build uses region-aware schedulers so the same jar runs safely on both single-threaded and regionized servers.

🚀 What's New in v1.3.3

• Animation test polish: /wm animation test <name|random> now cycles through every registered animation, making it easier to preview the expanded effect roster on live servers.
• Confetti Burst fix: Folia servers no longer spam missing required data class org.bukkit.Color—the Confetti Burst animation now supplies proper dust color transitions and sparkles.
• Safe config migrations: config.yml and messages.yml automatically back up and merge new defaults, so upgrading from older releases preserves customizations without YAML errors.

✨ Features

Core Features

Feature	Description	Status
Message Packs	Multiple themed welcome messages	✅ Implemented
Welcome Titles	Customizable titles and subtitles	✅ Implemented
Interactive Sounds	Configurable join/leave sounds	✅ Implemented
Join Effects	Beautiful particle effects	✅ Implemented
Language Support	Multiple language options	✅ Implemented
User-Friendly GUI	Easy settings management	✅ Implemented

New in v1.3.0: Skyward (Happy Ghast) and Copper Age message packs themed after the 1.21.10 content updates.

Player Experience

Feature	Description	Status
Custom Message Delays	Set timing for welcome messages	✅ Implemented
Player-specific Messages	Personalized greetings based on player history	✅ Implemented
Message Randomization	Random selection from message pool	✅ Implemented
First Join Special Events	Unique celebrations for first-time players	✅ Implemented
Multi-world Support	Different settings per world	🚧 Planned

Administration

Feature	Description	Status
Message Templates	Pre-made message templates	✅ Implemented
Permissions System	Granular permission control	✅ Implemented
Message Scheduling	Time-based welcome messages	✅ Implemented
Statistics Tracking	Track player join/leave patterns	🚧 Planned

Quality of Life

Feature	Description	Status
Command Shortcuts	Quick commands for common actions	✅ Implemented
Message Preview	Preview messages before saving	✅ Implemented
Import/Export	Share configurations between servers	🚧 Planned
Auto-updates	Automatic plugin updates	🚧 Planned
Performance Optimization	Improved resource usage	✅ Implemented

🕹 Command Reference

Command	Permission	Description
/welcomemat or /wm	(default)	Shows the interactive help panel with quick-click shortcuts.
/wm gui	welcomemat.config	Opens the in-game Settings GUI for packs, languages, sound profiles, and effects.
/wm sound	welcomemat.sound.toggle	Toggles join/leave sounds for the executing player.
/wm effects	welcomemat.effects	Enables or disables join effects for the executing player.
/wm animation	welcomemat.animation	Opens the animation status view; supports list, `set <id
/wm pack	welcomemat.pack	Selects a message pack, switches pack modes, or creates new packs with /wm pack create <Friendly Name>.
/wm splash <title|subtitle> [edit]	welcomemat.config	Views or edits the welcome title/subtitle using clickable chat controls.
/wm language <english|spanish>	welcomemat.language	Switches the active language bundle.
/wm config <get|set|list>	welcomemat.config	Reads or writes any config path. Sound paths preview audio instantly for players.
/wm reload	welcomemat.reload	Reloads config.yml, messages.yml, and re-runs the migration helper.

Command Examples

# Preview the latest particle work without relogging
/wm animation test random

# Force the Copper Age message pack while keeping custom splash text
/wm pack copper_age
/wm pack mode splash custom

# Update the default join sound and immediately preview it
/wm config set sounds.join.sound ENTITY_PLAYER_LEVELUP
/wm config set sounds.join.pitch 1.3

📚 Documentation

For full documentation, examples, and setup instructions, please visit our Modrinth page.

🤝 Contributing

Contributions are welcome! Feel free to:

1. Report bugs
2. Suggest new features
3. Submit pull requests

📝 Support

Need help? Have suggestions?

• Create an issue
• Join our Discord server

📜 License

WelcomeMat is licensed under the MIT License.

---

Made with ❤️ & ☕ by angeldev0