This repository contains a clone of Flappy Bird. It was built using the Phaser 3 game framework, JavaScript, and Tinybird, the real-time data platform for data and engineering teams.
Test your skills by playing 🎮🐥 Flappy Tinybird!
The goal of the game is to maneuver the bird through a challenging array of pipes, avoiding any collisions. The bird propels itself forward automatically, and you control its flight by either pressing the space bar, enter, or clicking on the screen to flap its wings. If you collide with a pipe, the ground, or the sky, it's game over!
Each game event - 'score', 'game over', and 'purchase' - is streamed to Tinybird using the Events API. As the data arrives, it gets transformed and aggregated in real-time and published as API Endpoints. These APIs power two use cases in the game: user-facing analytics and real-time personalization.
After each game, you are presented with a screen that contains a live leaderboard, stats about your historical performance, and scores for your most recently played games. You can evaluate your performance and see how you stack up to other players from around the world!
These stats are powered by Tinybird API Endpoints that query fresh and historical game events and return results in milliseconds.
This game can be challenging, which risks players churning due to a bad experience. But, with a personalized offer delivered at the right moment, we can improve the gamer experience and keep players coming back for more.
At the end of each round, the game makes an API request to Tinybird to evaluate your performance and determine whether or not to provide an offer. In milliseconds, Tinybird decides if you meet the criteria for an offer to make the next round easier, incentivizing you to keep playing.
In a real-world scenario, there are critical moments when a player decides what to do - stop playing, watch an ad to get a power-up, make an in-game purchase, and so on. Personalized offers at those critical moments can dramatically increase retention and drive a game's monetization strategy.
To run your own version of the game, you'll need to create a Tinybird Workspace and install Node.js and npm on your computer.
-
Sign up for Tinybird and follow the guided process to create an empty Workspace in the provider/region of your choosing.
-
Clone this repository locally
git clone https://github.com/tinybirdco/flappy-tinybird.git
cd flappy-tinybird- Install dependencies
npm install- Install and configure the Tinybird CLI
Note: Alternatively, you can sync your Tinybird Workspace with a remote Git repository. Go to Tinybird's docs to learn more.
First, install the Tinybird CLI in a virtual environment. You'll need Python 3 installed.
Check the Tinybird CLI documentation for other installation options and troubleshooting tips.
cd tinybird/
python3 -m venv .venv
source .venv/bin/activate
pip install tinybird-cli
tb auth --interactiveIn the Tinybird UI, navigate to Tokens page in the left navigation pane and copy the token with admin rights. Paste it in the terminal and hit enter/return.
⚠️ Warning! This is your admin token. Don't share it or publish it in your application. You can manage your tokens via API or using the Auth Tokens section in the UI. More detailed info at Auth Tokens management.
Choose your region. A new .tinyb file will be created in the tinybird/ folder.
- Push the Data Project to your Tinybird Workspace
tb pushAll of the Data Sources, Pipes, and Tokens are now available in your Tinybird Workspace.
- Add Tinybird variables to the
.envfile
Duplicate the .env.example file and change the extension to .env.
Back in the Tinybird UI, navigate to the Tokens page. copy the tokens app_read_token and app_append_token and paste them in the .env file. You will also need to add the host (refer to the URL to select the correct region).
VITE_TINYBIRD_HOST=api.[us-east. | us-east.aws. | eu-central-1.aws.]tinybird.co
VITE_TINYBIRD_READ_TOKEN=[app_read_token]
VITE_TINYBIRD_APPEND_TOKEN=[app_append_token]
- Start the game!
In the terminal, run the following command:
npm startOpen your web browser, go to http://localhost:3000, and play!
This game was built by Joe Karlsson, Alasdair Brown, Joe Krawiec, David Margulies, Rafa Moreno, Julia Vallina, and Juanma Jimenez based on the original game by Dong Nguyen.
This project is licensed under the MIT License.