/freemocap

Free Motion Capture for Everyone 💀✨

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

Project Logo

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

DOI-via-Zenodo.org https://img.shields.io/badge/code%20style-black-000000.svg Latest Release AGPLv3 Contributions Welcome https://img.shields.io/badge/code%20style-black-000000.svg Discord Community Server

2022-03-09_FreeMoCap_Clips_SHORT_compressed.mp4

--

QUICKSTART

0. Create a a Python 3.9 through 3.11 environment (python3.11 recommended)¶

1. Install software via pip:

pip install freemocap

2. Launch the GUI by entering the command:

freemocap

3. A GUI should pop up that looks like this:

image

4. Have fun! It might break! Work in Progress lol


Install/run from source code (i.e. the code in this repo)

Open an Anaconda-enabled command prompt (or your preferred method of environmnet management) and enter the following commands:

  1. Create a Python environment (Recommended version is python3.11)
conda create -n freemocap-env python=3.11
  1. Activate that newly created environment
conda activate freemocap-env
  1. Clone the repository
git clone https://github.com/freemocap/freemocap
  1. Navigate into the newly cloned/downloaded freemocap folder
cd freemocap
  1. Install the package via the pyproject.toml file
pip install -e .
  1. Launch the GUI (via the freemocap.__main__.py entry point)
python -m freemocap

A GUI should pop up!


Documentation

Our documenation is hosted at: https://freemocap.github.io/documentation/index_md.html

That site is built using writerside from this repository: https://github.com/freemocap/documentation


Contribution Guidelines

Please read our contribution doc: CONTRIBUTING.md

Related

Maintainers

License

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

If the AGPL does not work for your needs, we are happy to discuss terms to license this software to you with a different agreement at a price point that increases exponentially as you move spiritually away from the AGPL