diff --git a/README.md b/README.md index 7d3a7f4..00289a0 100644 --- a/README.md +++ b/README.md @@ -1,186 +1,136 @@ - - +# SkyAI -

SkyAI

- -

SkyAI is a Valour.gg bot powered by a self-hosted Large Language Model via Open WebUI. -

-

It supports per-channel conversational memory and is designed for self-hosted deployments. -

-
+--- -

Features

- +## Features -
+- Per-channel AI conversation history +- Self-hosted LLM support (Open WebUI + Ollama) +- Built with .NET +- Open-source under AGPL-3.0 +- Privacy-conscious architecture -

How It Works

-

SkyAI connects to:

- +--- -

-Conversation history is stored in memory per channel and sent with each request -to maintain contextual awareness. History is automatically trimmed to prevent -excessive token usage. -

+## How It Works -
+SkyAI connects to: -

Data & Privacy

+- Valour.gg API +- Open WebUI `/api/chat/completions` endpoint +- A locally hosted LLM (e.g., llama3.1 via Ollama) -

SkyAI stores only the minimum data required for operation.

+Conversation history is stored in memory per channel and sent with each request to maintain contextual awareness. History is automatically trimmed to prevent excessive token usage. -

Stored In Memory (Per Channel)

- +--- -

Not Stored

- +## Data & Privacy + +SkyAI stores only the minimum data required for operation. + +### Stored In Memory (Per Channel) + +- Channel ID +- Message content (AI conversation context only) +- Message role (user / assistant / system) + +### Not Stored + +- Direct Messages +- User credentials +- Email addresses +- Analytics or tracking data -

Conversation history resets automatically when the bot restarts. -

-

-Full privacy policy:
- -https://github.com/SkyJoshua/SkyAI/blob/main/PRIVACY.md - -

+Full privacy policy: +https://git.skyjoshua.xyz/SkyJoshua/SkyAI/blob/main/PRIVACY.md -
+--- -

License

-

-This project is licensed under the -GNU Affero General Public License v3.0 (AGPL-3.0). -

+## License -

-See the LICENSE file for details:
- -https://github.com/SkyJoshua/SkyAI/blob/main/LICENSE - -

+This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**. -

-If you modify and deploy this project publicly (including as a hosted service), -you must make your source code available under the same AGPL-3.0 license. -

+See the LICENSE file for details: +https://git.skyjoshua.xyz/SkyJoshua/SkyAI/blob/main/LICENSE -
+If you modify and deploy this project publicly (including as a hosted service), you must make your source code available under the same AGPL-3.0 license. -

Installation

+--- -
git clone https://github.com/YOUR_USERNAME/SkyAI.git
+## Installation
+```bash
+git clone https://git.skyjoshua.xyz/SkyJoshua/SkyAI.git
 cd SkyAI
-dotnet restore
+dotnet restore +``` -

-All required NuGet packages are installed automatically via SkyAI.csproj. -

+All required NuGet packages are installed automatically via `SkyAI.csproj`. -
+--- -

Requirements

- +## Requirements -
+- .NET 8+ +- Open WebUI running +- Ollama running with a model (e.g., llama3.1) +- Valid Valour bot token -

Configuration

+--- -

Create a .env file in the root directory:

+## Configuration -
TOKEN=your-valour-bot-token
+Create a `.env` file in the root directory:
+```
+TOKEN=your-valour-bot-token
 OPENWEBAPI=your-openwebui-api-key
-OPENWEBURL=your-openwebui-url
+OPENWEBURL=your-openwebui-url +``` -

Do not commit this file to version control. -

-
+--- -

Running the Bot

+## Running the Bot +```bash +dotnet run +``` -
dotnet run
+--- -
+## Commands -

Commands

+| Command | Description | +|---|---| +| `s.ai ` | Send a prompt to the AI | +| `s.cm` | Clear channel conversation memory | +| `s.source` | Shows the source code of the bot | - - - - - - - - - - - - - - - - - -
CommandDescription
s.ai <message>Send a prompt to the AI
s.cmClear channel conversation memory
s.sourceShows the source code of the bot
+--- -
+## Self-Hosting Notes -

Self-Hosting Notes

+Ensure Ollama is running: +```bash +ollama serve +``` -

Ensure Ollama is running:

+Ensure your model is installed: +```bash +ollama list +``` -
ollama serve
+--- -

Ensure your model is installed:

+## Contributing -
ollama list
+Contributions are welcome. By submitting a contribution, you agree that your contributions will be licensed under AGPL-3.0. -
- -

Contributing

- -

-Contributions are welcome. By submitting a contribution, you agree that your -contributions will be licensed under AGPL-3.0. -

- -
    -
  1. Fork the repository
    2. -
  2. Create a feature branch
    3. -
  3. Submit a pull request
    4. -
- - - \ No newline at end of file +1. Fork the repository +2. Create a feature branch +3. Submit a pull request \ No newline at end of file