Getting Started

Welcome to Egg Shen Bot! This guide will help you get the bot up and running in your Discord server.

Prerequisites

Before you begin, make sure you have:

• Node.js v20.x or higher
• npm (comes with Node.js)
• A Discord Bot Token (Create one here)
• TMDB API Key (Get it here) - Required

Optional API Keys

These enable additional features:

• OMDB API Key - IMDb and Rotten Tomatoes ratings
• Trakt Client ID - Trakt community ratings
• RAWG API Key - Video game search
• BoardGameGeek Client ID - Board game search

Note: Commands requiring optional APIs will be disabled if their API keys aren't configured.

Installation

1. Clone the Repository

git clone https://github.com/r3volution11/Egg-Shen-Bot.git
cd Egg-Shen-Bot

2. Install Dependencies

npm install

3. Configure the Bot

Create a .env file with your API keys:

cp .env.example .env

Edit .env with your credentials:

# Discord Configuration (Required)
DISCORD_TOKEN=your_discord_bot_token_here
DISCORD_CLIENT_ID=your_discord_client_id_here

# TMDB API (Required)
TMDB_API_KEY=your_tmdb_api_key_here

# Optional APIs
OMDB_API_KEY=your_omdb_api_key_here
TRAKT_CLIENT_ID=your_trakt_client_id_here
RAWG_API_KEY=your_rawg_api_key_here
BGG_CLIENT_ID=your_bgg_client_id_here

See Installation Guide for detailed API key setup instructions.

4. Start the Bot

npm start

You should see: ✓ Logged in as YourBot#1234

Note: Slash commands are automatically registered when the bot starts. No separate registration step needed!

Quick Configuration

Once the bot is running, use these commands to configure your server:

Enable/Disable Services

/eggshen-config settings toggle service:imdb enabled:true

Control which rating services appear in embeds.

Set Rate Limits

/eggshen-config rate-limit toggle enabled:true

Enable rate limiting to prevent abuse (enabled by default).

Configure Emojis

/eggshen-config settings emoji service:imdb emoji:🎬

Customize emojis for each service.

First Commands

Try these commands in your server:

/movie title:The Matrix
/tv title:Breaking Bad
/episode title:The Last of Us season:1 episode:1
/game title:The Last of Us
/timer start label:Movie Night

Next Steps

• Learn about all commands
• Configure rate limiting
• Set up moderation tools
• Enable statistics tracking

Troubleshooting

Bot doesn't respond to commands

1. Make sure you ran npm run register-commands
2. Check the bot has proper permissions in your server
3. Verify the bot token in config/config.json

API errors

• Check that your API keys are valid
• TMDB is required for movie/TV searches
• Other APIs are optional but enhance features

Rate limit issues

• Check /eggshen-config rate-limit view to see current settings
• Use /eggshen-config rate-limit clear user:@someone for emergency overrides

Support

Having issues? Check:

• Command Reference
• Configuration Guide
• GitHub Issues