Seedling Drop Game

A drop game built with Phaser 3 that can be used as a twitch overlay, type commands in the chat to play.
This game was inspired by Coding Garden drop game, see the original code here

Build Setup

# install dependencies
npm install

# serve with live reloading at localhost:1234
npm start

# build for production with transpilation / minification
npm run build

Configuration

Customize the game by editing the configuration file config/appConfig.js

Section	Key	Descritpion	Values
general	testMode	Enable Test or Live mode	`true` Test mode `false` Live mode
	laserCollision	Laser collision effect	`0` Bounce `1` Destroy
channel	name	Your Twitch channel name	e.g. `'mrbencoder'`
	mods	Your channel moderators (Twitch user name who can send mod commands)	e.g. `['user1', 'user2'...]`
	commandPrefix	A (one character) prefix to identify game commands	e.g. `'!'`
	twitchClientID	Used to authorize this app to use Twitch API. Set this key only if you want to enable the command (!drop me), if not keep it empty, please see the documentation on how to obtain Twitch Client ID.
drop	scale	Scaling drop image size (0.5: half size, 1: actual size, 2: double size, etc)	e.g. `0.8`
	trail	Drop trail	`0` None `1` Random `2` Drop image `3` Multi colors `4` Red color `5` Blue color `6` Green color `7` Yellow color
	hideTimeout	Time in milliseconds to hide the drop	e.g. `10000`
	delay	Delay time in milliseconds for user's next drop	e.g. `90000`
target	status	Show, auto hide, or hide the target	`0` Show `1` Auto hide (only show if there is a new drop) `2` Hide
	autoTimeout	Auto hide time in milliseconds	e.g. `5000`
	move	If enabled, target will change location randomly	`true` Enable movement `false` Disable movement
	float	Enable or disable target floating	`true` Enable floating `false` Disable floating
seedling	timout	Time in milliseconds to hide user name in case of successful drop	e.g. `1000`
leaderBoard	status	Show, auto hide, or hide the leader board	`0` Show `1` Auto hide (only show if there is a new drop) `2` Hide
	autoTimeout	Auto hide time in milliseconds	e.g. `40000`

Commands

For everyone including channel moderators

Assuming that command prefix is the exclamation mark !

!drop Twitch emote
!drop BTTV emote
!drop FFZ emote
!drop Emoji
!drop me

For channel moderators

Command	Description	Parameters	Example
trail or tr	Change drop trail	`0` None `1` Random `2` Drop image `3` Multi colors `4` Red color `5` Blue color `6` Green color `7` Yellow color	!tr 1 !trail 6
laser or ls	Fire a laser	Total count (5 max.), if discarded laser will be fired once	!ls !laser 3
target or tg	Control the traget	`show` `auto` `hide` `move` (toggle between enable and disable) `float` (toggle between enable and disable)	!tg auto !target move
leaderboard or lb	Control the leader board	`show` `auto` `hide`	!lb hide !leaderboard auto

TODO

Implement a wind force to change drops velocity randomly
Create a winter theme (christmas theme)

Credits

Original SeedlingDrop game by Coding Garden. See the original code here.

Platform images from GameArt2D
Flower images created by BSGStudio
Background image from unsplash

mkdotcs / SeedlingDropGame