OctobotStealth/docs/README.md

<p align="center">
    <img src="octobot-banner.png" alt="Octobot banner"/>
</p>

<a href="https://git.mctaylors.ru/TeamInklings/OctobotStealth/src/branch/stealth/LICENSE"><img src="https://img.shields.io/github/license/TeamOctolings/Octobot?logo=git"></img></a>
<a href="https://github.com/Remora/Remora.Discord"><img src="https://img.shields.io/badge/powered_by-Remora.Discord-blue"></img></a>
<a href="https://git.mctaylors.ru/TeamInklings/OctobotStealth/commits"><img src="https://img.shields.io/gitea/last-commit/TeamInklings/OctobotStealth/stealth?gitea_url=http%3A%2F%2Fgit.mctaylors.ru&logo=forgejo&logoColor=aaa"></img></a>

Veemo! I'm a multiple-purpose bot (formerly known as Boyfriend) written by [Team Octolings](https://github.com/TeamOctolings) and [Team Inklings](https://git.mctaylors.ru/TeamInklings) in C# and Remora.Discord

> **Note** **[TeamOctolings/Octobot](https://github.com/TeamOctolings/Octobot) is still being maintained.** You probably won't need to use this fork.

## Features

* Banning, muting, kicking, etc.
* Reminding you about something if you wish
* Reminding everyone about that new event you made
* Renaming those annoying self-hoisting members
* Log everything from joining the server to deleting messages
* Listen to music!

*...a-a-and more!*

## Building Octobot Stealth

1. Install [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
2. Go to the [Discord Developer Portal](https://discord.com/developers), create a new application and get a bot token. Don't forget to also enable all intents!
3. Clone this repository and open `OctobotStealth` folder.
```
git clone https://github.com/TeamInklings/OctobotStealth
cd Octobot
```
4. Run Octobot Stealth using `dotnet` with `BOT_TOKEN` variable.
```
dotnet run BOT_TOKEN='ENTER_TOKEN_HERE'
```

#
<sup>Not an official Splatoon™ product. We are in no way affiliated with or endorsed by Nintendo Company, or other rightsholders.</sup>