The PhantomBot Control Panel aims to ease the administration and configuration of PhantomBot for users. It is meant to be used as a single-user panel, only providing one login and has been optimized for a single-user experience.
The Control Panel has been tested under Google Chrome. While the Panel should operate under other web browsers, it is only formally supported in Google Chrome.
If PhantomBot is being hosted on a remote server and not locally, there is a good possibility that firewalls will need to be opened on the remote server. Assuming that the default ports are used in PhantomBot, the following ports must be opened:
TCP Port Purpose
25000 Used by the PhantomBot Web Server
25003 Used by the PhantomBot YouTubeSocketServer for the YouTube Player
25004 Used by the PhantomBot WebSocketServer for the Control Panel
Please consult the documentation for your operating system for directions on how to open firewalls. Note that some service providers also provide a firewall in front of a server and there may need to be adjustments made there as well.
By default, the following accounts are created, however, you are prompted during the configuration of PhantomBot to provide new values. Use those if you changed the default values.
The YouTube Player uses the same credentials.
If you forget your credentials, please review
botlogin.txt and look for the values assigned to paneluser and panelpassword.
Connecting to the Control Panel
Connect to the URL from which PhantomBot is hosted, for most users this will be localhost. If PhantomBot is hosted on a remote server, use the IP address or hostname of that server. Assuming the default port is being used, the following URL is used to connect locally, replace localhost with the remote IP or hostname if applicable:
You will be prompted for the credentials mentioned in the Login Accounts section.
The Control Panel is organized into vertical tabs which are presented on the left side of the interface. There are accordions on the right side which allow for different configuration options and the ability to execute some commands.
Delay in Information in Control Panel
Note that some information may be delayed for up to two minutes within the Control Panel. The Control Panel generally queries the database every 30 seconds to reduce the load on PhantomBot.
If the Control Panel detects that a module is disabled that is required to drive a section, it will alert the user to this. Enable the module to enable the section on the Control Panel.
The following tabs are available for navigation, along with what is contained within those tabs.
Contains the high-level configuration for PhantomBot and information about the current stream.
Manage custom commands, aliases, costs, permissions and cooldowns.
Manage moderation for Twitch chat.
Manage time-based configuration options and modify user times.
Manage points-based configuration options and modify user points.
Manages the data of users in PhantomBot and allows their data to be viewed.
Manage the time-based rank system.
Manage alerts such as greetings, follows, donations, subscriptions, and bits.
View donations made.
Manage notices, timed messages that are sent to chat.
Manage keywords, which provide responses to words or phrases in chat.
Open and close a poll and view the last results.
Hosts & Raids
Perform a host/raid on a channel, manage host settings, view host history, configure raid settings and view historical raid information.
Manage auctions, raffles, and ticket raffles.
Manage the configuration for games.
Manage the queue feature.
Post a tweet, configure polling and posting options for Twitter and configure rewards for retweets.
Manage Discord configuration. Contains custom commands, keywords, games, moderation log, donation alerts, greetings, follower alerts, host alerts, subscriber alerts, and Twitter alerts.
Manage and play Audio Hooks and configure some options for the YouTube Player.
Shows the version of the Control Panel, of other software used, and provides support links.