mirror of
https://github.com/TeamOctolings/Octobot.git
synced 2025-05-13 17:26:08 +03:00
92 lines
3.8 KiB
Markdown
92 lines
3.8 KiB
Markdown
<p align="center">
|
|
<img src="https://mctaylors.ddns.net/cdn/octobot-banner.png" alt="Octobot banner"/>
|
|
</p>
|
|
|
|
<a href="https://github.com/LabsDevelopment/Octobot/blob/master/LICENSE"><img src="https://img.shields.io/github/license/LabsDevelopment/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://github.com/LabsDevelopment/Octobot/deployments/production"><img src="https://img.shields.io/github/actions/workflow/status/LabsDevelopment/Octobot/.github/workflows/build-push.yml?logo=github&label=production"></img></a>
|
|
<a href="https://github.com/LabsDevelopment/Octobot/commit/master"><img src="https://img.shields.io/github/last-commit/LabsDevelopment/Octobot?logo=github"></img></a>
|
|
|
|
Veemo! I'm a general-purpose bot for moderation (formerly known as Boyfriend) written by [Labs Development Team](https://github.com/LabsDevelopment) 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!*
|
|
|
|
[//]: # (if you are reading this, message @mctaylors and ask him to bring back the wiki)
|
|
|
|
## Building & running
|
|
|
|
<details><summary>Instructions for Linux</summary>
|
|
<br/>
|
|
|
|
1. Install [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.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. 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
|
|
```
|
|
|
|
</details>
|
|
<details><summary>Instructions for Windows</summary>
|
|
<br/>
|
|
|
|
1. Install [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.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. 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
|
|
```
|
|
|
|
</details>
|
|
|
|
## 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](CONTRIBUTING.md) to understand how to help in
|
|
the most effective way possible.
|
|
|
|
## Special Thanks
|
|
|
|
|
|
|
|
[JetBrains](https://www.jetbrains.com/), creators of [ReSharper](https://www.jetbrains.com/resharper)
|
|
and [Rider](https://www.jetbrains.com/rider), supports Octobot with one of
|
|
their [Open Source Licenses](https://jb.gg/OpenSourceSupport).
|
|
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.
|
|
|
|
#
|
|
<sup>Not an official Splatoon™ product. We are in no way affiliated with or endorsed by Nintendo Company, or other rightsholders.</sup>
|