Settings for botlogin.txt


#1

The following are the settings in botlogin.txt and what they configure within PhantomBot. All settings are configured as follows:

configuration_item=value


Note that as of PhantomBot 2.3.4.2 the Java Properties engine is used to manage the botlogin.txt configuration file. A couple of commented out lines will be noticed as well as that all colons are escaped (\:). Note that when data is placed into the file that colons need not be escaped, this is performed automatically by the properties engine.

apioauth

This is the API OAuth key from Twitch that allows your copy of PhantomBot to perform operations on your behalf such as update the title, update the game, and allows for the host detection to operate.

baseport

This is the starting port that PhantomBot uses for the various services that it provides.

channel

This is the Twitch channel to which PhantomBot will log into.

clientid

This is the Twitch Client ID that belongs to PhantomBot, you may acquire your own Client ID from Twitch and utilize that instead. This is typically blank or not set and is set to a default value within PhantomBot.

datastore

This configures the data storage type. By default SQLite3 is used. The following options are available: inistore which indicates to use a text based on-disk system. mysqlstore which indicates that MySQL should be used and will require the MySQL configuration to be defined.

datastoreconfig

This points to a file on disk which configures the different data store types. For the inistore, a single line in the file contains an alternate folder under the PhantomBot folder to create and store files. For the default storage type of SQLite3, the following directives are allowed in the file:

dbname - Specifies the name of the database to use.
cachesize - Specifies the size of the cache to use.
safewrite - Specify true or false, true enables safe writes. Disabling is not recommended.
journal - Specify true or false, true enables journaling. Disabling is not recommended.

discord_token

The token obtained from Discord to allow PhantomBot to interact with a Discord server.

gamewispauth

This is the authorization token obtained from the PhantomBot website to authenticate with GameWisp.

gamewisprefresh

This is the authorization refresh token obtained from the PhantomBot website to authenticate with GameWisp.

httpsFileName

Specifies the filename of the HTTPS server certificate file.

httpsPassword

Specifies the password used to unlock the HTTPS server certificate.

logtimezone

After the initial startup, this specifies a timezone to use for logging purposes. Please read the Wikipedia List of TZ Database Time Zones article for allowed timezones.

msglimit30

The number of messages to allow to be sent to Twitch within a 30 second period. The default of 18.75 works to ensure that if your PhantomBot instance is ever removed as a moderator, that it does not produce too many messages and is globally banned. The highest allowed value is 80.0. Please note that if the account has moderator status removed and goes over the 20 messages in 30 seconds limit of Twitch because of that and the msglimit30 value was raised, that the development team cannot be held responsible.

musicenable

A true/false setting to enable the YouTube Player web interface and the required websocket server for communication.

mysqlhost

The hostname of the host that is running MySQL.

mysqlname

The name of the database for PhantomBot.

mysqlpass

The password for the MySQL user which owns the PhantomBot database.

mysqlport

If the port which MySQL runs on is not the default port, specify that with this setting.

mysqluser

The name of the user to use to access MySQL and the PhantomBot database.

oauth

The OAuth key from Twitch which allows your PhantomBot instance to login as your created PhantomBot account into Twitch IRC chat.

owner

The name of the owner of the PhantomBot instance. Should typically be the broadcaster.

panelpassword

The password used to access the Control Panel and YouTube Player.

paneluser

The user used to access the Control Panel and YouTube Player.

streamtipid

The authorization key provided by PhantomBot to authenticate with StreamTip.

streamtipkey

The authorization key provided by PhantomBot to authenticate with StreamTip.

streamtiplimit

The maximum number of donations to query at one time. It is suggested to keep this low.

twitchalertskey

The authorization key provided by PhantomBot to authenticate with StreamLabs, previously TwitchAlerts.

twitchalertslimit

The maximum number of donations to query at one time. It is suggested to keep this low.

twitterUser

The name of your Twitter account.

twitter_access_token

The authorization key provided by Twitter to authenticate with Twitter.

twitter_consumer_key

The authorization key provided by Twitter to authenticate with Twitter.

twitter_consumer_secret

The authorization key provided by Twitter to authenticate with Twitter.

twitter_secret_token

The authorization key provided by Twitter to authenticate with Twitter.

usehttps

Have PhantomBot start an internal HTTPS server rather than an HTTP server. This requires a certificate and for the httpsFileName and httpsPassword to be configured properly.

user

The name of your PhantomBot instance.

webauth

An internally generated key used to protect the WebSocket server.

webauthro

An internally generated key used to protect the WebSocket server.

webenable

A true/false setting to enable or disable the PhantomBot web server.

whisperlimit60

The number of whispers allowed in 60 seconds. Note that at present time, this setting is not used.

youtubekey

An optional key from YouTube to authenticate with their API. PhantomBot provides one internally, but a user may obtain their own and use it.

ytauth

An internally generated key used to protect the WebSocket server.

ytauthro

An internally generated key used to protect the WebSocket server.

devcommands

By default developer commands are enabled to help live debug with users. You can disable this by simply adding devcommands=false in your botlogin.txt file.

twitch_tcp_nodelay

By default this is set to true, it allows the bot to sends messages to Twitch faster, but it uses a bit more bandwidth.

usemessagequeue

By default this is true, setting it to false will disable the delay between messages. Note that the bot can still only sends 19 messages in 30 seconds.


!settitle and !setgame not working for Twitch
Just Used the Phantombot last night and now it will not connect
Subcount on for affiliates?
Twitch Channel Connection Issue
Disabling phantom bot
OAUTH errors for days