Skip to content

Commit 835f2a1

Browse files
author
Kim
committed
Update README.md
1 parent 1d6fe43 commit 835f2a1

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

+38-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# SimplePushEvents Plugin
22

33
## Description
4-
This Spigot plugin, for use with the latest Minecraft version, automatically sends notifications to a push service (ntfy.sh), when players join or leave the server, as well as when the server starts up or shuts down. It helps server administrators and players stay informed about server activities in real-time.
4+
This Spigot plugin, for use with the latest Minecraft version, automatically sends notifications to a push service (ntfy.sh), when players join, leave, execute specific commands or the server starts/shuts down.
5+
It helps server you and your players to stay informed about server activities in real-time.
56

67

78
## Ideas
@@ -17,6 +18,14 @@ Compatible with Minecraft 1.20.6 and requires Java 21.
1718
- Configurable message content and status for each event.
1819
- Easy integration with the ntfy.sh push service.
1920
- Quick setup with minimal configuration required.
21+
- Checks and notifies for specific player commands:
22+
- `op`
23+
- `deop`
24+
- `ban`
25+
- `banip`
26+
- `pardon`
27+
- `pardonip`
28+
- `whitelist`
2029

2130

2231
## Setup
@@ -42,24 +51,45 @@ Before deploying the plugin, ensure you configure the following parameters in th
4251
```yaml
4352
donottouch:
4453
configexists: true
45-
pushchannel: generated-unique-channel-id
46-
54+
pushchannel: 1c228642f083
4755
messages:
4856
general:
49-
title: "Minecraft Server:"
57+
title: 'Minecraft Server:'
5058
startup:
5159
status: true
52-
content: "The server is online now!"
60+
content: The server is online now!
5361
poweroff:
5462
status: true
55-
content: "The server is shutting down!"
63+
content: The server is shutting down!
5664
player:
65+
command:
66+
op:
67+
status: true
68+
content: The player %PLAYER% executed /op for %TARGET% !
69+
deop:
70+
status: true
71+
content: The player %PLAYER% executed /deop for %TARGET% !
72+
ban:
73+
status: true
74+
content: The player %PLAYER% executed /ban for %TARGET% !
75+
banip:
76+
status: true
77+
content: The player %PLAYER% executed /ban-ip for %TARGET% !
78+
pardon:
79+
status: true
80+
content: The player %PLAYER% executed /pardon for %TARGET% !
81+
pardonip:
82+
status: true
83+
content: The player %PLAYER% executed /pardon-ip for %TARGET% !
84+
whitelist:
85+
status: true
86+
content: 'The player %PLAYER% used a whitelist command: %CONTENT%'
5787
join:
5888
status: true
59-
content: "The player %PLAYER% joined!"
89+
content: The player %PLAYER% joined!
6090
leave:
6191
status: true
62-
content: "The player %PLAYER% left!"
92+
content: The player %PLAYER% left!
6393
```
6494
6595

0 commit comments

Comments
 (0)