From 9cab284d2430cef1f377ca1dfe91a3d90116066d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Henrique=20Ivanchechen?= Date: Wed, 15 Feb 2023 23:31:01 -0300 Subject: [PATCH] readme and things --- .dockerignore | 1 + README.md | 22 ++++++++++++++++++++++ docker-compose.yml | 9 +++++++++ 3 files changed, 32 insertions(+) create mode 100644 .dockerignore create mode 100644 README.md create mode 100644 docker-compose.yml diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..cd0a7f1 --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +legacy/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2234a0c --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# KasBot +#### Inspired by a Brazilian DJ + +## Running +If using Docker, just put a token on the `docker-compose.yml` file and run it using `docker-compose up -d`. + +If deploying it by hand, you can run: +```shell +dotnet build -c Release -o bin +dotnet bin/Kasbot.dll +``` + +## Commands +| Command | Description +| -- | -- | +| `!play ` | Plays a song from YouTube | +| `!skip` | Skips the current song | +| `!stop` | Stops the current song and clears the queue | +| `!leave` | Leaves the current voice channel and clears the queue | +| `!cat` | Sends a random cat pic into the channel :3 | + +You can change the command prefix by putting another symbol in `COMMAND_PREFIX` environment variable. \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..fb13786 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,9 @@ +version: "2.1" +services: + kasbot: + image: ivanch/kasbot:latest + container_name: kasbot + environment: + - TOKEN= + - COMMAND_PREFIX=! + restart: unless-stopped \ No newline at end of file