Installation

Pré-requis

• Python 3.13.
• Un compte et un serveur sur Discord.

Mise en place du code

# Récupérer le code et aller dans le dossier
git clone https://git.rita.moe/NLR/Nyx.git && cd Nyx

# Copie du fichier de configuration
cp config.ini.dist config.ini

Utilisation de uv

Vous pouvez installer uv pour gérer facilement l'environnement Python et nos dépendances.
Sautez au titre suivant si vous voulez y aller manuellement avec pip.

# Installer l'utilitaire
curl -LsSf https://astral.sh/uv/install.sh | sh

# Dans le dossier de Nyx, synchroniser les dépendances
# et récupérer la bonne version de Python
uv sync --managed-python

# Pour mettre à jour `uv` s'il se plaint de ne pas trouver
# la version de Python demandée
uv self update

Dépendances python sans uv

Si vous êtes sur une version de Python compatible (voir le pyproject.toml), et avez préparé votre environement (un VirtualEnv est recommandé), vous pouvez installer les dépendances avec pip:

# Installer le projet
pip install -U .

Lancement

• Configurez le bot en modifiant son fichier de configuration
• Dans un tmux/screen/watcher/supervisor:
• Avec uv: uv run nyx.py
• Sans uv: python nyx.py
• Invitez le bot dans votre serveur en ouvrant le lien qu'il s'affiche lors de son démarrage.