Rewrite with hikari

discord-bot/.env.example

@@ -0,0 +1,4 @@
+TOKEN=<discord bot token>
+DECLARE_GLOBAL_COMMANDS=<testing guild id>
+OWNER_IDS=<your user id>
+PREFIX="./"

discord-bot/.gitignore

@@ -1,3 +1,10 @@
 .env
 *.egg-info/
 __pycache__/
+
+.venv
+.nox
+.env
+
+# Database files
+*.db

discord-bot/CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributing
+
+## Setup
+
+To run the bot
+
+```
+cp .env.example .env
+
+python -V  # 3.10
+
+pip install -r requirements.txt
+python -m bot
+```
+
+To test the bot
+
+```
+python -m pip install -r dev-requirements.txt
+
+nox
+```
+
+To test the bot on your own discord server you need to register a discord application at the [Discord Developer Portal](https://discord.com/developers/applications) and get at bot token.
+
+1. Follow a tutorial on how to get a bot token, for example this one: [Creating a discord bot & getting a token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
+2. The bot script expects the bot token to be in the `.env` file under the `TOKEN` variable.
+
+## Resources
+
+### Structure
+
+```graphql
+.env                        # Environment variables
+.env.example                # Example environment variables
+CONTRIBUTING.md             # This file
+dev-requirements.txt        # Development requirements
+flake8-requirements.txt     # Flake8 extensions (for linting)
+noxfile.py                  # Nox session definitions (for formatting, typechecking, linting)
+pyproject.toml              # Project configuration
+README.md                   # Project readme
+requirements.txt            # Requirements
+templates/                  # Message templates
+
+bot/
+├─  __init__.py
+├─  __main__.py         # Entrypoint
+├─  bot.py              # Main bot class
+├─  config.py           # Configuration and secrets
+├─  utils.py            # Utility Functions
+│
+├─  db/                 # Database related code
+│   ├─  database.db     # SQLite database
+│   └─  schema.sql      # Database schema
+│
+└── extensions/         # Application logic, see https://hikari-lightbulb.readthedocs.io/en/latest/guides/extensions.html
+    └─   hot_reload.py  # Utility for hot reload extension
+```
+
+### Adding a new command/listener
+
+1. Create a new file in the `extensions` folder
+2. Copy the template below
+
+```py
+# -*- coding: utf-8 -*-
+"""My plugin."""
+import lightbulb
+
+plugin = lightbulb.Plugin("MyPlugin")
+
+# Add your commands here
+
+def load(bot: lightbulb.BotApp):
+    """Add the plugin to the bot."""
+    bot.add_plugin(plugin)
+
+
+def unload(bot: lightbulb.BotApp):
+    """Remove the plugin to the bot."""
+    bot.remove_plugin(plugin)
+```
+
+For example commands and listeners, see [here](/discord-bot/bot/extensions/_example.py)
+
+### Docs
+
+Discord
+
+- [Discord API Reference](https://discord.com/developers/docs/intro)
+
+Main framework
+
+- [Hikari Repo](https://github.com/hikari-py/hikari)
+- [Hikari Docs](https://docs.hikari-py.dev/en/latest/)
+
+Command handler
+
+- [Lightbulb Repo](https://github.com/tandemdude/hikari-lightbulb)
+- [Lightbulb Docs](https://hikari-lightbulb.readthedocs.io/en/latest/)
+
+Component handler (buttons, modals, etc... )
+
+- [Miru Repo](https://github.com/HyperGH/hikari-miru)

discord-bot/README.md

@@ -6,15 +6,6 @@ This bot collects human feedback to create a dataset for RLHF-alignment of an as
 
 To add the official Open-Assistant data collection bot to your discord server [click here](https://discord.com/api/oauth2/authorize?client_id=1054078345542910022&permissions=1634235579456&scope=bot). The bot needs access to read the contents of user text messages.
 
-## Bot token for development
+## Contributing
 
-To test the bot on your own discord server you need to register a discord application at the [Discord Developer Portal](https://discord.com/developers/applications) and get at bot token.
-
-1. Follow a tutorial on how to get a bot token, for example this one: [Creating a discord bot & getting a token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
-2. The bot script expects the bot token to be in an environment variable called `BOT_TOKEN`.
-
-The simplest way to configure the token is via an `.env` file:
-
-```
-BOT_TOKEN=XYZABC123...
-```
+To contribute to the bot, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file.