# MotionView Docs - for LLMs

> MotionView is a platform-agnostic desktop application (Windows, Linux, macOS) designed to visually plan, simulate, and analyze autonomous robotics routes. It features an interactive real-time Viewing dashboard and a low-code Planning timeline sequencer. Its companion C++ PROS library, MVLib, utilizes a compact binary serial protocol for low-overhead telemetry streaming.

Main GitHub Page: https://github.com/lewispinstein-hue/MotionView
Live Documentation: https://lewispinstein-hue.github.io/MotionView
Creator: [Lewis Pinstein](https://github.com/lewispinstein-hue)

Within these docs, there are referrals to human-readable files that are likely unreadable to your tools. Refer to the below links as a lookup table to find the files you are looking for.
## Core Resources
- [Home](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/Home.md): Project overview, core features, and quick-start links.
- [Download](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/Download.md): Where to download MotionView and how to install MVLib.

## MotionView (Desktop Client)
- [Viewing Mode](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/ViewingMode.md): Live streaming, timeline, logs, watches, and waypoint UI basics.
- [Keybinds](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/Keybinds.md): Keyboard shortcuts for viewing, playback, planning, and navigation.

### Planning Mode
- [Planning Mode](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/PlanningMode/PlanningMode.md): Creating autonomous paths with waypoints; using theta handles; creating custom-event objects and methods; placing events on the timeline; copying or exporting generated code; planning without odometry; and troubleshooting.
- [Planning Export Template](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/PlanningMode/PlanningExportTemplate.md): Defining per-waypoint export templates, supported variables (`x`, `y`, `theta`, `distance`, `iteration`, and `speed`), timeline event insertion order, and generated-code examples.

### Setup & Installation
- [Installing on macOS](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/InstallingMacOS.md): macOS installation and Gatekeeper quarantine fixes.
- [Installing on Windows](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/InstallingWindows.md): Windows installation steps and SmartScreen bypass notes.
- [Setup Live Streaming](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/SetupLivestreaming.md): MotionView settings, PROS project selection, and livestream setup.

### Specifications & Changelogs
- [JSON Schema v3](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/MotionViewSchemaV3.md): Current MotionView JSON route/export shape and import rules.
- [JSON Schema v2](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/MotionViewSchemaV2.md): Legacy MotionView JSON route/export shape and import rules.
- [Logging API](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/MotionViewAPI.md): Text telemetry tags, expected fields, parsing behavior, and examples.
- [Changelog v1.3.0](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/Changelog/v1.3.0.md): MotionView v1.3.0 breaking changes, features, improvements, and fixes.
- [Changelog v1.2.0](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MotionView/Changelog/v1.2.0.md): MotionView v1.2.0 breaking changes, features, removals, and fixes.

## MVLib (Companion C++ PROS Library)
- [Setup](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Setup.md): Installing MVLib, including headers, attaching odometry, and starting the logger.
- [Configuration](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Configuration.md): Logger output toggles, timing settings, log levels, and drivetrain setup.
- [Logs](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Logs.md): `logger.debug/info/warn/error/fatal()`, log filtering, terminal output, and SD output.
- [Watches](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Watches.md): All parts of `logger.watch()`, watch troubleshooting steps, and examples.
- [Waypoints](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Waypoints.md): `addWaypoint()`, waypoint handles, reach checks, timeouts, offsets, and examples.
- [SD Logging](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/SDLogging.md): SD log paths, folder/file policies, fallback behavior, and troubleshooting.
- [Updating to v3.0.0](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/UpdatingTo-v3.0.0.md): MVLib v3.0.0 migration checklist, before/after examples, and renamed APIs.

### Changelogs
- [Changelog v3.0.0](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Changelog/v3.0.0.md): MVLib v3.0.0 breaking changes, features, improvements, removals, and fixes.
- [Changelog v2.0.0](https://raw.githubusercontent.com/lewispinstein-hue/MotionView/refs/heads/gh-pages/docs/MVLib/Changelog/v2.0.0.md): MVLib v2.0.0 breaking changes, features, removals, and fixes.