Installation

Odyssey installs like LemLib does: as a PROS template — a versioned package containing the compiled library and its headers that the PROS conductor manages for you. You can also vendor the raw source if you want to hack on the library itself.

Prerequisites

PROS installed (the VS Code extension is the easiest way)
A VEX V5 brain and at least a drivetrain with left/right motors
Strongly recommended: a V5 inertial sensor (IMU)

Option A — depot install (recommended)

Register the Odyssey depot once, then install it into any PROS project:

# one-time: tell the PROS conductor where Odyssey lives
pros c add-depot odyssey https://raw.githubusercontent.com/jonahchang207/odyssey/depot/stable.json

# inside your PROS project:
pros c apply odyssey

Upgrading later is one command:

pros c upgrade odyssey

Option B — manual template install

Download odyssey@X.Y.Z.zip from the latest release.
Register it with the conductor:
```
pros c fetch odyssey@X.Y.Z.zip
```
Apply it inside your PROS project:
```
pros c apply odyssey
```

Option C — vendor the source

If you want to modify the library itself, copy the source straight into your project instead of using the template:

From (this repo)	To (your project)
`include/odyssey/`	`include/odyssey/`
`src/odyssey/`	`src/odyssey/`

The PROS build system compiles everything under src/ automatically.

Set up `main.cpp`

However you installed, copy the example robot configuration from src/main.cpp in this repository into your project's src/main.cpp, and continue to Configuration to adapt it.

pros make

One include

Everything in the library is available through a single header:

#include "odyssey/api.hpp"

How the template is built

Every GitHub release automatically builds odyssey@X.Y.Z.zip (headers + compiled firmware/odyssey.a) with the Build PROS template workflow and updates the depot, so the depot always points at the newest stable release. You never need a local ARM toolchain unless you're developing Odyssey itself.