v3.0.1 - Added Config.cs and Readme, Privacy and Commands

This commit is contained in:
2026-04-18 02:31:47 +01:00
parent 44393f1745
commit 4f41c465d1
5 changed files with 212 additions and 1 deletions

90
README.md Normal file
View File

@@ -0,0 +1,90 @@
# SkyBot
SkyBot is a Valour.gg bot built with .NET 10.
---
## Features
- Designed for self-hosting
- Open-source under AGPL-3.0
- Built with .NET 10
- Command system with automatic registration
### Command Categories
- **Fun** — utilities and silly stuff (echo)
- **Info** — bot info and command listing
Full command list: [COMMANDS.md](COMMANDS.md)
---
## Data & Privacy
SkyBot stores only the minimum data required for operation. All data is stored in-memory and is lost on restart. No data is persisted to disk.
SkyBot does **not** store:
- Message content
- Direct messages
- Personal user data
Full privacy policy: [PRIVACY.md](PRIVACY.md)
---
## License
This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
See the LICENSE file for details.
Because this project is licensed under AGPL-3.0, if you modify and deploy it publicly (including as a hosted service), you must make your source code available under the same license.
---
## Requirements
- .NET 10
- A Valour bot token
---
## Installation
```bash
git clone <your-repo-url>
cd SkyBot/SkyBot
dotnet restore
```
All required NuGet packages will be installed automatically using the provided `SkyBot.csproj` file.
---
## Configuration
Create a `.env` file in the root directory of the project:
```
TOKEN=your-bot-token-here
```
Then open `Config.cs` and update the following values:
```cs
public static readonly long OwnerId = your-owner-id-here;
public static readonly string Prefix = "your-prefix-here";
```
- Replace `your-owner-id-here` with your Valour user ID.
- Replace `your-prefix-here` with your desired command prefix (e.g. `sd/`).
Never commit your `.env` file to the repository. Ensure it is listed in your `.gitignore`.
---
## Running the Bot
```bash
dotnet run
```