Skip to content

About

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.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

 
 

Repository files navigation

PhantomBot

Java CI GitHub license GitHub release (latest SemVer)

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, TipeeeStream, StreamLabs and StreamElements!

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

System Requirements

  • Microsoft Windows
    • Windows 10 or 11; Windows Server 2019, 2022, or 2025 (64-bit, x64)
      • No additional requirements
    • Windows 10; Windows Server 2019 or 2022 (32-bit, x86)
  • macOS
    • macOS 12 (Monterey) or later (Intel or Apple silicon, 64-bit, x64)
      • No additional requirements
  • Linux
    • Any GCC-based Linux (Ubuntu, Debian, CentOS, etc)
      • Intel/AMD (64-bit, x64)
        • glibc 2.12 or later
      • ARM 64-bit (Raspberry Pi 4/5 with 64-bit enabled, etc)
        • glibc 2.17 or later
      • ARM 32-bit HF (Raspberry Pi 3, etc)
        • glibc 2.23 or later
    • Any musl-based Linux (Alpine, etc) equivilent to Alpine 3.5 or later (64-bit, x64)
  • Other OSes and Processors

Installation

Quick Start

  • Download the Latest Release for your platform
    • Please note that macOS on Apple Silicon should use the arm64-apple_silicon package
  • Extract the release to the installation location of your choice
  • Linux / macOS: Apply execute permissions to the launchers
    • Execute chmod +x launch.sh in a terminal
    • If you plan to setup the bot as a background service later, execute chmod +x launch-service.sh in a terminal
  • Launch the launcher script
    • Windows: Double-click, or execute from a terminal, launch.bat or launch.ps1
    • Linux / macOS: Execute ./launch.sh in a terminal
  • Open the bots web panel
    • Default URL when accessing locally is: http://localhost:25000
    • If accessing remotely, configure your firewall/port forwarding as needed to allow access to port 25000
    • It is normal for the browser to give a security warning, as we use self-signed SSL certificates by default
  • Click Bot Setup and OAuth
  • When the login page appears, look in your terminal window for the auto-generated username and password
  • Fill in the name of the Twitch channel to join
    • Optionally, also expand the Panel Login section and set a new username and password for the admin user
  • Click the floating Save Configuration button near the bottom-left to save the changes
  • Click the OAuth Setup link at the top of the page
  • Follow instructions to setup OAuth
    • Remember to perform both the Bot OAuth (Set user that the bot will post as) and the Broadcaster OAuth (Authorization for using the Twitch API)
  • Enjoy!
    • More documentation can be found in our guides
    • Support is available through our Discord
      • Please, no private DMs or @mentions (pings)

Closing / Shutting Down the Bot

To reduce risk of database corruption, please only close / shutdown the bot using the following methods

  • If running in a terminal from launch.bat, launch.ps1, or launch.sh
    • Type exit and then hit enter
    • Press CTRL+C
  • If running as a background service with launch-service.sh
    • Send the SIGTERM signal with kill PID
  • After starting the shutdown process, please wait for the Bot is Exiting message to appear

Installation Guides

More documentation for installation and setup is available in our guides

Docker

PhantomBot publishes official builds to Docker Hub and GitHub Container Registry

Upgrading PhantomBot

Detailed upgrade instructions are listed on our documentation.

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.

License

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

About

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.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages