Skip to content

youssefea/stream-yoink

Repository files navigation

StreamYoink!

Overview

StreamYoink! is an innovative game-in-a-frame developed by the Superfluid team, designed to offer a unique experience of Money Streaming, mixing between the famous game on Farcaster Yoink, the tipping coin on Farcaster $DEGEN, and the concept of Money Streaming. In this game, players can claim a stream of $DEGEN to their wallets, competing with other users for the same stream on $DEGEN. It's an engaging way to introduce players to the concept of Money Streaming while providing a fun and competitive environment.

Features

  • Real-time leaderboard updates.
  • Blockchain transaction
  • Competitive gameplay with rewards in $DEGEN tokens.

Getting Started

To get started with StreamYoink!, follow these simple steps:

Prerequisites

Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/youssefea/stream-yoink.git
  2. Navigate to the game's directory:

    cd stream-yoink
  3. Install the necessary dependencies:

    npm install
  4. Start the development server:

    npm run dev

Now, your the frame shouls on http://localhost:3000 (or 3001, or whichever port is specified in your configuration).

Testing and Debugging

For testing and debugging, StreamYoink! recommends using Frames.js, a powerful tool designed to streamline the development process. Frames.js offers a range of features to simulate different scenarios and debug your frame in real-time.

To learn more about how to utilize Frames.js for StreamYoink!, visit the official website:

Frames.js Documentation

Contributing

We welcome contributions to StreamYoink! Whether it's suggesting new features, reporting bugs, or improving documentation, your feedback is valuable to us.

License

StreamYoink! is released under the MIT License.

Acknowledgments

Thank you for your interest in StreamYoink! We're excited to see how you engage with the frame.