Windows Setup Guide


#1

Pre-requisites

PhantomBot requires:

  • Java 8
  • Windows 7 or higher OR Windows Server 2012 or higher
  • A Twitch account to run the bot on.

PhantomBot should work in any windows environment with standard Java, but for support purposes we require the above. We can not fully support Windows operating system before windows 7, nor can we fully support Java 7 or older.

This tutorial will walk you through most pre-requisites.

If you wish to watch a video that covers this guide, you can do that instead over here: https://www.youtube.com/watch?v=Hg_9oREiK-I

Installing Java

If you have the correct version of Java installed, you can skip this step.

https://www.java.com/en/download/

Use the above URL and go through the steps, this should install Java 8 fully for you.

To verify whether you have the correct Java installed, check the following page:

https://www.java.com/en/download/installed.jsp

As of 13 September 2016 this should show Version 8 Update 101.

Download PhantomBot

PhantomBot can be downloaded from https://phantombot.tv/#download. The stable version is what we suggest to use for normal use. The nightly is highly experimental, and the source is only interesting for developers. When you download the stable version you’ll get one file PhantomBot-x.x.zip (x.x will show the version number) which should be unzipped to the location you wish.

After unzip, the folder PhantomBot-x.x will contain the files you need to run PhantomBot.

Creating a Bot Account

If you have a bot account already, you can skip this step

To create an account for the bot you must create a new account at Twitch. You can do so by first logging out (if you are currently logged in). Afterwards use the following link to create a new account:

https://www.twitch.tv/signup

Getting the details required for initial startup

During the initial startup we need some details. These are:

  • Bot Account Name
  • Bot OAuth Token
  • Caster OAuth Token
  • Which channel to join.

You should know your bot account name already. So that should be easy. Next up is getting the Bot OAuth Token.

Bot OAuth Token

To get the Bot OAuth token, make sure you are logged in to twitch with the account you created for the bot This token allows the bot to connect to Twitch. When you’ve done that, go to the following url:

https://twitchapps.com/tmi

Click connect, then click authorize, and copy the code to a safe location. The code should look something like this:

oauth:123456789

Caster OAuth Token

To get the Caster OAuth token, make sure you are logged in to Twitch with your own account This token allows the bot to change your stream title and game, or pull other useful information. When you’re logged in, go to the following url:

https://phantombot.tv/oauth

Click connect, then click authorize, and copy the code to a safe location. The code should look something like this:

oauth:123456789

The channel to join

This is the channel that the bot will be active in. This is your username. So if your username is PeterPiper you should be using PeterPiper.

Custom Details for the Web Panel

During the initial startup it will ask for a username and password that will be used to log in to the web panel. Make sure you decide on these ahead of time.

Initial Startup

Now you have all the details (If you haven’t, follow the previous step), we can do the Initial Startup.
To start off you should have the folder PhantomBot-x.x open.

In this folder you’ll find several files, find launch.bat and double click it to start the Initial Startup.

After it has started, it will walk you through all the steps that require information that you got in the previous step. Do this now.

After going through all the steps, a whole lot of text will scroll by, and you should see the following:

botName ready!

[ERROR] BotName is not detected as a moderator

If you see [ERROR] BotName is not detected as a moderator, go to your channel and type /mod BotName (replace BotName with the name of the bot). Now close the window and re-open launch.bat. Now you should get botName ready!

Launching PhantomBot if you’ve closed it.

PhantomBot will always launch by opening launch.bat. Even after you’ve closed it.

Accessing the Web Panel

If you’re running PhantomBot locally, you can find the web panel at http://localhost:25000/panel.

If you’re running PhantomBot on a windows server or VPS, you’ll be able to access the web panel at http://domain_or_ip:25000/panel

To login, use the username and password you set during the initial startup.

What now?

From here on out you can check out the rest of the docs for help on how to run PhantomBot.
You can also find a full command list at https://phantombot.tv/commands.

Questions & Support

If you have any further questions, or something is not working, you can ask for help at our forum:

https://community.phantombot.tv/


Some kind of tutorial
Help I want to start using Phantom
I need help with the bot or download thing
Just Used the Phantombot last night and now it will not connect
!settitle and !setgame not working for Twitch
Ubuntu 16.04 LTS Setup Guide
CentOS 7 Setup Guide