toastie-stuff/SupportChild
2
0
Fork 0
Code Issues Pull requests Projects Releases7 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Toastie 2025-02-04 20:44:37 +13:00
parent 491293947d
commit ace7d04a5d
Signed by: toastie_t0ast
GPG key ID: 0861BE54AD481DC7
1 changed files with 28 additions and 2 deletions

30
README.md
View file

@ -1,3 +1,29 @@
[![Build Status](https://ci.toastielab.dev/buildStatus/icon?job=Toastie-stuff%2FSupportChild%2Fmain)](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)