### Docker Installation Guide Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Instructions for installing and running the ButterGolem Bot using Docker. This is the recommended installation method. ```bash # 1. Clone the repository git clone https://github.com/ninjazan420/buttergolem.git cd buttergolem # 2. Set Environment Variables (create a .env file or set them directly) # DISCORD_API_TOKEN=your_bot_token # LOGGING_CHANNEL=channel_id_for_logs # ADMIN_USER_ID=your_discord_user_id # BLACKLISTED_GUILDS=server_id1,server_id2 # ENABLE_RANDOM_JOINS=False # 3. Build and start the bot docker compose build docker compose up -d # 4. View logs docker compose logs -f ``` -------------------------------- ### Manual Installation Guide Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Instructions for manually installing the ButterGolem Bot on a system with Python 3.8+. ```bash # 1. Install Python 3.8+ # 2. Install dependencies pip install discord.py psutil requests aiohttp beautifulsoup4 Pillow # 3. Start the bot cd src python main.py ``` -------------------------------- ### Drachengotchi Game Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Core commands for interacting with the Drachengotchi game, including starting, checking status, and accessing help. Persistent storage ensures progress is saved. ```APIDOC /gotchi start - Creates a personal Drachengotchi. /gotchi status - Displays current status with ASCII art. /gotchi hilfe - Provides a complete game guide with all commands. ``` -------------------------------- ### Configure Ko-fi Webhook in Docker Compose Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/docs/kofi_integration.md This snippet shows how to configure environment variables and port forwarding in a docker-compose.yml file for the Ko-fi webhook integration. It includes setting the Ko-fi URLs, the webhook token for verification, and the port the webhook server listens on. ```yaml # Port-Freigabe für den Ko-fi Webhook-Server ports: - "5000:5000" # Port für den Ko-fi Webhook-Server # Ko-fi URLs für Spenden KOFI_URL: "https://ko-fi.com/buttergolem" # Hauptseite für Spenden KOFI_TIP_URL: "https://ko-fi.com/buttergolem/tip" # Direkte Spenden KOFI_WEBHOOK_TOKEN: "dein-webhook-token" # Wird für die Verifizierung von Ko-fi Webhooks verwendet KOFI_WEBHOOK_PORT: "5000" # Port für den Ko-fi Webhook-Server ``` -------------------------------- ### Admin Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Administrative commands for managing the bot and server. Includes global messaging, memory system, server listing, and statistics. ```APIDOC Global Message: - Send global messages to join channels. Memory System: - Store user reminders. Server List: - Display all servers the bot is in. Server Statistics: - Show detailed server information. Server Counter: - Update the server count. Available Metrics: - Server count and user count. - Uptime and performance. - Sound statistics. - Memory usage. - Bot version and features. ``` -------------------------------- ### Sound System Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Access and play over 500 sound clips related to Drachenlord. Commands allow browsing, playing specific sounds, or a random sound. ```APIDOC /sounds - Browse a paginated list of all available sounds. /sound [name] - Play a specific sound clip by its name. /lord - Play a random sound clip. Sound Categories: - Classic SCREAMS - Cringe Sounds - New 2024 Clips - Categorized for easy access. ``` -------------------------------- ### ButterGolem Bot Slash Commands (Admin) Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Übersicht über die administrativen Slash Commands des ButterGolem Discord Bots. Diese Befehle sind für Server-Administratoren gedacht und ermöglichen erweiterte Funktionen wie Server-Management, Debugging und globale Nachrichten. ```APIDOC /drache neofetch Beschreibung: Zeigt animierte Bot-Statistiken im Neofetch-Stil an. /drache drachenlord Beschreibung: Zeigt Bot-Statistiken mit Drachenlord-Zitaten an. /drache shrek Beschreibung: Zeigt Bot-Statistiken mit einem Shrek-Theme an. /memory list Beschreibung: Listet alle gespeicherten Nutzer-Erinnerungen auf. /memory show [user] Beschreibung: Zeigt eine spezifische Erinnerung für einen bestimmten User an. Parameter: user: Der User, dessen Erinnerung angezeigt werden soll. /memory add [user] [text] Beschreibung: Fügt eine neue Erinnerung für einen User hinzu. Parameter: user: Der User, für den die Erinnerung erstellt wird. text: Der Inhalt der Erinnerung. /memory delete [user] Beschreibung: Löscht alle Erinnerungen für einen bestimmten User. Parameter: user: Der User, dessen Erinnerungen gelöscht werden sollen. /servercount Beschreibung: Aktualisiert manuell den Server-Zähler des Bots. /server [page] Beschreibung: Zeigt eine Liste von Servern und deren Statistiken an. Parameter: page: Die anzuzeigende Seite der Serverliste (optional). /antwort [id] [text] Beschreibung: Sendet eine Antwort auf eine frühere Nachricht oder Anfrage. Parameter: id: Die ID der ursprünglichen Nachricht/Anfrage. text: Der Inhalt der Antwort. /debug_sounds Beschreibung: Führt eine Debugging-Routine für das Sound-System aus. /butteriq [action] Beschreibung: Verwaltet den Zugriff auf die KI-Funktionen des Bots. Parameter: action: Die auszuführende Aktion (z.B. 'enable', 'disable', 'status'). /global [nachricht] Beschreibung: Sendet eine Nachricht an alle Server, auf denen der Bot aktiv ist. Parameter: nachricht: Die global zu sendende Nachricht. ``` -------------------------------- ### ButterGolem Bot Slash Commands (User) Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Übersicht über die für alle Nutzer verfügbaren Slash Commands des ButterGolem Discord Bots. Diese Befehle ermöglichen die Interaktion mit dem Bot für Zitate, Sounds, Statistiken und mehr. ```APIDOC /hilfe Beschreibung: Zeigt alle verfügbaren Befehle. /drache stats Beschreibung: Bot-Statistiken anzeigen. /sound [name] Beschreibung: Spezifischen Sound abspielen. Parameter: name: Der Name des abzuspielenden Sounds (optional). /sounds Beschreibung: Liste aller verfügbaren Sounds. /lord Beschreibung: Zufälligen Drachenlord Sound abspielen. /mett Beschreibung: Aktueller Mett-Level mit einem visuellen Meter anzeigen. /zitat Beschreibung: Zufälliges Drachenlord Zitat abspielen. /lordmeme [text] [position] Beschreibung: Erstellt ein Drachenlord-Meme mit benutzerdefiniertem Text. Parameter: text: Der Text, der auf das Meme geschrieben werden soll. position: Die Position des Textes (oben, unten, beide). /lordstats [@user] Beschreibung: Zeigt lustige Statistiken für einen bestimmten User an. Parameter: @user: Der User, für den Statistiken angezeigt werden sollen. /changelog [version] Beschreibung: Zeigt Bot-Updates und das Changelog für eine spezifische Version an. Parameter: version: Die gewünschte Bot-Version (optional). /quiz [runden] Beschreibung: Startet ein Drachenlord-Quiz. Parameter: runden: Die Anzahl der Quizrunden (optional). /gotchi hilfe Beschreibung: Zeigt die Spielanleitung für das neue Drachigotchi-Spiel an. /ping Beschreibung: Zeigt die aktuelle Latenz des Bots an. /kontakt [nachricht] Beschreibung: Sendet eine Nachricht an den Bot-Administrator. Parameter: nachricht: Die zu sendende Nachricht. /privacy Beschreibung: Zeigt die Datenschutzerklärung des Bots an. ``` -------------------------------- ### Quiz System Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Test your knowledge about Drachenlord, Haider, and the Schanze with over 150 questions. Supports multiplayer and tracks user statistics. ```APIDOC /quiz [anzahl_runden] - Start a quiz session. Specify the number of rounds (1-20). Quiz Features: - 150+ questions about Drachenlord lore. - Multiple difficulty levels. - Multiplayer support for playing with friends. - Statistics tracking for user performance. ``` -------------------------------- ### Drachigotchi Spiel-Anleitung Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Anleitung für das neue Drachigotchi-Spiel, das in Version 6.1.0 eingeführt wurde. Das Spiel simuliert das Leben als Drachenlord und beinhaltet Pflege, Erkundung und Kämpfe. ```APIDOC Drachigotchi Spiel-Anleitung: Das Drachigotchi ist ein Tamagotchi-ähnliches Spiel, bei dem du das Leben als Drachenlord simulieren kannst. **Ziele:** - Kümmere dich um dein virtuelles Drachigotchi. - Erkunde die Spielwelt. - Kämpfe gegen Hater. - Werde zum ultimativen Drachenlord. **Befehle:** - `/gotchi hilfe`: Zeigt diese Anleitung an. - Weitere Befehle werden im Spielverlauf freigeschaltet oder sind über das Hauptmenü zugänglich. ``` -------------------------------- ### Environment Variables for Docker Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Required environment variables for configuring the ButterGolem Bot when using Docker. These control the bot's token, logging, admin settings, and more. ```env DISCORD_API_TOKEN=dein_bot_token LOGGING_CHANNEL=channel_id_für_logs ADMIN_USER_ID=deine_discord_user_id BLACKLISTED_GUILDS=server_id1,server_id2 ENABLE_RANDOM_JOINS=False ``` -------------------------------- ### Statistics and Neofetch Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Display system and bot statistics using Neofetch-style ASCII art. Supports different themes including Drachenlord quotes and Shrek. ```APIDOC /drache neofetch - Displays standard ASCII art system statistics. /drache drachenlord - Shows statistics with Drachenlord quotes. /drache shrek - Displays statistics with a Shrek theme. ``` -------------------------------- ### Ko-fi Webhook Server API Details Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/docs/kofi_integration.md Details regarding the Ko-fi webhook server used by the Buttergolem bot. It specifies the endpoint, expected data format from Ko-fi, and the security mechanism for verifying incoming requests. ```APIDOC Ko-fi Webhook Server: Endpoint: - POST /kofi-webhook Description: The webhook server listens for donation notifications from Ko-fi. It verifies incoming requests using a shared secret token. Upon successful verification, it logs the donation and optionally notifies the user. Request Data Format: Ko-fi sends data in `application/x-www-form-urlencoded` format. The payload contains a field named 'data', which is a JSON string. The server is designed to handle both this format and direct JSON requests. Verification: Requests are verified against a pre-configured `KOFI_WEBHOOK_TOKEN`. Only requests with a valid token are processed. Security: The webhook server uses the `KOFI_WEBHOOK_TOKEN` to ensure that only legitimate requests from Ko-fi are processed. Status Page: A simple status page is available at the root URL (e.g., `http://your-server-ip:5000/`) to confirm the server is running and configured correctly. ``` -------------------------------- ### Drachengotchi Survival & Shopping Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Commands related to managing your Drachengotchi's needs and interacting with the in-game economy. Features include eating, shopping, and stat management. ```APIDOC /gotchi essen - Consume food from your inventory (uses a dropdown menu). /gotchi kaufen - Purchase items from local shops (uses a dropdown menu). /gotchi shop - View available items at the current location. Stat Management: - Tracks Hunger, Health, Happiness, and Energy. ``` -------------------------------- ### Bot Permissions Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md List of necessary Discord bot permissions required for the ButterGolem Bot to function correctly. ```APIDOC - Send Messages - Use Slash Commands - Connect to Voice Channels - Speak in Voice Channels - Attach Files - Embed Links ``` -------------------------------- ### Drachengotchi Travel & Adventure Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Commands for navigating the game world, exploring locations, and engaging in combat or activities for rewards. Includes travel to various predefined locations. ```APIDOC /gotchi reisen - Travel to different locations. Available locations include: - Die Schanze (Home) - Emskirchener Wald - Netto Markt - Gasthof Sonne - Nürnberg - Autobahn A3 - and more! /gotchi erkunden - Explore your current location for rewards. /gotchi hater_bekämpfen - Fight against 'Haters' to earn fame. /gotchi streamen - Stream to earn money and fame. ``` -------------------------------- ### Drachengotchi Quests & Progress Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Commands for managing quests, viewing achievements, working for in-game currency, and crafting items. Supports a level and skill system for character progression. ```APIDOC /gotchi quests - Display available and active quests. /gotchi achievements - View your collected achievements. /gotchi arbeiten - Work at your job to earn money. /gotchi craft - Create new items using collected materials. Progression Systems: - Level System: Gain experience and level up. - Skill System: Improve stats like Strength, Defense, Charisma. - Inventory Management: Collect and manage items. - Job System: Work as a Streamer, Mett-Seller, or Schanze-Guard. - Equipment System: Equip weapons, shields, and vehicles. - Random Events: Experience unpredictable in-game occurrences. ``` -------------------------------- ### Drachenlord AI Chat Commands Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/README.md Interact with the Drachenlord AI. Mention the bot in a channel or send a direct message to chat. The AI features authentic personality, context-aware responses, and up-to-date memes. ```APIDOC @ButterGolem [nachricht] - Mention the bot in a channel to send a message. DM - Send a private message directly to the bot. AI Features: - Authentic Drachenlord personality. - Context-aware responses. - Incorporates current events and memes. - Dynamic reactions. - Free for all users. ``` -------------------------------- ### Bot Opt-Out Mechanisms Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/privacy_policy.md Provides users and server administrators with methods to opt out of specific data processing features or to cease interaction with the bot entirely. This includes avoiding bot commands, removing the bot from a server, or disabling specific features. ```APIDOC BotOptOut: MessageContentOptOut: Methods: - Do not use bot commands. - Do not use AI chat features. - Remove the bot from the server. ServerMembersOptOut: Methods: - Server administrators can disable statistic commands. - Server administrators can remove the bot from the server. ``` -------------------------------- ### Bot Data Collection and Usage Source: https://github.com/ninjazan420/buttergolem-bot/blob/master/privacy_policy.md Details the types of data collected by the Buttergolem bot, including message content and server member information, and specifies how this data is used solely for bot functionality. It explicitly states no data is shared with third parties or used for AI training. ```APIDOC BotDataHandling: CollectedData: - Type: Message Content Purpose: - Quiz game answers and commands - AI chat functionality (session-based context, max 10 messages per user) - Sound-board commands for audio playback - Admin moderation commands - Interactive game inputs Storage: Temporarily processed, NOT permanently stored. - Type: Server Members Purpose: - Member counts for statistics commands - Server growth analytics for administrators - Member-based features in quiz and gaming systems Storage: Used for specific features. - Type: User IDs Purpose: - Command processing - Temporary session management - Admin functions (e.g., ban management) Storage: Used for bot operation. DataUsage: - Primary Use: Solely for providing bot features. - Restrictions: - NO sharing with third parties. - NO use for AI training or machine learning. - NO commercial exploitation. - Scope: Data used only for specified bot features. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.