====== The Player App ======

The Player App will run on a Raspberry Pi that will physically be in the same box as the Braille cells and buttons.

It plays scenarios that have been stored in a file in a particular format

**One of your main jobs in this phase is to design and document this format
**

====== Official Simulator API ======

You can access the official Simulator API and implementation [[https://github.com/biltzerpos/enamel.git|here]].

The project contains javadoc as well. You can also access the Javadoc [[http://www.eecs.yorku.ca/~bil/LaSSoftE/Enamel/doc/index.html|here]].

====== To get started ======

Take a look at this {{:adventure_on_the_high_seas.pdf|Sample Scenario}}.

It will give you a pretty good idea of the kind of capabilities the Player app needs to have.

All the interaction in the scenario is stored in the file that the Player app will read

====== Audio Support ======

The Player app will use audio to communicate with the visually-impaired user

You will need to support two options

  - Playing audio clips stored as files (either for speech or for sound fx)
  - Using a text to speech library to create audio on the fly. You should research available text to speech libraries online, and select one for your project.

====== Player Submission Details ======

Rubric posted under Evaluation.

Four grade components

  - Requirements document
  - Testing document
  - Player File Format Documentation
  - Implementation

====== Player Submission Process ======

1. Create a .zip or .jar that contains the following:

  - All grade components including the code
  - A README.txt that

    * Explains the contents of the zip file
    * Provides a link to your github repository

2. Email the zip file to bil@cse.yorku.ca by 11:59pm on Mar 7

  * Only one email per team
  * Include your team number in the subject

3. Each student must also send me a private email with an assessment of their teammates’ contributions