Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated readme for post game jam
  • Loading branch information
Rice-Tech authored Feb 9, 2024
1 parent 8c0c558 commit 2135de9
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Game Jam 2024 Project
# Tumblewords
Tumblewords is a party game inspired by classroom games like Kahoot and Madlibs. Players can host a game or join a game hosted by a friend using the link, id, or QR code and then collect words by hitting them with a ping pong ball. After players submit their words, the host's device reveals a story with the player-gathered words entered in! Tumblewords was developed for the Global Game Jam 2024.

## Tech Stack
Tumblewords uses React with Typescript on the front-end and Firebase's Firestore for the database. Shadcn and Tailwind CSS provide the UI and styling. The word collection game uses React Three Fiber and Rapier Physics along with several helpful drei componants from the excellent Poimandres group.

## How to Install and Develop locally
Please follow these instructions to code locally (these were written for teammates during the game jam)
Anyone who would like to develop their own version of this program will need to create a Firebase project and add its config information as GitHub secrets.

### Requirements
- [Node.js] (https://nodejs.org/en)
- A code editor like [VS Code] (https://code.visualstudio.com/)
Expand Down

0 comments on commit 2135de9

Please sign in to comment.