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

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, obtain a release and place the binary on the plugins folder of your Spigot/Paper/Bukkit server.

Once the plugin is used for the first time, it will make a YAML configuration file in the plugin's directory named notifyOnStart.
It should look like this:

server:
    name: Minecraft Server
    entry_message: Welcome to @servername, @playername!
    webhooks:
        notify: default-ns
        broadcast: default-ns
log: true
firstrun: 0

You can also make a configuration file without starting the server up; copy the config above, make the plugin directory yourself, make a file named config.yml, and paste the text into it. You can then change the settings, as long as the firstrun field exists.

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 notify), or over the default-ns text. The configuration should look like this afterwards:

server:
    name: Minecraft Server
    entry_message: Welcome to @servername, @playername!
    webhooks:
        notify: https://discord.com/webhooks/webhook_for_notifications
        broadcast: ttps://discord.com/webhooks/webhook_for_player_broadcasts
log: true
firstrun: 0

You may use two variables in the entry message field, namely @servername and @playername. If you do not want an entry message to be sent, leave the field blank.