TeamInklings/Octobot
TeamInklings/Octobot
1
0
Fork 1
mirror of https://github.com/TeamOctolings/Octobot.git synced 2025-05-13 17:26:08 +03:00
Code Issues Wiki Activity

Add building & running instructions

Browse source 
Signed-off-by: Macintosh II <95250141+mctaylors@users.noreply.github.com>
This commit is contained in:
Macintxsh 2023-10-04 17:03:52 +03:00 • committed by GitHub
parent f7b59c173f
commit 501da7b943
Signed by: GitHub
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/README.md
View file

@ -22,6 +22,55 @@ Veemo! I'm a general-purpose bot for moderation (formerly known as Boyfriend) wr
[//]: # (if you are reading this, message @mctaylors and ask him to bring back the wiki) [//]: # (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 ## Contributing
When it comes to contributing to the project, the two main things you can do to help out are reporting issues and When it comes to contributing to the project, the two main things you can do to help out are reporting issues and