DOCSEARCHbyAlgolia
Submit Docs

Zaparoo Documentation

website·Indexed 33 days ago

https://zaparoo.org/docs

Documentation for Zaparoo, a project for using physical NFC tags to interact with Zaparoo Core. Includes guides for the Zaparoo App (iOS and Android), the Web UI, Zaparoo Pro features, and detailed DIY instructions for building a custom NFC reader with a serial PCB and 3D-printed case.

Tokens
121.9K
Snippets
538
Records
1.1K
Agent score
68%

What's inside Zaparoo

  1. Overview of the Super Zap Boy hardware project

    Super Zap Boy is a custom hardware project that repurposes an SNES shell to house a Single Board Computer (SBC), such as a DE-10 Nano or a clone board. It utilizes a modified Super Game Boy containing a PN532 NFC reader connected to the SBC via USB. The system is designed to launch games by scanning NFC tags placed inside Game Boy cartridges; the NFC reader identifies the game path written to the tag and triggers the SBC to launch the corresponding game.

  2. Overview of Zaparoo Mappings

    Mappings are used to modify the contents of tokens before they are launched. The system queries stored mappings before every launch and applies the mapping to the token if a match is found. This is particularly useful for adding ZapScript functionality to read-only NFC tags by matching their unique ID (UID).

  4. Overview of the Zaparoo Core API

    The Zaparoo Core API is published by every device running the Zaparoo Core software. It provides a centralized interface for managing all Zaparoo features both locally and remotely. This API is the primary communication layer used by the Zaparoo application and most command-line flags. Note that the API is currently in a pre-v1 state and is subject to breaking changes before the official version 1 production release.

  5. Overview of Zaparoo core features

    Zaparoo is a tool for creating custom labels for physical media and NFC cards. Key features include:

    • Privacy & Access: No login or account is required. Local image files remain in the browser, though built-in artwork search utilizes external services.
    • Customization: Users can create labels from SVG-based templates, utilizing community-contributed layouts and styles. Colors, layouts, and media types are fully customizable.
    • Artwork Integration: Integrated search for game artwork via IGDB.
    • Export Options: Supports print-ready exports in PDF or PNG formats, including configuration options for printers and plotters.
    • Supported Media Sizes: Compatible with standard NFC cards, slim NFC cards, mini cards, Zap Trading Cards, cassette tape cases, foldable sleeves, and supported PCB card designs.

  6. Overview of Zaparoo Core features

    Zaparoo Core provides a set of user-configurable capabilities to extend the functionality of tokens and media libraries. Key features include:

    • Launchers: Define custom launchers and send control actions to active media.
    • Hooks: Execute ZapScript based on events such as token scans, media start/exit, or Core readiness.
    • Mappings: Assign ZapScript to read-only tokens (e.g., Amiibos, barcodes).
    • Play Controls: Manage disruptive scans and enforce playtime limits.
    • Playlists: Group media or ZapScript actions for sequential execution via playlist commands.
    • Audio Playback: Play music and audio files, including background music during gameplay.
    • Publishers: Broadcast Core events to external systems like MQTT brokers or PixelCade LED displays.
    • Systems: A reference of system IDs used for configuration and ZapScript commands.
    • Tags: Use metadata labels extracted from filenames to filter and match games.
    • Scraping: Import local metadata and artwork using gamelist.xml and media-folder scrapers.

  7. Use NFC Toys with Zaparoo

    NFC toys such as Amiibo, Skylanders, Disney Infinity, and LEGO Dimensions figures are compatible with Zaparoo. Because the game data on these figures is typically locked, encrypted, or proprietary to the original game, Zaparoo identifies these toys using their unique ID (UID) combined with mappings rather than attempting to read the internal game data.

  8. Understand Zaparoo platform support for playtime tracking

    Zaparoo playtime tracking accuracy depends on the platform's ability to detect when media starts and stops. Currently, MiSTer and Batocera provide the most accurate game detection, while other platforms are undergoing ongoing improvements.

  9. Use Zaparoo Core on Recalbox

    Zaparoo Core on Recalbox currently supports launching via shell scripts. Note that this platform is currently in beta and is not recommended for production use. Full launcher support is planned for a future release.

  10. Manage NFC tags using Zaparoo Cards

    A card in Zaparoo is a virtual container used to group one or more ZapScript commands. Each card is assigned a unique short URL, which is intended to be written to a physical NFC tag.

    Because the physical NFC tag points to the virtual card rather than a specific script, any updates made to the ZapScripts within that card are applied instantly to all physical NFC tags linked to that card, eliminating the need to re-write the tags.

  12. Use Zaparoo App to launch scripts via QR codes

    The Zaparoo App allows users to scan QR codes using a phone's camera to trigger actions. When 'Pro Launch on scan' is enabled, the app transmits the scanned ZapScript to Zaparoo Core over WiFi, eliminating the need to hard-code the Core device's IP address into the QR codes.