Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 3.83 KB

README.md

File metadata and controls

68 lines (48 loc) · 3.83 KB
Raw

Discord-Bot

pr0gramm Discord Embed-Bot

❓ Was macht es?

Dieser Bot erlaubt es dir, im Discord verlinkte pr0gramm Uploads, User und Kommentare mit einem Embed dazustellen.

Siehe: https://discord.pr0gramm.com/

📡 Bot einladen

Invite

Der oben verlinkte Bot ist immer die aktuellste Version dieses Repositories. Für die Authentifizierung wurde TheShad0w's nutzer-bot "Shad0wBot" verwendet.
Alternativ: Selber hosten. Anleitung unten zu finden ⏬

💠 Funktionswünsche & Issues

Funktionswunsch oder Fehler entdeckt? Bitte öffne einen Issue hier auf GitHub.

🔧 Installation

  1. Terminal aufmachen und dorthin navigieren, wo man es downloaden möchte

  2. Sichergehen, dass NodeJS installiert ist. Teste mit:
    $ node -v
    Wenn es eine Versionsnummer zurückgibt, ist NodeJS installiert. Wenn nicht, NodeJS hier downloaden.

  3. Repository clonen und hinein navigieren. Wenn Git installiert ist:
    $ git clone https://github.com/pr0-dev/Discord-Bot.git && cd Discord-Bot
    Wenn nicht, hier herunterladen und die ZIP extrahieren.
    Dann in den Ordner navigieren.

  4. Dependencies installieren:
    $ npm install

  5. Das Config-Template config.template.json kopieren und als config.json einfügen.

  6. Die frisch kopierte Config datei ausfüllen.

  7. Das Script starten
    $ npm start

Wichtig: Wenn du keinen Nutzer-Bot hast, wird beim ersten Login im Terminal ein Captcha abgefragt! Stelle sicher, dass du zugriff auf die Konsole hast (falls du es z.B in Docker startest) und dass dein Terminal mindestens 255 Farben unterstützt!

🔩 Konfiguration

Wenn die Konfigurationsdatei wie bei Schritt 4 kopiert wurde, kann config.json angepasst werden:

Config Key Erklärung Erlaubte Werttypen Standardwert
auth:
bot_token		 Der Bot Token des Discord Bots, kann hier erstellt werden. String N/A
bot_settings:
bot_status		 Der Status der bei "Spielt..." in Discord angezeigt wird. String "Name ist pr0gramm"
bot_settings:
nsfw_in_nswfchat_only		 Deaktiviert die Vorschau von NSFW Posts in Discord Kanälen, in denen NSFW nicht aktiviert wurde. Boolean true
bot_settings:
disable_nsfl_preview		 Deaktiviert die Vorschau von NSFL Posts, da diese gegen die Discord ToS verstoßen. Boolean true
bot_settings:
delete_user_message		 Löscht den original link des Users sodass nur das Embed bleibt. Boolean false
bot_settings:
embed_direct_links		 Legt fest, ob direkte pr0gramm Links ebenfalls eingebettet werden sollen (kann sehr noisy sein). Boolean false
pr0api:
username		 Der pr0gramm Username, der für das Anzeigen von NSFW/NSFL/NSFP benutzt wird. String N/A
pr0api:
password		 Das zum pr0gramm username zugehörige Passwort. String N/A
pr0api:
user_agent		 Name des Bots + Info. Beispiel: Shad0wBot/1.1 (Debian 4.19.181-1; GNU/Linux; x86_64) NodeJS/15.11.0 String N/A