Skip to content
This repository was archived by the owner on May 6, 2023. It is now read-only.

Commit 2cd4228

Browse files
authored
Update README.md
1 parent e976bdb commit 2cd4228

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# SCPDiscord
22

3-
Currently prints a few different events to a specific Discord channel. I was going to wait until SCP:SL updates to .NET 4.6 but apperently that has been delayed. This means I can't use a discord api directly from the plugin and thus have to seperate it into two different programs.
3+
Ever wished to interact with your SCP:SL server without having to open your ssh client? Now you can, this plugin will let you execute commands remotely from discord, sync information such as how many players are online, send messages from the server with info such as teamkilling, players joining and log admin actions.
44

5-
## Upcoming features:
5+
It will also be possible to sync ranks from discord to the game, letting you automate things like patreon rewards and moderator positions.
66

7-
It's main functionality will be to add functinality to print events such as teamkilling, round restarts and staff actions to a discord channel for an easily accessible log. Some of this is already implemented.
7+
I was going to wait with making this plugin until SCP:SL updates to .NET 4.6 from the curent .NET 3.5 but apperently that has been delayed (indefinitely?). This means I can't use a C# Discord API directly from the plugin and thus have to seperate it into two different programs.
88

9-
If possible I might also add functionality to print the console to a discord channel and also forward commands from discord to the in-game console.
9+
## Current features:
1010

11-
It will also be able to sync roles from discord to the game which will for instance enable automatic adding of server patrons.
11+
You can log any event from the server to discord with multi-channel support.
12+
13+
You can for instance have one public channel for each of your servers where things like player joins, kills round starts and round ends are posted. You could then add one channel for each server visible only to moderators, showing things like admin actions and logging who attacks who on each server to check for teamkillers.
14+
15+
## Bot commands
16+
17+
`setavatar <url>/<path>` Either a path or url to an image to set as your bot's avatar.
1218

1319
## Installation:
1420

@@ -122,3 +128,7 @@ discord_channel_onsetrolemaxhp: off
122128
discord_channel_onteamrespawn: default
123129
discord_channel_onsetscpconfig: off
124130
```
131+
132+
You can find descriptions for each event here: https://github.com/Grover-c13/Smod2/tree/master/Smod2/Smod2/EventSystem/EventHandlers
133+
134+
All events are listed inside of these files.

0 commit comments

Comments
 (0)