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
- Install software via pip:
pip install --pre freemocap
- Launch the GUI by entering the command:
freemocap
- A GUI should pop up that looks like this
![image](https://private-user-images.githubusercontent.com/15314521/239695690-90ef7e7b-48f3-4f46-8d4a-5b5bcc3254b3.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTcwMDEwMzksIm5iZiI6MTcxNzAwMDczOSwicGF0aCI6Ii8xNTMxNDUyMS8yMzk2OTU2OTAtOTBlZjdlN2ItNDhmMy00ZjQ2LThkNGEtNWI1YmNjMzI1NGIzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA1MjklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNTI5VDE2Mzg1OVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTRkYTkxY2IyODU4MzNiMTgwNmJjMjkxMzhjMmQ5ZDJlNzgxMThjMWIzZjVlMzZlOWI1Y2QxYjdkYzQ2MTkxYzMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.QBwOpQp2HNALZzNLFwxW9XOPpBAJ5CCU5qMGjtoAa0A)
-
Have fun! It might break! Work in Progress lol
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:
- Create a
Python3.8+
environment
conda create -n freemocap-env python=3.9
- Activate that newly created environment
conda activate freemocap-env
- Clone the repository (pip install coming very soon!)
git clone https://github.com/freemocap/freemocap
- Navigate into the newly cloned/downloaded
freemocap
folder
cd freemocap
- Install the package via the
pyproject.toml
file
pip install -e .
- 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
After you've done the easy install instructions, you'll be able to run our repo commands
- Run the "setup" command to set up your environment
task setup
- Run the tests to ensure that everything works appropriate
task test
Please read our contribution doc: CONTRIBUTING.md
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.
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