rrryfoo/notify-on-start
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

1.2.0: Remove unnecessary events, use yml as a config

Browse Source
This commit is contained in:
Maki
2025-10-15 21:12:07 +08:00
parent 6b463cf5b3
commit eabb5a69c1
30 changed files with 326 additions and 659 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -43
View File
@@ -1,59 +1,37 @@
# notify-on-start
this project is made to just send messages to Discord webhooks when events trigger
this was just made to remember whatever goofy things we did in a minecraft server, in discord
or, you know, notify us when the server starts and ends (and other things...)
*(maki, 4/20/25)*
this is a personal project, there are DEFINITELY better alternatives; this plugin is mostly server-exclusive
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)
# making webhooks
If you already know how, you can skip this step.
# Webhook creation
If you already know how to make a webhook, disregard this section of the readme.
To make a webhook:
1. Go to a Discord server.\
You can make a new channel or use an existing one.
2. Right-click on the channel.
3. Click "Edit Channel".
4. Click "Integrations" and click "Webhooks".
5. Click "New Webhook".
6. Give the webhook a name. As an example, we will use `notify` as the webhook name.
7. You may change the channel where it is associated/linked to, change the webhook name, and set a picture for the webhook.
8. Copy the webhook link.
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.
# using this thing
Of course, you must get a release first, as said in the prerequisites. After you get a jar, put it in the `plugins` folder
On the first run, it will make a folder in the server's directory, containing the plugin's configuration file named `config_webhook.json`
On first run, it will make a directory in the server's base directory.\
In it, there will be one important file:\
This file will be `NoS/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:
Of course, put the webhook URL of where the events should be logged in the `url_notify` field.
The `url_publicmsg` field is for a command named `/send-message`. This will simply send text to the webhook containing provided text.\
Put the webhook link in it.
An example of what the file's content should be:
```json
{
"url_notify": "<get the webhook link from earlier and paste>",
"url_publicmsg": "<same as earlier>"
"url_notify": "https://discord.com/webhooks/webhook_for_notifications",
"url_publicmsg": "https://discord.com/webhooks/webhook_for_player_broadcasts"
}
```
If you change this value, you have to restart the server to apply changes.
By default, its value is:
```json
{
"url_notify": "default-ns",
"url_publicmsg": "default-ns"
}
```
```