/freemocap

Free Motion Capture for Everyone 💀✨

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

Project Logo

freemocap

📝 The FreeMoCap Project: A free-and-open-source, hardware-and-software-agnostic, minimal-cost, research-grade, motion capture system and platform for decentralized scientific research, education, and training

GitHub Downloads Latest Release MIT License Contributions Welcome https://img.shields.io/badge/code%20style-black-000000.svg

INSTALLATION

Note: This will install the latest/last version from the pre-alpha phase of this project, frozen at release tag v0.0.54 here

Open an Anaconda-enabled command prompt or powershell window and enter the following commands:

  1. Create a Python3.7 Anaconda environment
conda create -n freemocap-env python=3.7
  1. Activate that newly created environment
conda activate freemocap-env
  1. Install freemocap (version 0.0.54) from PyPi using pip
pip install freemocap==0.0.54

That should be it!

BASIC USAGE

How to create a NEW freemocap recording session

tl;dr- Activate the freemocap Python environment and run the following lines of code (either in a script or in a console)

import freemocap
freemocap.RunMe()

But COOL KIDS will install Blender (blender.org and generate an awesome .blend file animation by setting useBlender=True:

import freemocap
freemocap.RunMe(useBlender=True)

For additional, more detailed instructions (including methods to re-process recorded sessions), refer to the OLD_README.md document)

Pre-requisites

General

Easy MacOSX Install Instructions

  1. Install the Homebrew Package manager (Skip this step if you already have it)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  1. Install Git (Skip this step if you already have it)
brew install git
  1. Get the source code.
git clone https://github.com/freemocap/freemocap.git
  1. Install the dependencies
brew install blender ffmpeg
  1. Skip to our Getting Started section of the README below.

Easy Windows Install Instructions

  1. Install Chocolatey. Open Powershell, and run the below command
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
  1. Install Git
choco install git
  1. Get the source code.
git clone https://github.com/freemocap/freemocap.git
  1. Install the dependencies
choco install blender ffmpeg
  1. Skip to our Getting Started section of the README below.

Getting Started

Navigate into the newly cloned freemocap folder

cd freemocap

Install the Python Dependencies (into a virtual environment)

python3 -m venv env
/env/Scripts/activate
pip install -r requirements.txt

That's it! You're ready to run the freemocap application, and create your own digital skeletons.

Usage

For Developers

Dev Setup

After you've done the easy install instructions, you'll be able to run our repo commands

  1. Run the "setup" command to set up your environment
task setup
  1. Run the tests to ensure that everything works appropriate
task test

Contribution Guidelines

Please read our contribution doc: CONTRIBUTING.md

Creating a new binary

Create a new binary on your local system by running the below comand

task installer

Navigate to the /dist/ directory and you'll see the new Freemocap Binary there.

Related

Maintainers

License

This project is licensed under the APGL License - see the LICENSE file for details.