Needle est un robot Discord qui vous aide à désencombrer votre serveur en créant automatiquement des fils de discussion Discord.
Le moyen le plus simple de commencer à utiliser Needle sur votre serveur est d’utiliser l’instance hébergée. Cliquez ici pour inviter Needle sur votre serveur Discord ! Si vous avez des questions, n'hésitez pas à rejoindre le serveur d'assistance et à consulter la foire aux questions.
L'instance hébergée de Needle est personnalisable et devrait suffire à la plupart des utilisateurs. Cependant, si vous avez des exigences particulières et souhaitez modifier les fonctionnalités de Needle, vous devrez créer un fork sur le référentiel et auto-héberger votre propre instance. Cela nécessite des connaissances en programmation et s'adresse uniquement aux utilisateurs avancés - la prise en charge sera limitée.
Needle nécessite un environnement avec Node.js version 16.9.0
ou supérieure, ainsi qu'un stockage persistant pour les fichiers de configuration par serveur - les hôtes partagés (comme Replit et Heroku) ne fonctionneront pas.
Clonez ou téléchargez la dernière version de Needle (branche : stable
).
Copiez .env.example
dans .env
et remplissez le jeton et l'ID d'application de votre bot.
Exécutez npm install
pour installer les dépendances de Needle.
Exécutez npm run build
pour compiler le code de Needle.
Exécutez npm run deploy
pour configurer les commandes slash.
Les commandes Slash peuvent prendre jusqu'à une heure pour apparaître sur tous les serveurs.
Exécutez npm start
pour démarrer Needle ?
Needle nécessite les autorisations suivantes pour fonctionner, ainsi que les portées applications.commands
et bot
.
Afficher les chaînes
Envoyer des messages
Envoyer des messages dans les fils de discussion
Créer des fils de discussion publics
Lire l'historique des messages
Vous pouvez utiliser ce lien pour inviter votre version auto-hébergée de Needle, en remplaçant <APP ID>
par l'ID d'application de votre bot :
https://discord.com/oauth2/authorize?client_id=<APP ID>&permissions=309237713920&scope=bot%20applications.commands
Needle a une image Docker officielle. Les versions sont étiquetées selon leur version mineure et leur version de correctif (par exemple 2.0.0
et 2.0
), la dernière version étant étiquetée latest
. Les branches sont identifiées par leur nom. Pour exécuter l'image, écrivez la commande suivante, en remplaçant token
par le token de votre bot :
docker run -d --name Needle --env DISCORD_API_TOKEN=jeton discord-needle ghcr.io/MarcusOtter/discord-needle:latest
Par défaut, cela créera un volume anonyme pour /configs
. Pour modifier l'emplacement, ajoutez -v /path/to/configs:/configs
à la commande.
Il existe également un exemple de fichier docker-compose.yml
.
Vous devrez toujours déployer les commandes slash de Needle - suivez les instructions d'auto-hébergement habituelles en dehors de l'étape 6.
Les directives de contribution seront bientôt disponibles ™️
Rejoignez le Discord si vous êtes intéressé !
Si vous souhaitez soutenir Needle d’une autre manière, envisagez de parrainer le développement de Needle.
Vous pouvez également voter et évaluer le bot sur top.gg.
Ce programme est un logiciel libre : vous pouvez le redistribuer et/ou le modifier selon les termes de la licence publique générale GNU Affero telle que publiée par la Free Software Foundation, soit la version 3 de la licence, soit (à votre choix) toute version ultérieure.
Ce programme est distribué dans l'espoir qu'il sera utile, mais SANS AUCUNE GARANTIE ; sans même la garantie implicite de QUALITÉ MARCHANDE ou d’ADAPTATION À UN USAGE PARTICULIER. Voir la licence publique générale GNU Affero pour plus de détails.
Vous devriez avoir reçu une copie de la licence publique générale GNU Affero avec ce programme. Sinon, consultez https://www.gnu.org/licenses/.