sculpture-emulator-client
v1.5.13
Published
The emulator client for the anyWare sculpture
Downloads
8
Readme
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
To run in development mode:
$ npm run dev
Deployment
Have anyWareSculpture.github.io checked out in ../
$ npm run build
$ cp -R public/* ../anyWareSculpture.github.io
$ cd ../anyWareSculpture.github.io
<edit package.json: bump version>
$ 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
- Install Node.js (https://nodejs.org/en/download).
- Choose "LTS (Recommended For Most Users)" -> "Macintosh Installer"
- Install GitHub Desktop (https://desktop.github.com)
- 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
Get latest version
- Open GitHub Desktop
- Select "sculpture-emulator-client"
- Click "Sync"
Install and launch
- In GitHub Desktop: Right-click on "sculpture-emulator-client" -> "Open in Terminal"
- In Terminal:
npm install
npm run dev
To subsequently just launch
- In Terminal:
npm run dev
- In Terminal: