About

The Goldsmiths Mocap Streamer consists of objects for transmitting BVH data in real-time.

You can download a pre-built version of our application. Alternatively, you can build your own from our source code. (Please note: you will need to deploy your own remote server in any instance)

This codebase is entirely open to forks and contributions via our GitHub, subject to our MPL License

Project Overview:

The streamer is essentially a Websockets wrapper for UDP data, allowing users to stream to ports over the web as though they were local.

It works like this:

  flowchart TD;

    Suit([Motion-Capture Suit])--User Datagram Protocol 'UDP'-->
    LocalA(Local Server);

    LocalA(Local Server)--Websockets-->
    Remote[(Remote Server)]
    
    UI[/Web User-Interface/]--Control Data-->
    Remote[(Remote Server)]--Websockets-->
    Local(Local Server)--User Datagram Protocol 'UDP'--> 
    Client[/Rendering Engine/];


    
    click LocalA "https://github.com/goldsmocap/axis-streamer/blob/main/local/README.md" "See the README for the 'Local Server' component"
    click UI "https://github.com/goldsmocap/axis-streamer/blob/main/local/README.md" "See the README for the 'Web UI' component"
    click Remote "https://github.com/goldsmocap/axis-streamer/blob/main/remote/README.md" "See the README for the 'Remote' component"
    
    %%click Suit...add docs for suit and set-up
    %%click Client...add docs for using external software with the streamer

Development

Project Setup

Prerequisites: git, node, yarn

1. Clone the project from github git clone https://github.com/goldsmocap/mocap-streamer

2. Navigate to the project root and install dependencies: yarn

Run Locally

1. Start the remote streamer. You can either:

   1. Run a server on locahost port 3000:

      Run yarn remote dev from the project root.

   2. Deploy your own remote server

2. Start the local streamer:

   In a new terminal, run yarn local dev from the project root.

   (This starts the UI and a local server running on localhost port 4000.)

Making a Release

pre-requisites: node, node-pkg

Release Remote-Streamer

Deploy your own remote server

Release Local-Streamer

NOTE This will only build an installer for the platform you run it on. For example, if you are using a Windows machine it will create a windows executable.

1. Update the version in package.json

2. Run yarn local prebuild

3. Run yarn local build

4. Zip the folder created by build release/<version_number>

5. Rename the zip to local_<version_number>-<platform>.zip

6. Copy zip to release in github