This branch is a fork of the repository at https://github.com/Kinect/PyKinect2 which has python interfaces to the Kinect v2 SDK and sensor. It has a few updates needed to work with modern Python 3, and the original repository seems to be no longer maintained or updated.
This is used by the experimental Second Life Puppetry plug in - code that connects a Kinect v2 sensor motion capture data to the Second Life viewer. See the repository at https://github.com/secondlife/leap for that plug-in.
Original ReadMe File:
Enables writing Kinect applications, games, and experiences using Python. Inspired by the original PyKinect project on CodePlex.
Only color, depth, body and body index frames are supported in this version. PyKinectBodyGame is a sample game. It demonstrates how to use Kinect color and body frames.
The easiest way to get most of the pre-requisites is to use Anaconda which includes NumPy. You'll then need to pip install comtypes. The PyKinectBodyGame sample requires PyGame which needs to be manually installed.
- Download Anaconda get the 32-bit version. This includes NumPy.
- pip install comtypes
- Install the Kinect for Windows SDK v2
Full List of Dependencies
- Python 2.7.x or 3.4 and higher
- NumPy
- comtypes
- Kinect for Windows SDK v2
- Kinect v2 sensor and adapter Note: you can use a Kinect for Xbox One as long as you also have the Kinect Adapter for Windows
- PyGame - for running PyKinectBodyGame sample
The package can be installed through pip using the usual means:
pip install pykinect2
If you are using a virtual environment, be sure to activate it first.
For more information, please see https://pip.pypa.io/en/latest/user_guide.html#installing-packages
To install the package manually, clone this repository to a local folder and include it in the appropriate python environment. If installing in a virtual environment, be sure to install all required dependencies (above).
For example:
cd c:\projects\myproject\env\
/Scripts/activate.bat
easy_install -a c:\projects\downloads\PyKinect2
After installation is complete, you can launch the interactive python shell and import pykinect2 to ensure everything has been installed properly.
Core helper classes for working with the Kinect sensor are located in PyKinectRuntime.py. For usage examples, please see /examples/PyKinectBodyGame.py.