Skip to content
This repository has been archived by the owner on Nov 2, 2019. It is now read-only.

EverOddish/OpenFuji

Repository files navigation

DEPRECATED

This repository has been deprecated. Please see https://github.com/EverOddish/DrFujiBot for the new re-write of this project.

OpenFuji

This repository contains the software that runs the DrFujiBot Twitch chat bot. This chat bot provides Pokemon information, such as stats, moves, learn sets, evolution, type matchups, and more. The bot also supports custom commands, and various other silly features. It can also be run as a Discord bot. The bot is written in Python, and is meant to be run from a Linux server. All Pokemon information is pulled from a local PokeAPI instance.

The code was started as a simple, fun project, and grew over time as more ideas were added. Because of this approach, no planning or design was put into the initial code. As such, the code grew messy and harder to read. If you plan to work on the project, keep that thought in mind.

To view the re-write of this bot (which is a work in progress), look up MrFujiBot. MrFujiBot is a client-focused Windows application, written in C# and meant to be run locally by a streamer on their computer. Ideally, it will provide all the same features as DrFujiBot.

Despite plans for a re-write, OpenFuji is still in use by dozens of Twitch streamers, and continues to be maintained and improved.

Several specific configuration values are missing from this repository (such as API keys, etc.) so that the DrFujiBot Twitch account remains protected. If you supply your own values for your own Twitch account, you may run the bot locally on your machine.

Developing

Before starting:

  1. Make sure you are running on python >=3.5.2 but < python3.6 and you have sqlite3 installed
  2. If you want to test the bot in your own twitch chat, follow this guide: https://dev.twitch.tv/docs/authentication/#registration

Setting up the bot

  1. Install dependencies
pip install -r requirements.txt
  1. Create a streamer config (use SampleStreamer.json as a template)

  2. Create the necessary meta files (these can be empty, but .json files must be valid JSON)

  • PCCE.json
  • bee.txt
  • shaq.txt
  • whisper_users.json
  • DrFujiBot_config.json:
  1. Fill in DrFujiBot_config.json with you bot user's info:

    • "twitch_oauth_token": "" // oauth token from twitch
    • "twitch_username": ""
    • "twitch_client_id": ""
    • "lastfm_api_key": ""
    • "discord_key": ""
  2. Run the bot

bash drfujibot_launcher.sh my_config.json

About

Twitch chat bot providing Pokemon information

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •