notify-on-start/README.md

# notify-on-start
*(maki, 4/20/25)*
this is a personal project, there are DEFINITELY better alternatives; this plugin is mostly server-exclusive.
it was made to notify a discord server whenever a event occurred in a minecraft server. 

# Prerequisites
Before using this plugin, you must:
* Get Spigot
* Get a JAR file from [the releases](https://git.sob.moe/sobrooms/notify-on-start/-/releases) or [Google Drive](https://drive.google.com/drive/folders/11wMPjOh2b8oRzpeJOrOI4ZAkImOlr93u?usp=sharing) (the drive folder is frequently updated)

# Webhook creation
If you already know how to make a webhook, disregard this section of the readme.

To make a webhook:
1. Go to your Discord server.
2. Edit a channel.
3. Go to "Integrations" and then "Webhooks"
4. Click "New Webhook"
5. Give the webhook a name. As an example, we will use `notify` as the webhook name.
6. You may change the channel where it is associated/linked to, change the webhook name, and set a picture for the webhook.
7. Copy the webhook link.

# Usage
To use this plugin, simply obtain a release and place the binary on the `plugins` folder of your Spigot/Paper/Bukkit server.

On the first run, it will make a folder in the server's directory, containing the plugin's configuration file named `config_webhook.json`

The configuration file should have two fields with the value `default-ns`. Paste the webhook links in the space following the key name (such as `url_notify`),
or over the `default-ns` text. The configuration should look like this afterward:


```json
{
    "url_notify": "https://discord.com/webhooks/webhook_for_notifications",
    "url_publicmsg": "https://discord.com/webhooks/webhook_for_player_broadcasts"
}
```