https://github.com/karrbs/firebotcollectiongame

Created for the need of a simple game that would look at a folder, index it, and then allow the viewers to collected said collection via a channel rewards.
https://github.com/karrbs/firebotcollectiongame

angular electron firebot npm

Last synced: 7 days ago
JSON representation

Created for the need of a simple game that would look at a folder, index it, and then allow the viewers to collected said collection via a channel rewards.

• Host: GitHub
• URL: https://github.com/karrbs/firebotcollectiongame
• Owner: karrbs
• Created: 2024-08-01T12:20:11.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-08-01T12:34:15.000Z (2 months ago)
• Last Synced: 2024-09-26T05:41:59.155Z (7 days ago)
• Topics: angular, electron, firebot, npm
• Language: TypeScript
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Firebot Collection Game

status: Alpha

## About

Created for the need of a simple game that would look at a folder, index it, and then allow the viewers to collected said collection via a channel rewards.

** Collection Game is two scripts and will be rewritten in the near future to be a custom game for. Firebot

*** Based on the the template script that firebot provided

### Features Required

- User DB

- Persist Custom Variables 

- Custom Scripts

## How to use

### Statup Scripts

1. Create an `item.txt` file in a safe directory

2. Add both JS Files `collectionGame - reward`, `collectionGame - startup` to the Scripts Folder.

2. Add `collectionGame - startup` script in the start up scripts

3. Collection Name: Name it what you want. I would keep this simple and that works with reward message.

3. folder: Select a directory that will have all your image files in it

4. dbFolderPath: Select the folder where you put the item.txt

### Reward (command/channel rewards)

1. Add effect `Custom Script`

2. Select `collectionGame - reward`

### Current Reward Message and overlay

Message: `metadata.username + " has collected a " + selectedItem.name + " " + collectionName + "\! They now have collected " + test.totalCount + " " + collectionName + "s\."`

Overlay: Shows Image, Jackinthebox ,wobble, rollout -  total time is 10 image size is 250 by 250 

## TODO

- [ ] merge into 1 scripts

- [ ] validate item.txt

- [ ] integrate reward into events

- [ ] create build and pack script

- [ ] output information into a variable. 

## Current Bugs

- [ ] Can't replay message from action message

## Using

### Setup

1. Create a new repo based off this template (Click "Use this Template" above) or simply fork it

2. `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 outputted script.