From 5323e0d6ee070d906cbe17438adf67cfc824ca8b Mon Sep 17 00:00:00 2001 From: skyjoshua Date: Wed, 11 Mar 2026 01:44:23 +0000 Subject: [PATCH] readme and privacy --- PRIVACY.md | 151 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 309 insertions(+), 3 deletions(-) create mode 100644 PRIVACY.md diff --git a/PRIVACY.md b/PRIVACY.md new file mode 100644 index 0000000..f4f4d57 --- /dev/null +++ b/PRIVACY.md @@ -0,0 +1,151 @@ + + + + +

Privacy Policy

+ +

Effective Date: March 11, 2026

+ +

+This Privacy Policy describes how Reactor collects, uses, +and stores information when used within a Valour server. +

+ +
+ +

1. Information Collected

+ +

+Reactor collects only the minimum data required to function. +

+ +

Information Stored (Persisted to Disk)

+ + +

Information Not Stored

+ + +
+ +

2. Purpose of Data Collection

+ +

Stored information is used exclusively to:

+ +
    +
  1. Track which messages are configured as reaction role messages
    2. +
  2. Map emoji reactions to planet roles
    3. +
  3. Assign or remove roles from members when they react or unreact to a tracked message
    4. +
  4. Automatically clean up stale data when messages are deleted
    5. +
+ +

+Data is not used for marketing, advertising, profiling, or analytics. +

+ +
+ +

3. Data Storage and Security

+ +

+All data is stored in a local SQLite database file (reactor.db) on the hosting server. +

+ +

+The operator of the self-hosted instance is responsible for securing the hosting environment +and the database file. +

+ +

+Stale or deleted reaction messages are automatically removed from the database on bot startup. +

+ +
+ +

4. Third-Party Processing

+ +

+Reactor does not transmit any data to external services beyond the Valour.gg API, +which is required for core bot functionality such as assigning roles and sending messages. +

+ +

+Reactor does not use any external AI providers, analytics services, or cloud storage. +

+ +
+ +

5. Data Retention

+ +

+Reaction role message data is retained in the SQLite database until: +

+ + + +
+ +

6. Self-Hosted Responsibility

+ +

+Reactor is designed for self-hosting. +

+ +

+The hosting operator is responsible for: +

+ + + +
+ +

7. Changes to This Policy

+ +

+If data collection practices change in future versions, +this Privacy Policy will be updated prior to implementation. +

+ +

+Continued use of the Bot after updates constitutes acceptance +of the revised policy. +

+ +
+ +

8. Contact Information

+ +

+For privacy-related inquiries: +

+ +

+Email: contact@skyjoshua.xyz +

+ + + \ No newline at end of file diff --git a/README.md b/README.md index 2e774c0..5d7eaf3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,166 @@ - -

Coming Soon.

+

Reactor

-

DO NOT USE THIS YET ITS NO WHERE NEAR DONE AND HAS NO PRIVACY POLICY!

+

+Reactor is a Valour.gg bot that enables server administrators to create reaction role messages. +Users can react to a message with an emoji to automatically be assigned or removed from a role. +

+ +
+ +

Features

+ + +
+ +

How It Works

+

Reactor connects to the Valour.gg API and listens for reactions on configured messages.

+ + +
+ +

Requirements

+ + +
+ +

Installation

+ +
fork the project
+git clone https://github.com/YOUR_USERNAME/Reactor.git
+cd Reactor
+dotnet restore
+ +

+All required NuGet packages are installed automatically via the .csproj file. +

+ +
+ +

Configuration

+ +

Create a .env file in the root directory:

+ +
TOKEN=your-valour-bot-token
+ +

+Do not commit this file to version control. +

+ +
+ +

Running the Bot

+ +
dotnet run
+ +
+ +

Commands

+ +

All commands require Manage Roles or Full Control permissions, except r.help and r.source.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandDescription
r.helpShows the list of available commands
r.sourceShows the source code of the bot
r.create <message text>Creates a new reaction role message in the current channel
r.add <messageId> <emoji> <roleId>Maps an emoji to a role on a reaction message
r.remove <messageId> <emoji>Removes an emoji-to-role mapping from a reaction message
r.delete <messageId>Deletes a reaction message and all its role mappings
+ +
+ +

Data Storage

+ +

Reactor stores the following data in a local SQLite database (reactor.db):

+ + +

+Full privacy policy:
+ +https://github.com/SkyJoshua/Reactor/blob/main/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:
+ +https://github.com/SkyJoshua/Reactor/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. +

+ +
+ +

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