freemocap

(β˜… 10,038)

Free Motion Capture for Everyone πŸ’€βœ¨

  • .flake8
  • .gitignore
  • .pre-commit-config.yaml
  • .python-version
  • CITATION.cff
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • freemocap.spec
  • LICENSE
  • MANIFEST.in
  • noxfile.py
  • package-lock.json
  • poe_tasks.toml
  • pyproject.toml
  • README.md
  • TESTING.md
  • uv.lock

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/freemocap/freemocap

Downloads the entire project code from GitHub to your computer.

cd freemocap

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install freemocap[cuda] # Windows/Linux with an NVIDIA GPU

Installs the package published on PyPI directly β€” no need to clone the source.

pip install freemocap[cpu] # macOS, or Windows/Linux without a supported GPU

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install freemocap[cuda] # Windows/Linux with an NVIDIA GPU

Installs the package published on PyPI directly β€” no need to clone the source.

pip install freemocap[cpu] # macOS, or Windows/Linux without a supported GPU

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation