mirror of
https://github.com/TeamOctolings/Octobot.git
synced 2025-02-26 17:02:38 +03:00
Update README.md (#39)
This commit is contained in:
parent
8d740e1c52
commit
2ab7a07784
1 changed files with 21 additions and 11 deletions
32
.github/README.md
vendored
32
.github/README.md
vendored
|
@ -1,17 +1,27 @@
|
||||||

|
<picture>
|
||||||

|
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/95250141/206895339-ef5510c8-8b30-4887-b89c-5dc14a24b18a.png">
|
||||||
|
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/95250141/206895340-3415d97d-91fd-4fb6-8c17-4e1bf340e1df.png">
|
||||||
|
|
||||||
|
<img alt="Boyfriend Logo" src="https://user-images.githubusercontent.com/95250141/206895339-ef5510c8-8b30-4887-b89c-5dc14a24b18a.png">
|
||||||
|
|
||||||
|
</picture>
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
## Building
|
Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and Discord.Net
|
||||||
To build Boyfriend, you need to clone this repo and compile it with [.NET 7](https://dotnet.microsoft.com/download/dotnet/7.0).
|
|
||||||
```
|
|
||||||
git clone https://github.com/TeamOctolings/Boyfriend
|
|
||||||
cd Boyfriend
|
|
||||||
dotnet build
|
|
||||||
```
|
|
||||||
|
|
||||||
## Initial setup
|
# Features
|
||||||
Create `token.txt` in `Boyfriend/bin/Debug/net7.0/` and enter your bot token. Then, run `Boyfriend.exe`.
|
* Banning, muting, kicking, etc.
|
||||||
|
* Reminding you about something if you wish
|
||||||
|
* Reminding everyone about that new event you made
|
||||||
|
* Log everything from joining the server to deleting messages
|
||||||
|
|
||||||
|
*...and more!*
|
||||||
|
|
||||||
|
# Getting Started
|
||||||
|
|
||||||
|
You can read our [wiki](https://github.com/TeamOctolings/Boyfriend/wiki) in order to assemble your Boyfriend™ and moderate the server.
|
||||||
|
|
Loading…
Add table
Reference in a new issue