Introduction

tip

New to Zaparoo? Make sure to read the Getting Started guide, which explains everything necessary to get up and running quickly. Getting started is easy, getting it perfect for you is fun!

Zaparoo is an open system for launching media using physical objects. It allows you to do things like launch your favorite game by tapping an NFC card or watch a movie by scanning a QR code. This is achieved primarily using the Zaparoo Core software, but Zaparoo is also an ecosystem of software, hardware and artwork which all works together to make an awesome tactile experience with your media!

These docs cover all aspects of the Zaparoo project. Pick a section that interests you and dive in.

Hardware

Platforms

Supported platforms like MiSTer, Windows, SteamOS, and more.

Readers

NFC readers, barcode scanners, and other hardware.

Tokens

NFC cards, QR codes, and other scannable objects.

Software

Zaparoo Core

The background service that powers Zaparoo.

Zaparoo App

Official mobile app for iOS and Android.

ZapScript

The scripting language written to tokens.

Design

Zaparoo Designer

Web app for generating custom labels.

Labels

Tools and templates for creating card artwork.

Community

Community Projects

DIY builds, 3D prints, and community tools.

Community Hub

Discord, Reddit, and community resources.

The docs are open for contributions, so if you see something missing or want to add something, please create a pull request.