sculpture-emulator-client

Responsible for communicating with the streaming server and managing state in a similar manner as the embedded system.

Project Setup

Install node.js and npm. Then run the following to install dependencies:

$ npm install

Note: If using local dev versions of libraries:

npm link anyware
npm link @anyware/sound-assets

To run in development mode:

$ npm run dev

Deployment

Have anyWareSculpture.github.io checked out in ../

$ <edit package.json: bump version>
$ npm run build
$ cp -R public/* ../anyWareSculpture.github.io
$ cd ../anyWareSculpture.github.io
$ git add .
$ git commit -m "sync"
$ git push

How to update disk images

To update the disk images, add the files to the images/ directory. Run gulp images, or have gulp watch running prior to making changes.

Disk images must meet the following criteria:

• Provide images in their respective 'zeroed' positions;
• Images must be square;
• All three must have same dimensions;
• Image files may be .png, .jpg, or .gif.

The application looks for files named disk0.png, disk1.png, and disk2.png as the default disk images. These filenames are configurable in config.js under diskUrls.

Non-developer HOWTO (Mac)

Prerequisites

1. Install Node.js (https://nodejs.org/en/download).
   • Choose "LTS (Recommended For Most Users)" -> "Macintosh Installer"
2. Install GitHub Desktop (https://desktop.github.com)
3. Download the emulator source code
   • Visit https://github.com/anyWareSculpture/sculpture-emulator-client
   • Click "Clone or download" -> "Open in Desktop"
   • Choose an appropriate location to store the code

Daily use

1. Get latest version

   • Open GitHub Desktop
   • Select "sculpture-emulator-client"
   • Click "Sync"

2. Install and launch

   • In GitHub Desktop: Right-click on "sculpture-emulator-client" -> "Open in Terminal"
   • In Terminal:
     • npm install
     • npm run dev

3. To subsequently just launch

   • In Terminal:
     • npm run dev