# Xoradora Companion Guide

This portable reference bundle complements the Xoradora web manual. It is
largely AI-generated from internal documentation and code. Read it directly
after extracting the ZIP, search it with ordinary text tools, or load the
Markdown files into a documentation or AI tool of your choice.

Start with this file. The other files divide the reference by purpose so a
reader or tool can load only the material needed for a question.

## Contents

| Path | Contents |
| --- | --- |
| `index.md` | This entry point and map of the bundle. |
| `modes.md` | How the seven resynthesis modes work, what each mode is good for, and useful starting points. |
| `controls.md` | Exact control behavior, stable parameter identities, units, ranges, automation details, and saved-state notes. |
| `workflows.md` | Practical sound-design, tuning, sequencing, import/export, attribution, and troubleshooting procedures. |
| `keyboard-shortcuts.md` | Desktop-editor and Phone Link sequencer keyboard controls. |
| `attribution-json.md` | The optional `attribution.json` format used inside `.xorakit` bundles. |
| `visual-index.md` | A map from interface questions to the annotated screenshots included in `images/`. |
| `images/` | Nine annotated PNGs covering the overview, sequencer, and Guided view for all seven modes. |

## Where to start

- For a sound-design goal, begin with `workflows.md`, then use `modes.md` and
  `controls.md` for the selected mode.
- For a question about what a mode does, begin with `modes.md`.
- For exact control behavior, parameter IDs, ranges, or automation, use
  `controls.md`.
- For non-Warp output headroom, use the Guided-only `Pre-Saturation Gain` control;
  Warp normally uses `Excitation Level`, while `Voice Ceiling` is the fixed
  per-voice safety stage shared by all modes.
- For the location of a control or screen, use `visual-index.md` and its local
  image links.
- For navigation keys, use `keyboard-shortcuts.md`.
- For kit credits and source metadata, use `attribution-json.md`.

## Reference rules

- Treat the text references as the source of truth for behavior. Screenshots
  establish interface location and visual context only.
- Annotation numbers are callouts, not parameter IDs.
- Prefer a concrete mode and first-pass recipe when several approaches could
  work; mention alternatives after giving the most direct starting point.
- Do not invent undocumented controls, values, locations, licenses, or
  attribution details.
- Extract the ZIP before opening `visual-index.md` so its relative image links
  resolve correctly.

## Scope

The screenshots show the desktop Guided/detail layouts captured from the real
Xoradora Release editor on 2026-08-26. They are not a complete reference for
compact, narrow, mobile, or host-specific layouts. The Markdown files packaged
with a particular ZIP describe the product state at the time that ZIP was
built; consult the current web manual for later updates.
