Egg Repository

Pterodactyl Community Egg Repository

Ree6

All-in-one, open source and 100% free Discord Bot!

Read Me

Ree6


Authors / Contributors


Presti

💻 🤖

parkervcp

💻 🥚

QuintenQVD0

💻

Bot Description & Features

From the developer's Github:

Ree6 is an all-in-one Discord Bot maintained by Presti, which started as an alternative of Mee6 to provide a lot of features that are hidden behind a paywall or subscription.

  • Contains almost every feature Mee6 has.
  • Has a open Source Webinterface.
  • Provides advanced Audit-Logging.
  • Has built in post notifications (Twitter, Instagram, YouTube, Reddit and Twitch).
  • Built-in simple Ticket System.
  • And more!

Configuration

  • You will need to modify the config.yml to even start the bot.

Server Ports

There are no ports required for Ree6.


Updating

Re-Installing the server via the panel will do the following:

  1. Update the bot to the latest version.

API keys

This bot uses a lot of api keys. It will print some errors to the console if you don't have some filled in but the bot should still function as normal with the api keys you entered.

Yolks
NameTag
Java_17ghcr.io/pterodactyl/yolks:java_17
Variables and Startup

Startup Command

java -Dnogui=true -jar Ree6.jar

Variables

[REQUIRED] Discord Bot Token

The token for your Discord bot. Learn how to obtain a token and configure your bot application properly here: https://jmusicbot.com/getting-a-bot-token/

Environment Variable: BOT_TOKEN
Default Value:
User Viewable:✅
User Editable:✅
Dagpi token

Your Dagpi.xyz API-Token, for tweet image generation!

Environment Variable: DAGPI_TOKEN
Default Value:
User Viewable:✅
User Editable:✅
Sentry DSN

Your Sentry DSN, for error reporting!

Environment Variable: SENTRY_DSN
Default Value:
User Viewable:✅
User Editable:✅
Spotify Client Id

Spotify Application Configuration, used to parse Spotify Tracks/Playlists to YouTube search queries.

Environment Variable: SPOTIFY_CLIENT_ID
Default Value:
User Viewable:✅
User Editable:✅
Spotify Client Secret

Spotify Application Configuration, used to parse Spotify Tracks/Playlists to YouTube search queries.

Environment Variable: SPOTIFY_CLIENT_SECRET
Default Value:
User Viewable:✅
User Editable:✅
Heartbeat Url

The URL to the Heartbeat-Server

Environment Variable: HEARTBEAT_URL
Default Value: none
User Viewable:✅
User Editable:✅
Heartbeat Interval

The interval between the heartbeats.

Environment Variable: HEARTBEAT_INTERVAL
Default Value: 60
User Viewable:✅
User Editable:✅
Amari Token

Your Amari API-Token, for Amari Level imports!

Environment Variable: AMARI_TOKEN
Default Value:
User Viewable:✅
User Editable:✅
Twitch Client Id

Twitch Application Configuration, used for the StreamTools and Twitch Notifications.

Environment Variable: TWITCH_CLIENT_ID
Default Value:
User Viewable:✅
User Editable:✅
Twitch Client Secret

Twitch Application Configuration, used for the StreamTools and Twitch Notifications.

Environment Variable: TWITCH_CLIENT_SECRET
Default Value:
User Viewable:✅
User Editable:✅
Twitter Bearer Key

Twitter Application Configuration, used for the Twitter Notifications.

Environment Variable: TWITTER_BEARER
Default Value:
User Viewable:✅
User Editable:✅
Reddit Client Id

Reddit Application Configuration, used for the Reddit Notification.

Environment Variable: REDDIT_CLIENT_ID
Default Value:
User Viewable:✅
User Editable:✅
Reddit Client Secret

Reddit Application Configuration, used for the Reddit Notification.

Environment Variable: REDDIT_CLIENT_SECRET
Default Value:
User Viewable:✅
User Editable:✅
Instagram Username

Instagram Application Configuration, used for the Instagram Notification.

Environment Variable: INSTAGRAM_USERNAME
Default Value:
User Viewable:✅
User Editable:✅
Instagram Password

Instagram Application Configuration, used for the Instagram Notification.

Environment Variable: INSTAGRAM_PASSWORD
Default Value:
User Viewable:✅
User Editable:✅
SQL Username

Username for the SQL connection.

Environment Variable: DATABASE_USER
Default Value: root
User Viewable:✅
User Editable:✅
SQL Database

Database for the SQL Connection

Environment Variable: DATABASE_DB
Default Value: root
User Viewable:✅
User Editable:✅
SQL Password

Password for the SQL connection.

Environment Variable: DATABASE_PW
Default Value:
User Viewable:✅
User Editable:✅
SQL Port

Port for the SQL connection.

Environment Variable: DATABASE_PORT
Default Value: 3306
User Viewable:✅
User Editable:✅
Database Typ

The Typ of the Database Ree6 should use! Possible typs: - mariadb - sqlite - h2 - postgres

Environment Variable: DATABASE_TYP
Default Value: sqlite
User Viewable:✅
User Editable:✅
Database Storagefile

The location of the storagefile if sqlite is being used.

Environment Variable: DATABASE_FILE
Default Value: storage/Ree6.db
User Viewable:✅
User Editable:✅
[DEVELOPER-STUFF] Database Poolsize

The Database connection pool size!

Environment Variable: DATABASE_POOL
Default Value: 10
User Viewable:✅
User Editable:✅
Database host

The Host address of the Database connection.

Environment Variable: DATABASE_HOST
Default Value: localhost
User Viewable:✅
User Editable:✅
OpenAI Token

