Skip to content

uxp/firebot-trivia-game

Repository files navigation

Firebot Trivia Game

What?

Firebot Trivia is a custom startup script created to be used in Firebot. Firebot is a Twitch bot created by Team Crowbar. This script is not made for use outside Firebot, including other bots or independently. It is heavily inspired by the Heist game that is included in Firebot itself.

Usage

Download

Download the latest release from GitHub here

Install

Install to your local Firebot installation:

  1. Windows: %APPDATA%\Firebot\v5\profiles\{yourProfile}\scripts
  2. Mac: ~/Library/Application Support/Firebot/v5/profiles/{yourProfile}/scripts
  3. Linux: ~/.config/Firebot/v5/profiles/{yourProfile}/scripts

Configure

In Firebot, configure triviaGame.js as a Startup Script.

Enable the new Game under Games in Firebot:

  • Ensure the currency is set correctly.*Game Settings allows you to change the default behavior.
  • Message Formatting allows you to configure the default messages.
  • Chat Settings allows you to configure the messaging to come from your Bot account, or Main account.
  • Finally, General Messages are largely error messages if the script fails to run or work correctly. These may be removed in the future. If you don't want it to be very verbose, simply erase these messages, and it won't print anything.

Development

Setup

  1. npm install

Building

Dev:

  1. npm run build:dev
  • Automatically copies the compiled .js to Firebot's scripts folder.

Release:

  1. npm run build
  • Copy .js from /dist

Note

  • Keep the script definition object (that contains the run, getScriptManifest, and getDefaultParameters funcs) in the main.ts file as it's important those function names don't get minimized.
  • Edit the "scriptOutputName" property in package.json to change the filename of the compiled script.

About

A Trivia based reward game in Firebot, a Twitch (and other) command bot.

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 2

  •  
  •