3. Start your Bot

System Wide Dependencies

ZeoBot requires a few additional pieces of software to run. Any platforms that require additional configuration will be listed below:

  • Java 11 JRE (This is usually installed for you, however it is a good idea to have it installed in case your system does not support the version of Java automatically installed)

  • Git

System Requirements

  • 512 MB of RAM

  • At least 500MB of storage space

  • An internet connection

  • Some form of text editor

ZeoBot should automatically install its packages when you run it. This may take some time depending on the hardware specification of your computer.

Windows

  1. Install Git. Git is required in order to resolve and download dependencies. To test your installation, try running git on the command line.

  2. Ensure you have Python 3.10 installed and that it is the default version. To test, run py -Von the command line. If it reports that the Python version is at least 3.10, you are good to go.

4. Open a command prompt in the folder that ZeoBot is located in and run py -3.10 main.py.

Linux

  1. Install Python 3.10 as the system default. Most Linux distros ship with a different version of Python, so ensure python3 -V displays Python 3.10 as the version.

2. Install the following packages with your package manager, for example apt. You will most likely have some already installed. make ca-certificates build-essential git tar sqlite fontconfig tzdata python3.10-dev gcc g++ libffi-dev

3. Change directory to the folder that ZeoBot is located in and run python3 main.py. You can additionally use screen python3 main.py to run the bot in the background via screen.

On non-Debian based systems, some packages are named different.

On some Linux distributions, you may have to compile Python 3.10 from source. In this case, you will additionally need to install some additional packages:zlib1g-dev libffi-dev python3-dev lzma-dev libssl-dev liblzma-dev libsqlite3-dev

macOS

  1. Install Python 3.10 and ensure that it is the system default. Use python3 -V and make sure it displays Python 3.10 as the version.

  2. Install macOS Command Line Tools by opening a terminal and entering xcode-select --install.

  3. Open a terminal, change directory to the folder that ZeoBot is located in and run python3 main.py.

If you encounter a security block when running the bot, run this command from the installation folder: xattr -d com.apple.quarantine core/startup/*.so

Pterodactyl

Pterodactyl's TMPFS size has to be expanded. Most hosts automatically do this, however you may need to expand it if you run your own Pterodactyl instance.

  1. Open your Pterodactyl config.yml file, usually located at /etc/pterodactyl/config.yml with a text editor.

  2. Find the line tmpfs_size and set it to tmpfs_size: 1000.

  3. Save your changes and restart wings.

You will also need to change your music port depending on the port allocated to you. To find this, click Network at the top of the server page and look for the value above Port. Open ZeoBot's settings.yml file and find the port option under music_server. Replace the default value with the allocated port and save your changes.

There is an issue in Pterodactyl that causes the bot to be killed when you press the stop button. Instead stop the bot by entering stop in the console.

If you are still experiencing issues on Pterodactyl, make sure you are using the official Discord.py egg. Some third-party eggs do not install the required system packages.

Last updated