Octobot/docs/README.md

Veemo! I'm a general-purpose bot for moderation (formerly known as Boyfriend) written by Labs Development Team in C# and Remora.Discord

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 & running

Instructions for Linux

1. Install .NET 7 SDK
2. Go to the Discord Developer Portal, create a new application and get a bot token. Don't forget to also enable all intents!
3. Open Terminal
4. Clone this repository and open Octobot folder.

git clone https://github.com/LabsDevelopment/Octobot
cd Octobot

5. Build Octobot using dotnet and open bin\Debug\net7.0 folder.

dotnet build
cd bin\Debug\net7.0

6. Create a BOT_TOKEN environment variable with a bot token from Discord Developer Portal and run Octobot.

export BOT_TOKEN='ENTER_TOKEN_HERE'
./Octobot

Instructions for Windows

1. Install .NET 7 SDK
2. Go to the Discord Developer Portal, create a new application and get a bot token. Don't forget to also enable all intents!
3. Open PowerShell
4. Clone this repository and open Octobot folder.

git clone https://github.com/LabsDevelopment/Octobot
cd Octobot

5. Build Octobot using dotnet and open bin/Debug/net7.0 folder.

dotnet build
cd bin/Debug/net7.0

6. Create a BOT_TOKEN environment variable with a bot token from Discord Developer Portal and run Octobot.

$ENV:BOT_TOKEN='ENTER_TOKEN_HERE'
.\Octobot.exe

Contributing

When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. Please refer to the contributing guidelines to understand how to help in the most effective way possible.

Special Thanks

JetBrains, creators of ReSharper and Rider, supports Octobot with one of their Open Source Licenses. Rider is the recommended IDE when working with Octobot, and everyone on the Octobot team uses it. Additionally, ReSharper command-line tools made by JetBrains are used for status checks on pull requests to ensure code quality even when not using ReSharper or Rider.

^{Not an official Splatoon™ product. We are in no way affiliated with or endorsed by Nintendo Company, or other rightsholders.}