mangorifo
58 lines
2.0 KiB
Markdown
58 lines
2.0 KiB
Markdown
# 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 (notifies when you use the /stop command)
|
|
|
|
# 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.
|
|
|
|
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.
|
|
|
|
|
|
# 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 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`.
|
|
|
|
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>"
|
|
}
|
|
```
|
|
|
|
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"
|
|
}
|
|
```
|