/witches-brew

8-bit real time party game

Primary LanguageJavaScriptMIT LicenseMIT

This is 🔥🔥Witches' Brew🔥🔥

It's an 8-bit party game for 2-4 bad witches.

How to play

You can play Witches' Brew on desktop or mobile.

  • Go to http://playwitchesbrew.com
  • Click 'live deliciously' to establish a new coven.
  • Invite 1-3 other players to the game by clicking 'Copy Link' or sending them an SMS.
  • When you see a command on your screen, follow it by dragging the correct ingredient into the cauldron. If you don't have the tools to follow a command, ask for help from one of your co-witches.
  • Finish the potion to cast a spell on the evil wizard before time runs out!

Configuration on local machine

Create a GitHub repo and clone it. After you have a repo on your machine:

npm install

create a secrets file that contains your own firebase auth info (we named ours "witches_brew.env.js")

create a secrets file that contains your own twilio auth info (we named ours "secrets.js")

npm run dev

Game will be running on localhost:5000

And then you'll have me! If I change – which I probably will – you can get the most recent version by doing this again:

git fetch witchesbrew
git merge witchesbrew/master

My anatomy

/app has the React setup. main.jsx is the entry point.

/fire has the Firebase config.

/functions is where your cloud functions live.

/bin has scripts. (Right now it has one script that creates a useful symlink.)

/public has all visual assets

Conventions

I use require and module.exports in .js files.

I use import and export in .jsx files, unless require makes for cleaner code.

I use two spaces, no semi-colons, and generally prefer a less strict version of NPM's funny coding style. My lint config is in eslintrc.js.

Licensing

This software is protected under the standard MIT License.