INSTALLATION.md

Getting Started

Only required if self-hosted/wanting to contribute

Invite GhostyBot here

How to install Ghostybot on your machine

Requirements

• Discord bot token
• Discord OAuth clientId & clientSecret (Only if using dashboard)
• Node v14+
• FFmpeg
• Mongo URI

Api Keys

These api keys are not required for the bot to function. Only required for their desired command.

• openWeatherMapKey
• imdbKey
• mongodbUri
• giphyApiKey
• alexflipnoteKey
• pastebin

config

.env

• DISCORD_CLIENT_ID: the client id of your discord bot application
• DISCORD_CLIENT_SECRET: the client secret of your discord bot application
• DISCORD_BOT_TOKEN: Your bot token
• MONGO_DB_URI: your mongoDb uri

The .env list is not fully updated atm.

Installation

1. Clone the repo: git clone https://github.com/Dev-CasperTheGhost/ghostybot
2. Install all dependencies: npm install
3. Rename config.example.json to config.json: cp config.example.json config.json
4. Rename .env.example to .env: Linux: cp .env.example .env
5. Create a bot at Discord Developers and grab the tokens
6. Copy your tokens and paste into .env more info about the .env
7. Modify config.json where needed more info about config.json
8. Run npm run build to create the dashboard, if you have enabled: false for the dashboard, skip this step
9. Run the bot: npm start
   • Using pm2: pm2 start src/index.js --name ghostybot

---

Return to index