PhantomBot is a Twitch chat bot powered by Java. PhantomBot has many modern features out of the box such as a built-in webpanel, enhanced moderation, games, a point system, raffles, custom commands, a music player, and more. PhantomBot can also be integrated with many services such as Discord, Twitter, TipeeeStream, StreamLabs and StreamElements!

Additional functionality is enabled through the use of third-party modules.

• Get PhantomBot
• Security Policy

How can I follow along/contribute?

• Feel free to check out our Version History.
• If you are a developer, feel free to check out the source and submit pull requests. We provide a guide to setup your development environment.
• Please don't forget to watch, and star our repo!
• A huge thanks goes out to the people who have already contributed to the project.

Requirements

PhantomBot requires the following software to be installed:

ARM (Raspberry Pi) or x86 (32-bit) architectures

• Adoptium Temurin 11 or OpenJDK 11

x86_64 (64-bit) architectures

• No pre-requisites

Installation

Please refer to platform-specific installation documentation.

• Windows
• Linux:
  • Ubuntu 16.04
  • CentOS 7
• macOS

Docker

PhantomBot publishes official builds to Docker Hub and GitHub Container Registry

• DockerHub
• GHCR
• Docker Compose File

Upgrading PhantomBot

Detailed upgrade instructions are listed on our documentation.

License

PhantomBot is licensed under the GNU General Public License v3 (GPL-3).

Rollbar Exception Reporting

ℹ️ Notice: As of Phantombot Nightly Build 49687f9 (July 4, 2021) and PhantomBot v3.5.0, we now use Rollbar to automatically report exceptions to the dev team.

OAuth tokens, Client IDs, and API Secrets are NOT sent. All information is kept private.

Data is only sent when an exception occurs. Some very common, safe to ignore, exceptions are not sent, such as the ones that occur when shutting down the bot while an active panel connection exists.

Exceptions are sent through a server owned by @gmt2001 for additional filtering before continuing on to Rollbar. No data is saved on this server beyond normal logs used for DDOS mitigation. These logs may include IP addresses and are deleted after 5 weeks. IP addresses are NOT sent on to Rollbar.

The following values are sent from botlogin.txt:

• allownonascii - Indicates if other config values in botlogin.txt are allowed to use non-US-ASCII characters
• baseport - Indicates the port that the built-in webserver listens on
• channel - Indicates the Broadcaster's channel, where the bot interacts with Twitch viewers
• datastore - Indicates which database backend is used
• debugon - Indicates whether debug messages are printed to the console and logged
• debuglog - Overrides the above to only log, but not print to console
• helixdebug - Enables additional debug logging of Twitch Helix API requests and responses (Not including OAuth tokens)
• ircdebug - Enables additional debug logging of incoming messages from Twitch Message Interface (TMI/IRC)
• logtimezone - Indicates the timezone used by the bot
• msglimit30 - Indicates the self-imposed rate-limit on outgoing messages to TMI
• musicenable - Indicates whether the YouTube player has been enabled at the botlogin.txt level
• owner - Indicates the bot owner (used for giving a non-broadcaster bot owner admin privileges)
• proxybypasshttps - Overrides the SSL checks in the bot to pretend SSL is enabled, for use with a reverse proxy
• reactordebug - Enables very verbose debug output to console from the Netty backend (Helix and Discord API)
• reloadscripts - Indicates whether the bot is allowed to reload most JavaScript files when they are changed without a restart
• rhinodebugger - Enables verbose debug output when JavaScript exceptions occur
• rollbarid - A GUIDv4 which uniquely identifies the current PhantomBot installation, used for identifying when multiple exceptions are coming from the same bot
• twitch_tcp_nodelay - The TCP_NODELAY flag for TMI. Makes TMI less bandwidth efficient but possibly a little faster on outbound messages
• usehttps - Indicates whether SSL is enabled on the bots built-in webserver
• user - The bots Twitch username
• useeventsub - Indicates if EventSub is enabled
• userollbar - Indicates if Rollbar exception reporting is enabled
• webenable - Indicates if the bots built-in webserver is enabled
• whisperlimit60 - Indicates the self-imposed rate-limit on outgoing whispers to TMI
• wsdebug - Enables debug output of WebSocket messages from the panel

For all other values in botlogin.txt, only an indicator of whether the value exists will be sent, but not the actual value itself.

The other data sent includes:

• java.home - Indicates where Java is installed
• java.specification.name - Indicates the specification of the Java Runtime Environment the Java installation adheres to
• java.specification.vendor - Indicates the vendor of the above specification
• java.specification.version - Indicates the version of the above specification
• java.vendor - Indicates the vendor of the actual Java installation
• java.version - Indicates the actual version of the Java installation
• os.arch - Indicates 32-bit or 64-bit operating system
• os.name - Indicates the name of the operating system
• os.version - Indicates the version of the operating system
• The current state of debugon, even if set from the console
• The current state of debuglog, even if set from the console
• A boolean indicator of whether the OAuth is logged in as the Bot (but not the actual OAuth token)
• A boolean indicator of whether the API OAuth is logged in as the Broadcaster (but not the actual OAuth token)
• The full stack trace of the exception

To opt out of Rollbar exception reporting, add the following line to the botlogin.txt:

userollbar=false

Docker users can opt out using the above method, or by adding the following environment variable to the container:

PHANTOMBOT_USEROLLBAR=false

for docker-compose.yml

PHANTOMBOT_USEROLLBAR: "false"

You must restart the bot after putting the opt-out for the change to take effect. Editing a Docker container or docker-compose may require more steps to apply the changes, consult your manual.

If you believe your data has already been sent and want to issue a GDPR delete request, please opt out as above and then send your bot name, broadcaster name, and the rollbarid from botlogin.txt to: gdpr /A\T/ phantombot // hopto \ org

We also accept requests for copies of your data. GDPR requests are accepted from all users, even those who do not live in a locale that has such laws.

Please note that the IP addresses in the DDOS logs can not be retrieved or deleted manually, but will be automatically deleted after 5 weeks by log rotation.