Setting up the Test Version

Follow these instructions to install the development version of Eggsplode.

1. Bot Setup

First, we need to create a Bot on Discord's side.

1. On the Discord Dev Portal, click on New Application. Customize the title, icon, description, etc.
2. In the Installation page, select application.commands in both User Install and Guild Install. Also select bot in Guild Install. Under Permissions, select the following:
   • Send Messages
   • Send Messages in Threads
   • Attach Files
   • Embed Links
3. Under Install Link, make sure Discord Provided Link is selected. Copy the install link and open it to install your bot. For now, you should only install it to a test server.
4. In the Bot page, click on Reset Token. Copy the new token to a safe place (we'll need it later).
5. In Discord, enable Developer Mode under User Settings > Advanced.
6. Right-click on your test server and select Copy Server ID.

2. Project Setup

Clone the Git repo and go to the folder you cloned the repo into.

git clone https://github.com/iqnite/eggsplode
cd eggsplode

Note

I strongly recommend to look into Git and version control before contributing to Eggsplode, as it's important knowledge. There are easy-to-understand tutorials about Git on YouTube, which is why I will not explain it here.

1. Copy the .env.example file and rename it to .env.
2. Open the new .env file in a text editor.
3. Replace YOUR_BOT_TOKEN with... your Bot Token.
4. Save the file and close the text editor.
5. In the resources folder, copy the config.json.example file and rename it to config.json.
6. Open the new config.json file in a text editor.
7. Set the test_guild_id to your test server ID.
8. Save the file and close the text editor.

Tip

If you don't have your bot token or test server ID anymore, simply repeat steps 4 or 6 in the Bot Setup section, respectively.

3. Installation

Time to install the dependencies!

Important

Eggsplode requires Python 3.10 or higher.

Python's package manager (pip) will automatically detect the required libraries if you run the following commands.

python -m pip install --upgrade pip
pip install -r requirements.txt

Tip

If one of these commands fails, try replacing python with python3 or pip with pip3.

Although it is best practice to create a virtual environment, it is not strictly necessary. If your operating system enforces it, please google "python virtual environment" and go by a tutorial.

4. Start the bot

You're all set! Now you can start the bot and it should appear online on your test server!