App Requirements

This page documents the requirements for the apps that will be pre-bundled into unlock-core.

General Structure

• All apps must inherit from iappplugin.py

• An app, at minimum, consists of two files.
  Consider an app called foo. It must contain at least:

  1. foo.py, which inherits from iappplugin.
  2. foo.yapsy-plugin, which is a plain text file in a specific format.

  Additional files, methods, directories, resources (audio, images, and the like) are all fair game and can be included as needed.

• Apps must live somewhere that unlock-plugins can find them; this will be configurable at run-time but for now, they can live in $PROJECTROOT/plugins/ or any of its subdirectories.

Specific Bundled Apps

1. Dashboard

   Dashboard is the app that launches apps.

2. Hello, World!

   Test platform for basic app functionality.

3. Gridspeak

   Presents a grid of pre-recorded phrases that will be spoken out by the controller when selected.

4. Gridcursor

   A calibration / user acclimation game. Select a target square on a grid, and a new one appears.

5. Fastpad

   A T9-like implementation of an on-screen keyboard, designed to minimize the number of selections to build arbitrary words.