Herald is a Minecraft server plugin that sends Discord webhook notifications when players join the server. Email notifications are also supported as a secondary option.
- Download the Herald plugin JAR file.
- Place the JAR in the
pluginsfolder of your server. - Restart your server.
- Edit the generated
plugins/Herald/config.ymlto configure notification settings.
Herald can send notifications through Discord webhooks, SMTP email, or both. See the Configuration Guide for setup details.
- User Guide – Getting started and common scenarios
- Commands Reference – Complete list of all commands
- Configuration Guide – Detailed configuration options
- Discord Testing – Testing Discord webhooks without a server
- Changelog – Release-by-release summary of changes
You can find the support Discord server here.
Please fill out a bug report here.
Linux:
./gradlew clean test
Windows:
.\gradlew.bat clean test
If you see BUILD SUCCESSFUL, the tests have passed.
A Docker-based test server is available for development.
- Copy
sample.envto.envand configure as needed. - Build the plugin:
./gradlew build - Start the test server:
./up.sh
./reload-plugin.sh
./down.sh
| Name | Main Contributions |
|---|---|
| Daniel McCoy Stephenson | Creator and lead developer |
This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
You are free to use, modify, and distribute this software, provided that:
- Source code is made available under the same license when distributed.
- Changes are documented and attributed.
- No additional restrictions are applied.
See the LICENSE file for the full text of the GPL-3.0 license.
This project is in active development.