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

update readme according to what's changed

Browse Source
This commit is contained in:
Maki
2025-11-25 18:26:07 +03:00
parent d5ea4135ac
commit 6635b7aff4
1 changed files with 57 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+57 -37
View File
@@ -1,37 +1,57 @@
# notify-on-start # notify-on-start
*(maki, 4/20/25)* *(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. it was made to notify a discord server whenever a event occurred in a minecraft server.
# Prerequisites # Prerequisites
Before using this plugin, you must: Before using this plugin, you must:
* Get Spigot * 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) * Get a JAR file from [the releases](https://rrryfoo.sob.moe/rrryfoo/notify-on-start/-/releases) or [Google Drive](https://drive.google.com/drive/folders/11wMPjOh2b8oRzpeJOrOI4ZAkImOlr93u?usp=sharing) (the drive folder is frequently updated)
# Webhook creation # Webhook creation
If you already know how to make a webhook, disregard this section of the readme. If you already know how to make a webhook, disregard this section of the readme.
To make a webhook: To make a webhook:
1. Go to your Discord server. 1. Go to your Discord server.
2. Edit a channel. 2. Edit a channel.
3. Go to "Integrations" and then "Webhooks" 3. Go to "Integrations" and then "Webhooks"
4. Click "New Webhook" 4. Click "New Webhook"
5. Give the webhook a name. As an example, we will use `notify` as the webhook name. 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. 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. 7. Copy the webhook link.
# Usage # Usage
To use this plugin, simply obtain a release and place the binary on the `plugins` folder of your Spigot/Paper/Bukkit server. To use this plugin, 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` 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:
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: ```yml
server:
name: Minecraft Server
```json entry_message: Welcome to @servername, @playername!
{ webhooks:
"url_notify": "https://discord.com/webhooks/webhook_for_notifications", notify: default-ns
"url_publicmsg": "https://discord.com/webhooks/webhook_for_player_broadcasts" broadcast: defeault-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 afterward:
```yml
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.