# 03 — Repository Layout

```
Vocal10n/
├── README.md                  # User-facing quick start.
├── LICENSE                    # MIT.
├── pyproject.toml             # Package metadata for `vocal10n`.
├── setup_env.ps1              # Creates venv_main + venv_tts, installs deps.
├── start.ps1 / start.bat      # Launches GPT-SoVITS subprocess + main app.
├── initialplan.md             # Original project plan (Chinese + English).
├── promptfile.md              # Prompt history / scratchpad.
├── simple_ui_plan.md          # Simple/Pro mode design doc.
├── simple_ui_validation.md    # Manual QA checklist for Simple mode.
├── current.logs               # Last run log capture (transient).
│
├── config/
│   ├── default.yaml           # Single source of truth for runtime config.
│   ├── context_gaming.txt     # Example domain context for translation.
│   └── filters.txt            # Hallucination filter list.
│
├── knowledge_base/
│   └── glossary_general.txt   # Default glossary used by the corrector.
│
├── stt_terms/
│   └── context_gaming.txt     # Example STT initial-prompt term list.
│
├── reference_audio/           # User-provided voice clone references.
│   ├── audio_03.txt
│   └── README.md
│
├── models/                    # Local model storage (git-ignored).
│   ├── stt/                   # FasterWhisper caches.
│   ├── llm/Qwen3-4B-Instruct-2507.Q4_K_M.gguf
│   └── tts/                   # GPT-SoVITS pretrained weights.
│
├── output/
│   ├── audio/                 # WAV recordings (when save_wav).
│   ├── subtitles/             # *_source.srt / *_target.srt pairs.
│   └── training_data/         # Future training output.
│
├── requirements/
│   ├── requirements-main.txt  # venv_main deps.
│   └── requirements-tts.txt   # venv_tts deps (in addition to vendor reqs).
│
├── src/vocal10n/              # Application package — see chapter 02.
├── src/vocal10n.egg-info/     # Generated by editable install.
│
├── vendor/
│   ├── GPT-SoVITS/            # Vendored upstream repository.
│   └── Qwen3/                 # Vendored Qwen3-TTS source.
│
├── venvs/
│   ├── venv_main/             # Python 3.11 — STT + LLM + UI.
│   ├── venv_tts/              # Python 3.11 — GPT-SoVITS server.
│   └── venv_qwen3tts/         # Python 3.10/3.11 — Qwen3-TTS server.
│
├── temp_qwen3tts/             # Scratch dir used during Qwen3-TTS bring-up.
├── training/                  # Reserved for future training tooling.
│
├── Vocal10n-prebuild/         # Legacy reference implementation. Not packaged.
└── doc/                       # This documentation set.
```

## Notable Conventions

- **`src/` layout** with `pyproject.toml`. Install with
  `pip install -e .` inside the venv (the setup script does this for you
  via the requirements file pulling in the package).
- **One YAML config.** `config/default.yaml` is the only config file
  loaded at runtime. UI changes that should persist write back here.
- **Vendored models, not submodules.** GPT-SoVITS lives under
  `vendor/GPT-SoVITS/` to pin a known-good revision and to avoid a
  network dependency at install time.
- **Output filenames** are `YYYY-MM-DD_HH-MM-SS_source.srt` /
  `_target.srt`, so each session is grouped by start timestamp.
