KGSM-Bot

KGSM-Bot is a Discord bot designed to interact with KGSM, providing an intuitive interface to manage and control game servers directly from Discord.

Features

• Server management: Install, start, stop, uninstall game servers through Discord commands.
• Live notifications: Realtime notifications for game server startup and shutdown.

Getting started

KGSM-Bot was designed to work on GNU/Linux systems. There is no compatibility with Windows, try at your own risk.

Prerequisites

• Discord Bot Token: Create a bot via the Discord Developer Portal
• KGSM, version 1.6+

Configuration

Copy the contents of appsettings.example.json into a new file, appsettings.json and fill in the configuration.

{
    "Discord": {
        "Token": "YOUR_DISCORD_TOKEN_HERE_DO_NOT_SHARE",
        ...
    },
    "KGSM": {
        "Path": "path/to/kgsm.sh",
        "SocketPath": "path/to/kgsm.sock"
    }
}

Installation

1. Clone the repository:

git clone https://github.com/TheKrystalShip/KGSM-Bot.git

2. Navigate to the project directory

cd KGSM-Bot

3. Install dependencies

dotnet restore

4. Build the project

dotnet run

Usage

Run the bot using:

dotnet run

Invite the bot to your Discord server an use commands, such as:

• /install [blueprint]
• /start [instance]
• /status [instance]
• /uninstall [instance]

Contributing

Contributions are welcome! Plase open an issue or submit a pull request.

License

This project is licensed under the MIT license. See the LICENSE file for details.

Acknowledgements

• Discord.Net for the Discord API wrapper.
• KGSM fot the game server management.