From bc0a0ba9388023e57ac3920558fb5c20795de61a Mon Sep 17 00:00:00 2001 From: chamik Date: Wed, 13 Nov 2024 12:34:10 +0100 Subject: [PATCH] Updated documentation --- Install.md | 25 ++++++++++++++++---- thorn/Config/feeds.example.json | 41 ++++++++++++++++++++++++++------- 2 files changed, 53 insertions(+), 13 deletions(-) diff --git a/Install.md b/Install.md index 75694cf..b0f72a5 100644 --- a/Install.md +++ b/Install.md @@ -1,12 +1,12 @@ # Install This Discord bot is made *very specifically* for the [Czech branch Discord chat](https://discord.gg/ZAdfEJ4); other than for testing purposes, -there is probably no need for you to try to run this bot, or even read this guide. Why am I writing this. +there is probably no need for you to run this bot, or even read this guide. Why am I writing this. ## Setup ### Dependencies -You have to have [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) SDK installed, and that's about it. +You have to have [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) SDK installed. ### Clone ```shell @@ -26,10 +26,25 @@ And you're all set! The output is in `thorn/bin/Release/net8.0/` `feeds.json` is for configuring the RSS fetching. If you don't wish to fetch any RSS feeds, just put `[]` (an ampty array) in the file. -There are examples in `config.example.json` and `feeds.example.json` respectively. +There are examples in `config.example.json` and `feeds.example.json` respectively. `daily.json` is not really meant to be edited, but you surely get the idea. -## Done +## Deploy +I use a simple systemd service. -Hooray! You made it. Now enjoy your very own Thorn. +```ini +[Unit] +Description=Thorn - the SCP-CS bot + +[Service] +Type=simple +Restart=always +WorkingDirectory=/home/thorn/Thorn/thorn/bin/Release/net8.0/ +ExecStart=/usr/bin/dotnet /home/thorn/Thorn/thorn/bin/Release/net8.0/thorn.dll + +[Install] +WantedBy=multi-user.target +``` + +Now enjoy your very own Thorn 🥳 If you need help, message me (you can find me on the SCP-CS discord server and [elsewhere](https://chamik.eu/contact/)). diff --git a/thorn/Config/feeds.example.json b/thorn/Config/feeds.example.json index 4f2dcc6..243df9e 100644 --- a/thorn/Config/feeds.example.json +++ b/thorn/Config/feeds.example.json @@ -1,17 +1,42 @@ [ - { + { "Link": "http://scp-cs.wikidot.com/feed/site-changes.xml", - "ChannelIds": [800776102236324294], - "Filter": ["new page"], + "ChannelIds": [537063810121334784], + "Filter": ["nová stránka"], "EmbedColor": 16711680, - "NewPageAnnouncement": true, - "RequireAuth": false + "NewPageAnnouncement": true }, + { "Link": "http://scp-cs.wikidot.com/feed/site-changes.xml", - "ChannelIds": [735012092329918297], + "ChannelIds": [710575651664429127], "EmbedColor": 16711680, - "NewPageAnnouncement": false, - "RequireAuth": false + "NewPageAnnouncement": false + }, + { + "Link": "http://o5command-cs.wikidot.com/feed/site-changes.xml", + "ChannelIds": [710575651664429127], + "EmbedColor": 1, + "NewPageAnnouncement": false + }, + { + "Link": "http://scp-cs-sandbox.wikidot.com/feed/site-changes.xml", + "ChannelIds": [710575651664429127], + "Filter": ["nová stránka"], + "EmbedColor": 3329330, + "NewPageAnnouncement": false + }, + { + "Link": "http://scp-cs-sandbox-2.wikidot.com/feed/site-changes.xml", + "ChannelIds": [710575651664429127], + "Filter": ["nová stránka"], + "EmbedColor": 3329330, + "NewPageAnnouncement": false + }, + { + "Link": "http://scp-cs.wikidot.com/feed/forum/threads.xml", + "ChannelIds": [710575651664429127], + "EmbedColor": 16645526, + "NewPageAnnouncement": false } ]