README.md 3.8 KB

Metroflip

Metroflip is a multi-protocol metro card reader app for the Flipper Zero, inspired by the Metrodroid project. It enables the parsing and analysis of metro cards from transit systems around the world, providing a proof-of-concept for exploring transit card data in a portable format. Please join the server here if you have any questions for me.

Author

@luu176


image

Setup Instructions

Using a pre-built release: Stable (Recommended) or Beta (Newer updates, less stable)

  1. Download the appropriate metroflip.fap file from the Releases section.
  2. Drag and drop the metroflip.fap file into the apps folder on your Flipper Zero's SD card.

Manual Build Instructions

To build Metroflip manually, follow these steps:

  1. Install Git
    Download and install Git on your Windows computer.
    Run the first command to download the app:

Either: Stable Release (recommended):


**OR**:
Beta (newer updates but not fully tested): 

git clone --single-branch --branch dev https://github.com/luu176/Metroflip.git```

  1. Navigate to the Project Folder
    Run the second command to enter the app folder:

    
    3. **Install Python**  
    Download and install Python from the [official website](https://www.python.org).  
    
    4. **Install UFBT**  
    Run the third command to install UFBT:  
    
    

    pip install ufbt```

  2. Update and Build the Project
    Run the following commands in order to build the app:

    ufbt fap_metroflip```

  3. Connect Your Flipper Zero
    Ensure your Flipper Zero is connected via USB and close the QFlipper application (if it’s open).

  4. Launch the Build
    Run the final command to launch the app on your flipper:

    ufbt launch


    Metroflip - Card Support TODO List

    This is a list of metro cards and transit systems that need support or have partial support.

    ✅ Supported Cards

    | Card / Agency | Country / City | Card Type | | Bip! | :chile: Santiago de Chile, Chile | Mifare Classic | | Charliecard | :us: Boston, MA, USA | Mifare Classic | | Clipper | :us: San Francisco, CA, USA | Mifare DESFire | | ITSO | :uk: United Kingdomn | Mifare DESFire | | Metromoney | :georgia: Tbilisi, Georgia | Mifare Classic | | myki | :australia: Melbourne (and surrounds), VIC, Australia | Mifare DESFire | | Navigo | :fr: Paris, France | Calypso | | Opal | :australia: Sydney (and surrounds), NSW, Australia | Mifare DESFire | | Rav-Kav | :israel: Israel | Calypso | | Troika | :ru: Moscow, Russia | Mifare Classic |


    Credits


    Special Thanks

    Huge thanks to @equipter for helping out the community!