Your Authentication token that should be used in the AI API calls.

Environment Variable: AI_TOKEN
Default Value: OpenAI API-Token
User Viewable:✅
User Editable:✅
OpenAI Url

The URL that should receive the API calls.

Environment Variable: AI_URL
Default Value: https://api.openai.com/v1/chat/completions
User Viewable:✅
User Editable:✅
OpenAI Model

The AI model that should be used in the API calls.

Environment Variable: AI_MODEL
Default Value: gpt-3.5-turbo-0301
User Viewable:✅
User Editable:✅
Activity Status

The Activity status of the Bot that will be shown.

Environment Variable: MISC_STATUS
Default Value: ree6.de | %guilds% Servers. (%shard%)
User Viewable:✅
User Editable:✅
Feedback Channel

The Channel Id of the Feedback channel.

Environment Variable: MISC_FEEDBACK
Default Value: 0
User Viewable:✅
User Editable:✅
[DEVELOPER-STUFF] Bot Owner Id

The ID of the Bot Owner, this will be used internally on some checks.

Environment Variable: MISC_OWNER
Default Value: 321580743488831490
User Viewable:✅
User Editable:✅
Invite Link

The Invite link to invite the Bot.

Environment Variable: MISC_INVITE
Default Value: https://invite.ree6.de
User Viewable:✅
User Editable:✅
Predefined Information for AI

The Information for the AI.

Environment Variable: MISC_PREDEF
Default Value: You are Ree6 a Discord bot.
User Viewable:✅
User Editable:✅
Support Link

The Url link for users to receive support.

Environment Variable: MISC_SUPPORT
Default Value: https://support.ree6.de
User Viewable:✅
User Editable:✅
Website

The Url to the Website of the Bot.

Environment Variable: MISC_WEB
Default Value: https://ree6.de
User Viewable:✅
User Editable:✅
Webinterface

The Url to the Webinterface.

Environment Variable: MISC_INTERFACE
Default Value: https://cp.ree6.de
User Viewable:✅
User Editable:✅
Record Url

The Url that uses can access to get their recording.

Environment Variable: MISC_RECORD
Default Value: https://cp.ree6.de/external/recording
User Viewable:✅
User Editable:✅
Twitch Url

The Url used to connect a Twitch Account with the Ree6 System.

Environment Variable: MISC_TWITCH
Default Value: https://cp.ree6.de/external/twitch
User Viewable:✅
User Editable:✅
Advertisment

The Advertisement in Embed Footers and the rest.

Environment Variable: MISC_ADV
Default Value: powered by Tube-hosting
User Viewable:✅
User Editable:✅
Name

The Name of the Bot.

Environment Variable: MISC_NAME
Default Value: Ree6
User Viewable:✅
User Editable:✅
Shards

The amount of shards that should be created.

Environment Variable: MISC_SHARD
Default Value: 1
User Viewable:✅
User Editable:✅
Install Script
#!/bin/bash
## this is a simple script to use the github API for release versions.
## this requires the egg has a variable for GITHUB_PACKAGE and VERSION
## this supports using oauth/personal access tokens via GITHUB_USER and GITHUB_OAUTH_TOKEN (both are required.)
## if you are getting hit with GitHub API limit issues then you need to have the user and token set.
apt update
apt install -y jq curl


CONFIG_LINK="https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/ree6/config.yml"
LATEST_JSON=$(curl --silent "https://api.github.com/repos/Ree6-Applications/Ree6/releases/latest")
RELEASES=$(curl --silent "https://api.github.com/repos/Ree6-Applications/Ree6/releases")
MATCH=jar-with-dependencies.jar


if [ -z "${VERSION}" ] || [ "${VERSION}" == "latest" ]; then
    DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i "${MATCH}" | head -1 )
else
    VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION "${VERSION}" '.[] | select(.tag_name==$VERSION) | .tag_name')
    if [ "${VERSION}" == "${VERSION_CHECK}" ]; then
        DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION "${VERSION}" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i "${MATCH}" | head -1)
    else
        echo -e "defaulting to latest release"
        DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i *.jar)
    fi
fi

## Ree6 Setup
[ ! -d /mnt/server ] && mkdir -p /mnt/server

if [ ! -z "${DOWNLOAD_URL}" ]; then 
    if curl --output /dev/null --silent --head --fail ${DOWNLOAD_URL}; then
        echo -e "link is valid. setting download link to ${DOWNLOAD_URL}"
        DOWNLOAD_LINK=${DOWNLOAD_URL}
    else        
        echo -e "link is invalid closing out"
        exit 2
    fi
fi

cd /mnt/server
echo -e "\nInstalling/Updating Ree6...\n"

if [ -f Ree6.jar ]; then
    echo -e "Updating Ree6.jar to latest version..."
    echo -e '\t(Old version can be found at "Ree6.jar-old")'
    mv -f Ree6.jar Ree6.jar-old
fi

echo -e "Running: curl -sSL -o Ree6.jar ${DOWNLOAD_LINK}\n"
curl -sSL -o  Ree6.jar ${DOWNLOAD_LINK}

if [ -f config.yml ]; then
    echo -e "Updating config.yml to latest version..."
    echo -e '\t(Old version can be found at "config.yml-old")'
    mv -f config.yml config.yml-old
fi

echo -e "Running: curl -sSL -o config.yml ${CONFIG_LINK}\n"
curl -sSL -o config.yml ${CONFIG_LINK}
    

echo -e "\nRee6 Successfully Installed!"
Installation Imageghcr.io/ptero-eggs/installers:debianInstallation Entrypointbash