DigDug101 / freemocap

Free Motion Capture for Everyone 💀✨

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

2022-03-09_FreeMoCap_Clips_SHORT_compressed.mp4

---

QUICKSTART

1. Install software via pip:

pip install freemocap~=1.0.12rc0

2. Launch the GUI by entering the command:

freemocap

3. A GUI should pop up that looks like this

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

5. Join the Discord and let us know how it went!

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

NOTE - these are super bare-bones install instructions just to show the new entry point - these instructions will be overhauled very soon (written 2023-03-14)

Open an Anaconda-enabled command prompt (or equivalent) and enter the following commands:

1. Create a Python3.8+ environment

conda create -n freemocap-env python=3.9

2. Activate that newly created environment

conda activate freemocap-env

3. Clone the repository (pip install coming very soon!)

git clone https://github.com/freemocap/freemocap

4. Navigate into the newly cloned/downloaded freemocap folder

cd freemocap

5. Install the package via the pyproject.toml file

pip install -e .

6. Launch the GUI (via the freemocap.__main__.py entry point)

python -m freemocap

A GUI should pop up!

Documentation and Knowledge Base (NOTE - no docs exist for the version of the GUI on the main branch yet - these docs refer to the Alpha release

Documentation for this software is currently pretty thin... but we're woking on it!

Here's a YouTube video that covers a lot of relevant material (check the chapters for specific topics) - https://youtu.be/GxKmyKdnTy0

Our documentation lives here (for now) - https://freemocap.readthedocs.io

---

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

2. Run the tests to ensure that everything works appropriate

task test

Contribution Guidelines

Please read our contribution doc: CONTRIBUTING.md

Creating a new binary (may or may not work lol)

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

• Jon Matthis
• Endurance Idehen

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