Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.21 KB

README.md

File metadata and controls

71 lines (49 loc) · 2.21 KB

ProtoFace Designer

A tool to easily create facial expressions for your pixel-based visor.

⚠️ This project is in early development - limited functionality, no saving, unstable API! ⚠️

Live Preview Build

QR Code to launch ProtoFace Designer

Deploy to GitHub Pages

You can see and try the current state of the tool in your browser here:

▶️ Start ProtoFace Designer

The Serial and Bluetooth connections are proof-of-concept level only, an example responder for ESP32 WROOM DevKit is found at /arduino.

Progress

Every aspect of this project is subject to change - this is just a rough map of what is currently planned:

  • Basic rendering and editing of monocromic LED matrices
  • Basic Serial Port connection to Demo Hardware from client (browser)
  • Basic Bluetooth connection to Demo Hardware from client (browser)
  • Basic Mirror-Mode (currently just for a fixed demo)
  • Export facial expression to C-Header-File
  • Migrate state to Vuex/Pinia
  • Export and re-import state via C-Header-File as Comment
  • Add UI features to manage multiple faces in one project
  • ... (more TBD)

Arduino Hardware Project setup

There is a preliminary working example on what hardware has currently been used to develop this app. It is only a proof-of-concept but there are some useful snippets already.

This documentation is in the /arduino folder.

Web Application Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Run your unit tests

yarn test:unit

Lints and fixes files

yarn lint