Egg Repository

Pterodactyl Community Egg Repository

PhantomBot

PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers.

Read Me

PhantomBot

Website GitHub PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers.

Server Ports

1 port is required to run PhantomBot.

Port default
Web UI (HTTP Server) 25000
Yolks
NameTag
Java 16 [DEPRECATED]ghcr.io/ptero-eggs/yolks:java_16
Java 19ghcr.io/ptero-eggs/yolks:java_19
Variables
NameDescriptionEnvironment VariableDefault ValueUser ViewableUser Editable
Versionlatest = Latest Stable master = latest Github 3.9.0.7 = Latest known working with Java 16RELEASE_VERSIONlatestYesYes
Twitch Channel NameEnter the Twitch channel name where the bot will connect toCHANNEL_NAMEYesYes
Channel OwnerCHANNEL_OWNERYesYes
Bot Twitch UsernamePlease enter the bot's Twitch usernameBOT_TWITCH_USERNAMEYesYes
Webpanel UsernamePlease enter a custom username for the web panelWEBPANEL_USERNAMEYesYes
Webpanel PasswordPlease enter a custom password for the web panelWEBPANEL_PASSWORDYesYes
Youtube API Keyhttps://phantombot.dev/guides/#guide=content/integrations/youtubesetupYOUTUBE_API_KEYYesYes
Discord Bot Tokenhttps://phantombot.dev/guides/#guide=content/integrations/discordintegrationsetupDISCORD_BOT_TOKENYesYes
Install Script
#!/bin/bash
# PhantomBot Installation Script
#
# Server Files: /mnt/server
apt update
apt -y --no-install-recommends install curl wget ca-certificates unzip

cd /tmp

# Fetching latest github release
if [ -z "${RELEASE_VERSION}" ] || [ "${RELEASE_VERSION}" == "master" ]; then
        echo -e "Using latest Github Master version"
        DOWNLOAD_URL=https://raw.githubusercontent.com/PhantomBot/nightly-build/master/PhantomBot-nightly-lin.zip
else
    if [ -z "${RELEASE_VERSION}" ] || [ "${RELEASE_VERSION}" == "latest" ]; then
        echo -e "Using latest release version"
        RELEASE_VERSION=$(curl -s "https://api.github.com/repos/PhantomBot/PhantomBot/releases/latest" | grep -e '"tag_name"' | sed -E 's/.*"([^"]+)".*/\1/' | sed 's/^.//')
    fi
    DOWNLOAD_URL=https://github.com/PhantomBot/PhantomBot/releases/download/v${RELEASE_VERSION}/PhantomBot-${RELEASE_VERSION}-lin.zip
    echo -e "${DOWNLOAD_URL}"
fi

# Download files
cd /mnt/server
wget ${DOWNLOAD_URL} -O PhantomBot.zip

# Unzip files and delete the archive
unzip -o PhantomBot.zip
rm PhantomBot.zip

# Move unzipped files into the server folder and delete the folder 
cp -f -r ./PhantomBot-*/* /mnt/server/
rm -rf PhantomBot-*/

# Creating default config
if [ ! -f /mnt/server/config/botlogin.txt ]; then
    echo -e "Creating config/botlogin.txt"
    cat << EOF > /mnt/server/config/botlogin.txt
    #PhantomBot Configuration File
    #
    # Here is a list wiht all config values:
    # https://community.phantom.bot/t/settings-for-botlogin-txt/78
    #
    apioauth=
    baseport=
    channel=
    oauth=
    owner=
    panelpassword=
    paneluser=
    user=
    youtubekey=
    discord_token=
EOF
fi
echo "install finished"