Skip to main content

Get Started in Minutes

Follow these steps to have ChimBot running in your Discord server quickly.
1

Clone the Repository

First, clone the ChimBot repository to your local machine:
git clone https://github.com/yourusername/chimbot.git
cd chimbot
2

Install Dependencies

Install the required Python packages using pip:
pip install discord.py python-dotenv groq
Make sure you have Python 3.8 or higher installed on your system.
3

Configure Environment Variables

Create a .env file in the project root with your credentials:
TOKEN=your_discord_bot_token_here
GROQ_API_KEY=your_groq_api_key_here
Never commit your .env file to version control. Keep your tokens secure!
Where to get these:
4

Customize Bot Settings (Optional)

Open source/main.py and configure these key settings:
# Command prefix (default: $)
bot = commands.Bot(command_prefix='$', intents=intents, help_command=None)

# AI response probability (0.0 to 1.0)
PROBABILIDAD_RESPUESTA = 0.15

# Spam detection thresholds
LIMITE_MENSAJES = 4          # Messages before spam trigger
TIEMPO_LIMITE = 4            # Seconds to track messages
LIMITE_REPETICIONES = 3      # Repeated message threshold
5

Set Channel IDs

Update the channel IDs in source/main.py to match your server:
# ID of your spam channel
CANAL_SPAM_ID = 1004171793101230151

# ID of your welcome/farewell channel
CANAL_BIENVENIDA_ID = 1004156875035656303
Right-click on a channel in Discord and select “Copy ID” to get the channel ID. You may need to enable Developer Mode in Discord settings.
6

Run the Bot

Start ChimBot with a single command:
python source/main.py
You should see output confirming the bot is online:
✅ Bot conectado como ChimBot#1234
📋 Comandos cargados: 12
🔗 Servidores conectados: 1
💬 Canal de spam configurado: 1004171793101230151
7

Test the Bot

In your Discord server, try these commands to verify everything works:
$help user          # View user commands
$statusspam         # Check spam system status
@ChimBot hello      # Test AI response
If the bot responds, congratulations! ChimBot is successfully running.

Next Steps

Explore Commands

Learn about all available commands for users and admins

Customize AI Personality

Adjust AI behavior, prompts, and response settings

Set Up Spam Messages

Configure automated periodic messaging

Admin Features

Discover administrator commands and controls

Troubleshooting

  • Verify your TOKEN in the .env file is correct
  • Ensure the bot has been invited to your server with proper permissions
  • Check that you’ve enabled the Message Content Intent in the Discord Developer Portal
  • Confirm your GROQ_API_KEY is valid and has available quota
  • Check your internet connection
  • Review the console for any error messages from the Groq API
  • Verify you’re using the correct command prefix (default is $)
  • Ensure the bot has permission to read and send messages in the channel
  • Try running $help to confirm the bot can respond
  • Adjust LIMITE_MENSAJES and TIEMPO_LIMITE in source/main.py
  • Increase values for more lenient detection
  • The spam channel (set by CANAL_SPAM_ID) is exempt from spam detection

Need Help?

If you encounter issues not covered here, check the full installation guide for detailed troubleshooting steps.

Build docs developers (and LLMs) love