Skip to content

Latest commit

 

History

History
123 lines (75 loc) · 4.39 KB

CONTRIBUTE.md

File metadata and controls

123 lines (75 loc) · 4.39 KB
Raw

How to contribute

This project is still a work in progress, but we hope that you will contribute!

Getting Started

If you want to help develop this library, here are the steps to get started with:

  1. Fork the repository to your account, and then clone it your computer:
git clone https://github.com/YOURGITHUBHANDLE/kinectron.git
  1. Make sure you have node and npm installed.

From here, you can choose to develop independently on the client-side API or the server application.

Contribute to API

You can develop on the client-side API from Mac or PC.

  1. Install dependencies.
cd client
npm install

  1. Make changes in client/src/kinectron.js

  2. Build the library with changes.

Kinectron is developed using Parcel. Parcel is an application bundler that bundles several files into one file.

Kinectron requires PeerJS to send data over the network. Parcel makes sure that the PeerJS files are included in the Kinectron library. To create the bundle, run the build script.

npm run build

The final bundled library is created at kinectron/client/dist/kinectron-client.js

OR

If you'd like to make several changes over time, Parcel can watch your file for changes, and simultaneously bundle them. Parcel will continue to watch for changes as long as it is running. To start this process run the start script.

npm start

Use control + C to stop this process.

Run the build script one final time after you stop running the Parcel watch command.

Contribute to Server Application

You can develop on the server application from Windows only. This has only been tested on Windows 10.

  1. Install Kinect2 SDK and Node-Gyp

    You will need to have the official Kinect 2 SDK and node-gyp and it's dependencies installed before you can continue.

Install the official Kinect 2 SDK.

Install node-gyp globally.

npm install -g node-gyp

Install node-gyp dependencies. Follow the installation instructions for Windows on the node-gyp github repo to install the dependencies.

As of 10/2019 the windows-build-tools installation from the command line (Option 1) is buggy. It's recommended to use Option 2 in the node-gyp dependency install instructions. For this option, make sure that you check the box next to "Desktop Development with C++ Workload" from the available Workloads during the Visual Studio 2017 Community install process.

As of release 0.3.3 you no longer need to build Kinect2 for Electron. If you are using an earlier version of the Kinectron application you will need to build it. See CONTRIBUTE.md at tag 0.3.2 for instructions.

  1. Install dependencies.

After you've forked and cloned the repository, move into the app folder and install all dependencies.

cd app
npm install
  1. Copy body tracking models into application folder

In order for the body tracking for Azure Kinect to work, you will need to have a couple of dll files in the root of your application. Otherwise, you'll run into errors like the one below:

Cannot locate onnxruntime.dll

The install script of this module tries copy these files automatically. You should have the following files in your application root after running npm install:

  • onnxruntime.dll
  • dnn_model_2_0.onnx
  • cublas64_100.dll
  • cudart64_100.dll
  • vcomp140.dll
  • cudnn64_7.dll

If you can't find these files, copy them from inside node_modules/kinect-azure to the kinectron/app folder.

  1. Run the electron application with npm start.
cd app
npm start
  1. To create a new release / packaged application. Run electron-packager from inside the application folder
cd app
npm run package

This will make an application for the platform and architecture for the computer you are working on. To learn more about packaging options read the Electron Packager documentation.

Additional Resources