Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure commands into single slash command with subcommands #9

Merged
merged 1 commit into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,35 @@ This repository represents a Discord Bot application for managing dedicated game

## Features

- Displays list of configured servers using `/servers` command
- Displays list of configured servers

![list](https://raw.githubusercontent.com/cruikshj/server-manager-discord-bot/main/assets/servers-list.png)

- Displays detailed server information using `/servers <name>` command
- Displays detailed server information

![info](https://raw.githubusercontent.com/cruikshj/server-manager-discord-bot/main/assets/servers-info.png)

- Provides server readme through using interactions
- Provides server files (such as backups, saves and mod files) using interactions
- Provides server readme
- Provides server files (such as backups, saves and mod files)
- Provides a per server gallery for screenshots and other images
- Process, DockerCompose, and Kubernetes integrations
- Show server status
- Start/Stop/Restart servers using interactions
- Provides server logs using interactions
- Start/Stop/Restart servers
- Provides server logs

## Commands

- `/sm list`
- `/sm info`
- `/sm status`
- `/sm start`
- `/sm restart`
- `/sm stop`
- `/sm logs`
- `/sm files`
- `/sm readme`
- `/sm gallery`
- `/sm gallery-upload`

## Setup

Expand Down Expand Up @@ -56,6 +71,7 @@ Each example will show how to host the bot application itself as well as integra
| BotToken | (Required) The Discord Bot token. | |
| GuildIds | An array of Discord guild (server) IDs. This can be used for testing or security purposes to limit which Discord servers the bot application will communicate with. | |
| HostUri | The bot application host URI. Only used if `LargeFileDownloadHandler.BuiltIn` is used. | https://localhost:5000 |
| SlashCommandPrefix | The command group or prefix to use for the bot. | sm |
| EnableFileDownloadHandler | This is a global setting for whether to enable the file downloads feature. Configured servers must still opt-in by providing a `FilesPath` value. | true |
| LargeFileDownloadHandler | Enable file downloads larger than 25MB. See [Handling Large File Downloads](#handlinglargefiledownloads). | Disabled |
| EnableGallery | Enable server gallery. | true |
Expand Down
2 changes: 2 additions & 0 deletions src/ServerManagerDiscordBot/AppSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ public class AppSettings

public Uri? HostUri { get; set; }

public string SlashCommandPrefix { get; set; } = "sm";

public bool EnableFileDownloads { get; set; } = true;

public LargeFileDownloadHandlerType LargeFileDownloadHandler { get; set; } = LargeFileDownloadHandlerType.Disabled;
Expand Down
Loading
Loading