Skip to content

Frequently Asked Questions

EverOddish edited this page Sep 25, 2022 · 29 revisions

Frequently Asked Questions

How do I open the DrFujiBot web dashboard?

The installer should place an entry in the Start Menu for DrFujiBot, which you can click to open the web dashboard. If for some reason you can't find the shortcut, you can open your favourite web browser and navigate to http://localhost:41945/admin/

What is the username and password for the admin site? Can anyone else access it?

The username and password are "admin" and "admin". Anyone who has access to your computer can use the admin site, if they know this password. At this time, you cannot change the username and password. If there is demand for access control with a custom password, it can be added later.

Is there a list of commands?

Yes, you can look at the Command Documentation or go to the main admin page, then click Commands. You can filter built-in commands or custom commands to make it easier to distinguish the two by choosing a filter on the right.

Is Generation 8 (Pokemon Sword & Pokemon Shield) supported?

Yes! (including the Isle of Armor expansion)

Is there a National Dex mode to query data without worrying about which game a Pokemon appears in?

Yes! Execute the command "!setgame national dex" or change the Current Game in the Settings page on the dashboard.

Which ROM hacks are supported?

Currently, the following ROM hacks are supported:

  • Blaze Black/Volt White by Drayano
  • Blaze Black 2/Volt White 2 by Drayano
  • Blaze Black 2 Redux/Volt White 2 Redux by AphexCubed
  • Renegade Platinum by Drayano
  • Emerald Kaizo by SinisterHoodedFigure
  • Crystal Kaizo+ by luapmail and toxicenduser

Why isn't the bot working in Twitch chat?

Did you authorize your Twitch account properly during installation? If not, the main admin page has a link to re-authorize your Twitch account.

Is the "IRC Service" setting in the admin site set to "Running"? From the main admin page, click Settings, then IRC Service and change it to "Running" if needed, then click Save.

Are the services running as expected? Open the Start Menu, search "Services" then scroll through the list to see if "DrFujiBot Apache" and "DrFujiBot Twitch" are both running.

If there are still problems, try re-authorizing Twitch from the main dashboard page, or stop and start the IRC Service in Settings.

Why aren't specific commands working?

Many commands are disabled by default. To change command permissions, from the main admin page, click Commands, then select which commands you would like to change, and open the drop-down menu to choose a permission level, then click Go.

A warning is displayed for commands that are enabled but fail a permissions check. A warning is not displayed for commands that are disabled, as they may conflict with commands from other bots and should not cause spam.

How do I define a custom command, timed message or command alias through the web interface?

See the Quick Start Guide for an explanation of how each object works.

Does the bot run all the time?

Both DrFujiBot services will start automatically when your computer starts, unless the IRC Service is set to Stopped in the settings. Both services will run as long as your computer is turned on and doesn't go to sleep.

What if I want to stop the bot from running?

To stop the IRC service, navigate to the main admin page, click Settings, then IRC Service and change it to "Stopped", then click Save. To re-enable the bot, change the setting to "Running" and click Save. If you no longer want the bot on your computer, you may uninstall it as you would any other Windows program (through the Programs window and the Uninstall button).

How do you ensure no one else can use the bot in my Twitch channel?

The bot needs to be authorized through your signed-in Twitch account. It will not run in a Twitch channel unless you authorize it, and you can only authorize for Twitch accounts to which you have access.

What if I don't want to use the bot in a Twitch channel?

You can still use the bot locally on your computer. During installation, just skip the Twitch authorization by closing the web browser. From the main admin page, click the link to the DrFujiBot web console. The bot will behave exactly the same in the browser-based command line.

Is the bot secure? Will it harm my computer?

While the bot runs through a local web server, it will not be publicly available to anyone. The bot specifically only handles requests from the local machine, and is not visible to the wider Internet. The IRC component will relay commands from Twitch chat to the web server, but only as permissions allow. As long as you have your command permissions set properly, no users in Twitch chat will be able to corrupt any settings if they aren't supposed to.

The installer is not signed, so Windows will display a warning before installation. All the installer code is available in this GitHub repository, so you can look through it yourself to see that it doesn't do anything malicious. I promise that what you see in GitHub is what you get in the installer.

Does the bot record data or use a server?

The bot does store a short history of Twitch chat messages (the past five minutes) for the purpose of banning phrases or calculating respects. You must inform your viewers that this occurs, in order to comply with all local and international privacy laws. Chat history is automatically pruned and purged every five minutes. The bot does not use any server other than the official Twitch IRC servers for chat communication.

Can I back up my database and settings?

DrFujiBot will automatically back up your database once per week to the following folder:

C:\Users\<username>\AppData\Local\Programs\DrFujiBot_Backup

If you would like to manually back up your database, you may copy the following file to any other location:

C:\Users\<username>\AppData\Local\Programs\DrFujiBot_Django\db.sqlite3

What happens to my settings if I install a new version of DrFujiBot?

The DrFujiBot installer will automatically make a copy of your current database at the time of installation, install the new version of DrFujiBot, then copy the database back to its proper location, and update it if necessary. This should result in a seamless transition of your settings from the old version to the new version with no extra work on your part.

Something went horribly wrong and I need to restore an older database. Is this possible?

Open the Start Menu, search "Services" then scroll through the list. Find the "DrFujiBot Apache" and "DrFujiBot IRC" services, right click each one, and then Stop.

Copy the backup database to the expected path (could be slightly different than below):

C:\Users\<username>\AppData\Local\Programs\DrFujiBot\DrFujiBot_Django\db.sqlite3

Go back to the Services window, right click both DrFujiBot services and then Start.

I had the Services window open during installation, or the services won't start/stop. How do I fix this?

Contact @EverOddish on Twitter for a special tool that will remove the stuck services, then you can re-attempt installation.

Will DrFujiBot work on any platforms other than Windows?

The Windows installer is meant to make the bot as easy to run as possible. However, because the bot is written in Python, it can run on Linux and macOS as well. Using a non-Windows platform will require some extra steps. Contact EverOddish for help.

What do I do if my anti-virus prevents the bot from working?

You can try Google searching for steps on how to allow specific programs for your anti-virus. Aside from that, there isn't much I can do to make the bot work with every anti-virus on the market. Anti-virus software is designed to prevent other software from running, so there usually isn't anything that I can do to help.

I'm reformatting my computer. How do I back up my database?

Copy this file to a USB memory stick or somewhere else:

C:\Users\<username>\AppData\Local\Programs\DrFujiBot\DrFujiBot_Django\db.sqlite3

(Your path may be slightly different, if you chose a non-default install location.)

Once you've reformatted your computer, restore that file to the same location, then run the latest DrFujiBot installer.

Clone this wiki locally