JakobMe / cthulhu-discord-bot

Discord Chatbot für Cthulhu

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cthulhu Discord Bot

Ein Discord Chatbot für Cthulhu.

Bot Setup

Zunächst muss mit dem eigenen Discord Account im Developer Portal eine Bot-Anwendung angelegt werden; folge dazu einfach der offiziellen Anleitung.

Erstelle anschließend mit dem OAuth2 URL Generator des Developer Portals einen Link mit bot als Scope und den Permissions Send Messages und Manage Messages.

Diese Permissions werden benötigt, damit der Bot auf Nachrichten Antworten und über einen Admin-Befehl Nachrichten löschen kann.

Der erzeugte Link sollte ungefähr so aussehen:

https://discordapp.com/api/oauth2/authorize?client_id=xyz&permissions=10240&scope=bot

Über diesen Link kann der Bot nun zu einem beliebigen Server hinzugefügt werden.

Installation und Start

Zunächst müssen die Dependencies installiert werden:

$ cd cthulhu-discord-bot
$ npm install

Als nächstes muss der Discord Bot Token aus dem Developer Portal als Umgebungsvariable hinterlegt werden.

Dazu muss .env.example in .env umbenannt werden; dort kann der Token folgendermaßen platziert werden:

DISCORD_TOKEN=XYZ

Nun kann die App gestartet werden:

$ npm start

Wenn alles korrekt konfiguriert ist, sollte der Bot nun auf deinem Discord Server als "online" angezeigt werden und auf Nachrichten reagieren.

Schreib einfach die Nachricht !hilfe, um mehr über die verfügbaren Befehle zu erfahren.

Entwicklung

Linting und Formatierung

$ npm run lint
$ npm run prettier

Tests

$ npm test
$ npm run test:watch
$ npm run test:coverage

Deployment

Der Bot ist für ein Deployment auf Heroku konzipiert, kann jedoch prinzipiell auf jeder Plattform deployed werden.

Folge der offiziellen Anleitung von Heroku und erstelle eine neue App für den Bot.

Die Datei Procfile konfiguriert einen Heroku worker Dyno; stelle deine App auf diesen Dyno Typen um und deaktiviere den Standard web Dyno. Jetzt muss nur noch der Discord-Token als Umgebungsvariable DISCORD_TOKEN in Heroku hinterlegt werden und der Bot sollte sich nach dem Deployment automatisch auf deinem Discord Server einloggen.

About

Discord Chatbot für Cthulhu

License:MIT License


Languages

Language:TypeScript 99.6%Language:JavaScript 0.4%Language:Shell 0.0%