A custom Discord bot for the Fortress of Guffal gaming community. GuffalBot GuffalBot is a custom Discord bot designed for the Fortress of Guffal gaming community. It brings fun, lore-inspired games, leaderboards, and interactive features to the server, enhancing engagement and fostering a vibrant gaming atmosphere.
Features GuffalBot offers a variety of features tailored to the Fortress of Guffal community:
🎮 Text-Based Games Adventure Mode: Embark on an RPG-style adventure inspired by Guffal lore. Complete quests, defeat enemies, and collect rewards. Trivia: Test your knowledge of gaming and Guffal lore with interactive trivia games. Daily Challenges: Solve riddles, complete tasks, or participate in scavenger hunts to earn rewards. 📈 Leaderboards and Progression Track player stats and rankings across games. Level up your Adventurer Rank and unlock custom titles like "Knight of Guffal" or "Master Strategist." 📜 Lore Integration Unlock Guffal lore fragments as you progress through quests and challenges. Participate in lore-based special events and story-driven quests. ⚡ Other Interactive Commands Fun utility commands like /roll-dice, /riddle-me, and /flip-coin for lightweight server interaction. Random rewards and Easter eggs hidden throughout the bot’s features. Commands Command Description /help Display all available bot commands. /start-adventure Begin your RPG adventure in the world of Guffal. /attack Attack an enemy during adventure mode. /start-trivia Start a trivia session. /answer [option] Submit your answer for trivia questions. /leaderboard View the top players and rankings. /roll-dice Roll a dice for a random number (great for RPGs). /claim-daily Claim your daily challenge reward. /stats Check your personal game stats and achievements. /riddle-me Receive a random riddle for you or your friends to solve. Setup Instructions
- Prerequisites Node.js (Version 16 or higher) Discord Developer Account A text editor (e.g., Visual Studio Code)
- Clone the Repository Clone the repository to your local machine:
bash Copy code git clone https://github.com/yourusername/guffalbot.git cd guffalbot 3. Install Dependencies Run the following command to install the required Node.js libraries:
bash Copy code npm install 4. Set Up Environment Variables Create a .env file in the root directory and add your Discord bot token:
makefile Copy code DISCORD_TOKEN=your-bot-token-here Replace your-bot-token-here with the bot token generated from the Discord Developer Portal.
- Run the Bot Start the bot using:
bash Copy code node src/index.js The bot should now be online and ready to interact in your Discord server.
Development Project Structure The repository is organized as follows:
bash Copy code guffalbot/ ├── src/ │ ├── commands/ # Bot commands (e.g., trivia, adventure) │ ├── events/ # Event handlers (e.g., on message, on interaction) │ ├── games/ # Game-specific logic (e.g., RPG, scavenger hunt) │ ├── database/ # Database models and schemas │ ├── utils/ # Utility functions │ ├── index.js # Main bot entry point │ ├── config.json # Configuration (e.g., bot settings) ├── .env # Environment variables (e.g., bot token) ├── .gitignore # Ignored files (e.g., node_modules, .env) ├── package.json # Node.js metadata and dependencies ├── README.md # Documentation Adding New Commands To add a new command, create a file in the src/commands directory, following this format:
javascript Copy code module.exports = { name: 'command-name', description: 'What this command does', execute(message, args) { // Your command logic here message.reply('This is a new command!'); } }; Register the new command in the main bot file (src/index.js).
Features in Development Card Battle Game: Players collect and battle with cards inspired by Guffal lore. Scavenger Hunt: Players solve riddles and find hidden “keys” across the Discord server. Cosmetic Rewards: Unlock titles, avatars, and badges based on progress and achievements. Contributing We welcome contributions from the community! Here’s how you can contribute:
Fork the repository. Create a new branch for your feature: git checkout -b feature-name. Commit your changes: git commit -m "Add feature name". Push to your branch: git push origin feature-name. Submit a pull request for review. Troubleshooting Common Issues Bot Not Responding:
Ensure the bot is online and has the correct permissions in the Discord server. Check if the bot token in .env is correct. Commands Not Recognized:
Verify that the commands are correctly registered in the src/commands directory. Check for typos or syntax errors in your code. Database Errors:
Ensure your database (if used) is running and properly connected. License This project is licensed under the MIT License. You are free to use, modify, and distribute this bot as per the terms of the license.
Credits Arcium: For inspiring the Guffal lore and gaming culture. Discord.js: The library powering this bot. The amazing community of the Fortress of Guffal for their support and engagement!