From ace7d04a5db3c5a7e43a16605500d2626271d348 Mon Sep 17 00:00:00 2001 From: Toastie <toastie@toastiet0ast.com> Date: Tue, 4 Feb 2025 20:44:37 +1300 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7e144ca..7354736 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -[](https://ci.toastielab.dev/job/Toastie-stuff/job/SupportChild/job/main/) - # SupportChild + +A support ticket Discord bot. Uses a MySQL database for storage of ticket information. Creates formatted HTML ticket transcripts when tickets are closed. + +#### Thanks to [Tyrrrz](https://github.com/Tyrrrz/DiscordChatExporter) for the amazing library used in the transcript function. + +## Setup + +1. Set up a mysql-compatible server, create a user and empty database for the bot to use. + +2. (Optional) Install .NET 8 if it doesn't already exist on your system. + +3. Create a new bot application and invite it to your server. + +4. Download the bot for your operating system, either a [release version](https://toastielab.dev/toastie-stuff/SupportChild/releases). Get the normal version if you have installed .NET 8 on your system, get the self contained version otherwise. + +5. Run `./SupportChild_Linux` on Linux or `./SupportChild_Windows.exe` on Windows, this creates a config file in the current directory. + +6. Set up the config, there are instructions inside. If you need more help either contact me in Discord or through an issue here. + +7. Restart the bot. + +8. Go to `Settings->Integrations->Bot->Command Permissions` in your Discord server to set up permissions for the commands. + +## Documentation + +- [Commands](./docs/Commands.md) +- [Interview templates](./docs/InterviewTemplates.md) +- [Default config](./default_config.yml) \ No newline at end of file