# TrucoTrack - A Motion Capture Listener

TrucoTrack is a program intended to serve as a helper when using motion capture software (like MediaPipe). It defines a CSV file format for each of the available trackers and lets you easily call them from a command line.

## Warnings

### Unfinished Work

Please take into account that this is an experimental software. It is still in development. Unfinished, unpolished, incomplete and probably, buggy. If you use it, please expect some inconsistencies and crashes.

Check the [releases](https://gitlab.com/hawara.es/blender/trucotrack/-/releases) and our [roadmap and releases](docs/roadmap-and-releases.md) document. Only versions 0.x.x will be released until the tool is ready for production. If ever.

## Documentation

### TrucoTrack File Formats

- [File Format for MediaPipe Hand Tracks](docs/file-formats/mediapipe_hand.md)
- [File Format for MediaPipe Face Tracks](docs/file-formats/mediapipe_face.md)

### Command Line Usage

- [Examples of Command Line Usage](docs/cli/examples.md)
- [Display The Command Line Help](docs/cli/help.md)

### Development

- [Roadmap and Releases](docs/roadmap-and-releases.md)
- [How to Contribute with the Development](docs/how-to-contribute-with-the-development.md)
- [GPL v3 License](LICENSE.txt)
