Skip to content

Home

Jump to bottom
Dmitry Sorokin (@sorydima) edited this page Sep 23, 2024 · 1 revision

dFlap Wiki

Welcome to the dFlap Wiki, the official guide for contributing, playing, and understanding the development roadmap for the dFlap Telegram game!

1. Home Page

Project Overview

Welcome to the dFlap Wiki!
dFlap is a Telegram-based game inspired by Flappy Bird, where users control a character to avoid obstacles and compete for high scores.

Quick Links

2. Roadmap

Current Development Stage

The dFlap project is currently in the initial development stage with core features being designed and implemented.

Upcoming Milestones

  • v0.1 - Core Game Mechanics (Expected Q4 2024)

    • Implement basic game loop (obstacle generation, movement, and collision detection)
    • Score tracking and leaderboard integration

  • v0.2 - Power-ups and Skins (Expected Q1 2025)

    • Add power-ups like shield, magnet, and speed boost
    • Implement unlockable skins for the character

  • v0.3 - Multiplayer Mode (Expected Q2 2025)

    • Introduce multiplayer with real-time leaderboard and live view

3. Installation

Requirements

To run or contribute to dFlap, you need the following:

  • Telegram Bot API
  • Python 3.8 or later
  • Required dependencies from requirements.txt

Installation Steps

  1. Clone the repository:

    git clone https://github.com/sorydima/dFlap.git

  2. Install dependencies:

    pip install -r requirements.txt

  3. Set up the Telegram Bot API:

    • Create a bot on Telegram and get the API token.
    • Add the API token to the .env file.

  4. Run the game locally:

    python dFlap.py

4. Gameplay

Objective

Guide your character through a series of obstacles by tapping to make it fly upward, and release to let it fall. Earn points by successfully passing obstacles and avoid crashing!

Controls

  • Tap to boost the character upwards.
  • Release to allow it to descend due to gravity.

Game Features

  • Power-ups: Collect shields, speed boosts, and magnets to help survive longer.
  • Unlockable Skins: Score higher points to unlock new skins for your character.
  • Leaderboard: Compete against other players for the top score.

5. Contributing

How to Contribute

We welcome contributions! Here’s how you can help improve dFlap:

  1. Fork the repository.
  2. Create a new branch for your feature: 
    git checkout -b feature-new-feature
  3. Make your changes.
  4. Submit a pull request, and we'll review it.

Contributions Wanted

  • Bug fixes
  • New power-ups
  • Additional character skins
  • Multiplayer improvements

6. FAQ

What is dFlap?

dFlap is a Telegram-based game inspired by the mechanics of Flappy Bird, but with additional features like power-ups, skins, and multiplayer.

How do I play dFlap?

Control your character by tapping to fly and avoid obstacles. Try to get the highest score possible!

Is there a multiplayer mode?

Multiplayer mode is planned for future releases and will include real-time leaderboards and live-view challenges with friends.

Clone this wiki locally