# Phaeton — Beta Testing Guide

**Phaeton — Key Tracking Saturator.** Two saturation bands whose zones **follow the note you play**
(pitch tracking from audio or MIDI). The idea: harmonics are always added in a musically
meaningful place relative to the pitch, not at a fixed frequency.

Build version: **v1.0.0-beta.1** (shown in ⚙ Settings — please include it in bug reports).

---

## Requirements

- macOS 11 (Big Sur) or newer
- Apple Silicon **or** Intel (universal binary)
- Formats: **AU** and **VST3**
- ⚠️ **No AAX (Pro Tools) in this beta.** Logic, Ableton, Cubase, Reaper, Studio One, Bitwig, FL — yes.

---

## Installation

Open `Phaeton-Installer.pkg` → follow the steps. It installs two plugins system-wide
(admin password required):

| Plugin | What it is |
|---|---|
| **Phaeton** | the saturator itself — use as an audio insert |
| **Phaeton MIDI** | MIDI companion, needed only for MIDI mode in Logic (see below) |

### If macOS says "unidentified developer"

The beta is **not Apple-signed yet** (certificate in progress). It is not a virus — Gatekeeper
simply blocks anything downloaded without a Developer ID. Workaround:

1. Remove quarantine from the downloaded file:
   ```bash
   xattr -dr com.apple.quarantine ~/Downloads/Phaeton-Installer.pkg
   ```
2. Open the `.pkg` with **right click → Open** (not double click) → click "Open".
3. If your DAW doesn't see the plugin after installing, also clear quarantine on the installed bundles:
   ```bash
   sudo xattr -dr com.apple.quarantine /Library/Audio/Plug-Ins/Components/Phaeton.component
   sudo xattr -dr com.apple.quarantine "/Library/Audio/Plug-Ins/Components/Phaeton MIDI.component"
   sudo xattr -dr com.apple.quarantine "/Library/Audio/Plug-Ins/VST3/Perfect Pitch Audio"
   ```
4. Restart your DAW.

**Logic doesn't show the plugin?** Logic caches AU validation results. Reset the cache:
```bash
killall -9 AudioComponentRegistrar 2>/dev/null; rm -f ~/Library/Caches/AudioUnitCache/com.apple.audiounits.cache
```
then restart Logic.

---

## MIDI mode (the MIDI button)

By default the zones follow the pitch detected **from audio**. For sample-accurate tracking
from notes, enable `MIDI`:

- **Logic:** put **Phaeton MIDI** in the MIDI FX slot of the same track, and **Phaeton**
  as an audio insert. The `LINK` number must match on both.
- **FL Studio:** use the **VST3** version (AU does not receive MIDI in FL). Route notes with
  a MIDI Out channel (set its Port) and set the same **MIDI Input port** in Phaeton's FL
  wrapper settings (gear icon). The companion plugin is not needed.
- **Ableton / Cubase / Reaper and others:** route a MIDI track's output directly to Phaeton
  on the audio track. The companion plugin is not needed.

With MIDI mode on, `LOOKAHEAD` turns off automatically (MIDI notes are exact — no latency needed).

---

## What to test first

1. **Tracking.** Does the zone follow the note on your material (vocals, bass, guitar, synth)?
   Where does it break / jump an octave / wobble?
2. **LOOKAHEAD.** Adds **90 ms of latency** when on (your DAW compensates during playback).
   Check: do zones lock onto attacks more precisely, especially on low notes?
   Turn it off for live playing/recording.
3. **DELTA.** Solos only what the plugin **adds**. It is a true difference: lots of
   saturation → loud, a little → quiet, nothing → silence. If a band sits where the signal
   has no energy, its delta is empty — that's correct.
4. **CPU** on your projects (how many instances you can run).
5. **Presets, undo/redo, A/B, saving your own presets.**
6. **Parameter automation**, project save/restore, bounce/export.

---

## Trial: 30 days

After 30 days the plugin **does not mute** — your projects keep playing and rendering
exactly the same. Only **editing** gets locked: settings freeze as they are, and a banner
appears: `TRIAL EXPIRED · SETTINGS LOCKED · AUDIO KEEPS WORKING`.

Days remaining are shown in ⚙ **Settings → LICENSE**.
Your **Machine ID** is there too — send it to us and we'll issue you an unrestricted key.
Enter the key via **Settings → LICENSE → ENTER KEY**.

---

## Reporting issues

The more specific, the faster the fix. Template:

```
Plugin version:  (⚙ Settings, e.g. v1.0.0-beta.1)
Format:          AU / VST3
DAW + version:   e.g. Logic Pro 11.1.2
macOS + chip:    e.g. 15.3, M2 Pro
Sample rate / buffer: e.g. 48 kHz / 256

What I did:
What I expected:
What happened:
```

Also very helpful:
- A **screenshot** of the plugin window when the issue happens.
- If it **crashed** — attach the crash log from `~/Library/Logs/DiagnosticReports/`
  (file mentioning `Phaeton` or your DAW's name).
- For **sound** issues — a short audio example / screenshot of the band settings.

---

## Uninstall

```bash
sudo rm -rf /Library/Audio/Plug-Ins/Components/Phaeton.component \
            "/Library/Audio/Plug-Ins/Components/Phaeton MIDI.component" \
            "/Library/Audio/Plug-Ins/VST3/Perfect Pitch Audio"
rm -rf ~/Library/Phaeton          # presets and trial data
```

---

Thanks for testing. — Perfect Pitch Audio
