Needle ist ein Discord-Bot , der Ihnen hilft, Ihren Server aufzuräumen, indem er automatisch Discord-Threads erstellt.
Der einfachste Weg, Needle auf Ihrem Server zu verwenden, ist die Verwendung der gehosteten Instanz. Klicken Sie hier, um Needle zu Ihrem Discord-Server einzuladen! Wenn Sie Fragen haben, können Sie sich gerne dem Support-Server anschließen und die häufig gestellten Fragen durchsehen.
Die gehostete Instanz von Needle ist anpassbar und sollte für die meisten Benutzer ausreichen. Wenn Sie jedoch besondere Anforderungen haben und die Funktionalität von Needle ändern möchten, müssen Sie das Repository forken und Ihre eigene Instanz selbst hosten. Dies erfordert Programmierkenntnisse und ist nur für fortgeschrittene Benutzer gedacht – die Unterstützung hierfür ist begrenzt.
Needle erfordert eine Umgebung mit Node.js Version 16.9.0
oder höher sowie dauerhaften Speicher für Konfigurationsdateien pro Server – gemeinsam genutzte Hosts (wie Replit und Heroku) funktionieren nicht.
Klonen oder laden Sie die neueste Version von Needle herunter (Zweig: stable
).
Kopieren Sie .env.example
nach .env
und geben Sie das Token und die Anwendungs-ID Ihres Bots ein.
Führen Sie npm install
aus, um die Abhängigkeiten von Needle zu installieren.
Führen Sie npm run build
aus, um Needles Code zu kompilieren.
Führen Sie npm run deploy
aus, um Slash-Befehle einzurichten.
Es kann bis zu einer Stunde dauern, bis Slash-Befehle auf allen Servern angezeigt werden.
Führen Sie npm start
um Needle zu starten?
Needle benötigt zum Funktionieren die folgenden Berechtigungen sowie die Bereiche applications.commands
und bot
.
Kanäle anzeigen
Senden Sie Nachrichten
Senden Sie Nachrichten in Threads
Erstellen Sie öffentliche Threads
Nachrichtenverlauf lesen
Sie können diesen Link verwenden, um Ihre selbst gehostete Version von Needle einzuladen, indem Sie <APP ID>
durch die Anwendungs-ID Ihres Bots ersetzen:
https://discord.com/oauth2/authorize?client_id=<APP ID>&permissions=309237713920&scope=bot%20applications.commands
Needle verfügt über ein offizielles Docker-Image. Veröffentlichungen sind nach ihrer Neben- und Patchversion gekennzeichnet (z. B. 2.0.0
und 2.0
), wobei die neueste Version mit der latest
Version gekennzeichnet ist. Zweige werden mit ihrem Namen gekennzeichnet. Um das Image auszuführen, schreiben Sie den folgenden Befehl und ersetzen Sie token
durch das Token Ihres Bots:
docker run -d --name Needle --env DISCORD_API_TOKEN=token discord-needle ghcr.io/MarcusOtter/discord-needle:latest
Standardmäßig wird dadurch ein anonymes Volume für /configs
erstellt. Um den Speicherort zu ändern, fügen Sie -v /path/to/configs:/configs
zum Befehl hinzu.
Es gibt auch eine Beispieldatei docker-compose.yml
.
Sie müssen weiterhin die Slash-Befehle von Needle bereitstellen – befolgen Sie die regulären Anweisungen zum Selbsthosten mit Ausnahme von Schritt 6.
Beitragsrichtlinien folgen in Kürze ™️
Bei Interesse dem Discord beitreten!
Wenn Sie Needle auf andere Weise unterstützen möchten, denken Sie darüber nach, die Entwicklung von Needle zu sponsern.
Sie können auch auf top.gg für den Bot stimmen und ihn bewerten.
Dieses Programm ist freie Software: Sie können es unter den Bedingungen der GNU Affero General Public License, wie von der Free Software Foundation veröffentlicht, entweder Version 3 der Lizenz oder (nach Ihrer Wahl) einer späteren Version weiterverbreiten und/oder ändern.
Dieses Programm wird in der Hoffnung verbreitet, dass es nützlich ist, jedoch OHNE JEGLICHE GARANTIE; ohne die stillschweigende Garantie der MARKTGÄNGIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK. Weitere Einzelheiten finden Sie in der GNU Affero General Public License.
Sie sollten zusammen mit diesem Programm eine Kopie der GNU Affero General Public License erhalten haben. Wenn nicht, siehe https://www.gnu.org/licenses/.