This version of Spartan Webhooks is a complete rewrite mainly in the Kotlin language for ease for programming. Modifying the plugin to work on different platforms and versions is okay, but will never take place on this project.
Spartan Integration
SpartanWebhooks, or the main idea behind webhook support in Spartan thanks to the popular demand for this plugin to have greater compatibility and ease of use, has been directly implemented into the Spartan plugin. As of July 27th, 2022, all releases have been deleted, and no further work will be done on this project. Thank you to everyone who has helped to make this project a success! You helped show how wanted of a feature webhooks were to the point that they were implemented directly into Spartan!
Features
- JSON based embed configuration
- Embed builders can now be used for configuration! (Be careful to maintain the object-array structure!)
- Supports non-embed messages too!
- Embed sending now respects Discord's limits
- Should now no longer trigger rate limiting errors (429s)
- Embeds will be collapsed to one message, allowing more to be sent without triggering 429s!
- More configuration options & cleaner configuration
- Configuration is now done through a TOML file
- Placeholders managed by PlaceholderAPI
- Easier to use and more flexible placeholders that can also be utilized in other plugins
- And many, many more to come!
Limitations
- Only supports the latest Minecraft version (1.18.2)
- Download in release is built with Java 17, and as such is not compatible with all versions of Java
- Only supports Paper, not Spigot servers
- Requires PlaceholderAPI
- Content section is sent once per grouping of embeds; placeholders not supported for this field
Installation
- Download the file
SpartanWebhooks-2.0-release.jar
and place it in yourplugins
folder. - Ensure you have the
Spartan
andPlaceholderAPI
plugin downloaded - Configure the
url
field in theplugins/SpartanWebhooks/settings.toml
file - Run
/webhooks reload
- You're good to go! Edit the
plugins/SpartanWebhooks/webhook.json
file to your heart's content!
Creating a Discord Webhook
If for some strange reason you wish to use this plugin, but have no idea what a Discord Webhook is, how to create
one, or how to get its URL which will be necessary to make this plugin work, you can check out Discord's own
tutorial here. Please note that
appending /github
to the end of the URL is ONLY for webhooks coming from GitHub, and is not necessary
for this plugin and will actually break it.
Build Instructions
- Clone the repository
- Use the command
gradlew clean build
to build - The outputted JAR will be in the
{projectRoot}/build/libs
folder by default