Checklist Reader – Your Voice-Controlled Copilot for MSFS 2024

Checklist Reader – Version 1.0.14.14 This update significantly streamlines the installation and setup process, enhances the Companion with window management and refresh-rate optimization, and adds comprehensive diagnostics for voice performance. The goal is to reduce setup friction, improve Companion usability on all system types, and give users full visibility into voice rendering performance. Important: All existing checklists and checklist bundles remain fully compatible. No migration is required. -------------------------------------------------- Installation & Setup Simplified Installation This version introduces a radically simpler setup process that handles the most complex parts automatically — you no longer need to manually integrate the Companion or worry about data loss. The installer now: • Automatically backs up your entire existing installation (if upgrading) • Automatically extracts and integrates the Companion into your MSFS 2024 Community folder (if you provide the path during setup) • Shows you a detailed summary of what will happen before installation begins • Leaves your custom data (checklists, maps, bundles) completely untouched Bilingual Installation (English & Deutsch) The installer is now fully available in two languages: • Automatic detection: Your Windows language settings determine the default installation language (English or Deutsch) • Manual override: You can change the language at any time during setup • Both language versions are included in a single installer — no need to download a separate version Important: The installer is bilingual, but the Checklist Reader application itself remains English-only. All voice input recognition, voice output announcements, and available voices are in English only. The app cannot process other languages. Mandatory Data Protection When you install over an existing setup: • The entire Checklist_Reader folder is automatically backed up with a date/time suffix (e.g., "Checklist_Reader_2024-07-07_22-36-14") BEFORE any new files are copied. This happens without asking — it is mandatory. • Your backups accumulate over time, so periodically clean up old backup folders if disk space becomes a concern. Folder Strategy: Maps & Bundles The setup treats user-data folders carefully: • Checklist_Reader_Maps: If this folder already exists, the setup leaves it completely untouched — all your custom maps and cached tiles remain. If the folder is missing, it is created and the included world map is installed. • Checklist_Reader_Bundels: If this folder exists, it is never touched. If it does not exist, it is created so you can immediately add bundle files. The setup does not manage or modify any bundles. Important: Still Your Responsibility While the setup now protects folders automatically, you remain responsible for protecting your own data. If the installer fails unexpectedly: • Keep external backups of critical files (important checklists, custom maps, bundles). • If you have customized your MSFS panel ("Companion"), back it up separately before installation in case the automatic replacement does not work as expected. • Use the standard installation paths (AppData\Roaming) where the installer expects them. Custom paths are not officially supported. Before You Install: The Setup Summary Before installation begins, the Setup shows you a detailed summary of what will happen: • Whether the app folder will be backed up (or if it is a fresh install) • Whether maps folder will be created or left alone • Whether the Companion will be installed, replaced, or skipped Review this summary carefully. If something looks wrong, cancel and check your folders. Standard Installation 1. Run the installer. 2. Use the default paths (recommended). If you must use custom paths, ensure they match your app configuration. 3. Review the "Folders and data protection" summary on the "Ready to Install" page. 4. Click "Install" — the backup will be created automatically. Companion Installation (EFB Panel in MSFS) Option 1 (Automatic, Recommended) If you provide your MSFS 2024 Community folder path during installation, the Companion will be automatically extracted and replaced with the new version (old version removed). No manual steps required. Option 2 (Manual) If you skip the automatic installation, the Companion ZIP file is located at: AppData\Roaming\Checklist_Reader\ChecklistReader-Companion-MSFS2024 Extract the included ZIP file and place the resulting folder into your MSFS 2024 Community folder, or link it via your preferred Add-on Linker (MSFS Addons Linker is supported). -------------------------------------------------- Companion Window Management & Refresh-Rate Optimization New Window Controls The Companion panel (EFB in MSFS) now provides full window management: • Minimize: Reduce the Companion window to save screen space while keeping it instantly accessible. Minimized state is remembered across sessions. • Detach / Pop Out: Open the Companion in your default web browser as a standalone window. This is useful if you prefer a second monitor for the Companion or want to customize its position and size independently of the MSFS panel. • Close Button: Close the Companion directly from the panel itself without needing to navigate back to the menu. Perfect for quick dismissal during flight. Configurable Companion Refresh Rate The Companion now adapts to your system's capabilities: • Balanced (~500 ms) — Default. Responsive updates with efficient system resource use. Recommended for most systems. • Fastest (~250 ms) — For powerful systems. Data updates nearly instantly, perfect if you want to see live changes with zero perceptible delay. • Economical (~750 ms) — For slower systems. Reduces CPU load while keeping updates frequent enough to feel responsive. • Relaxed (~1.25 s) — For very slow systems. Minimizes overhead on older hardware or virtual machines. • Minimal (~2.5 s) — For extremely constrained systems. Updates only when necessary. Configure this in Full Configuration → SimConnect → "Companion Refresh Rate". Choose the fastest setting your system can handle without stuttering in the simulator. -------------------------------------------------- 🔊 Voice Output Performance & Diagnostics Real-time TTS Performance Monitoring - The app now measures how long each voice announcement takes to render and play. If any announcement exceeds 3 seconds, a detailed warning is logged with timing breakdowns (queue time vs. rendering time). - The watchdog system ensures that slow voices are never abruptly cut off mid-sentence. Instead, they are allowed to complete naturally while the app monitors for genuine hangs (10+ seconds without any synthesis progress). - This gives you exact insight into whether delays are caused by your voice selection, audio device configuration, or other factors. Voice Performance Test Tool New diagnostic tool available in Quick Configuration → TTS Pacing → "🔊 Voice Performance Test" What It Does: - Tests all installed English voices (Microsoft built-in voices + any third-party TTS voices you have installed) to measure how long each one takes to render a typical checklist announcement. - Tests run silently — no audible output so you can test without disrupting flight. - Rates each voice: ✅ OK (< 1 second) — Crisp, responsive announcements 🟡 Slow (1–3 seconds) — Noticeable but acceptable delays 🔴 Very slow (3–8 seconds) — Significant delays; consider switching ❌ Not responding (timeout > 8 seconds) — Voice is broken or unavailable Why This Matters: - Different voices render at very different speeds depending on your system and the installed TTS engine. A premium third-party voice might be slower than a built-in Microsoft voice on your hardware. - By testing, you can choose a voice that balances quality and responsiveness for YOUR specific system. - Identifies voices that are installed but not working, so you don't discover the problem during an active flight. How to Use: 1. Open the test dialog (Quick Config → TTS Pacing → "🔊 Voice Performance Test") 2. Click "Run Test" to measure all voices 3. Review the results table — fastest voices are listed first 4. Click "Play sample" to hear any voice you're considering 5. Select a voice and click "Use this voice" to apply it immediately without restarting 6. Close the test dialog; your new voice is now active System-Level Optimizations - Rewrote the logging system to use a single persistent file writer instead of opening and closing the log file for every single line. This eliminates hundreds of file operations at startup, reducing overhead significantly on systems with active antivirus scanning, cloud-synced AppData folders, or slower disks. - Added file-level caching for checklist validation: the menu no longer re-validates the entire library (~180 files) on every open. Only files that have actually changed are re-checked, speeding up menu navigation by 2–5 seconds on slower systems. - Cleared the TTS queue before section startup to prevent old menu prompts from piling up ahead of checklist titles and first items. User Feedback Improvements - Voice selection hotkeys ("select voice", "change voice", "switch voice") now provide clear feedback when pressed in an invalid context (e.g. during an active checklist). Instead of silently ignoring the command, the app now tells you that voice selection is only available in the main menu — both via console message and spoken announcement. Other - Updated internal diagnostics and logging infrastructure - Version incremented from 1.0.14.13 to 1.0.14.14 -------------------------------------------------- Community & Support The Checklist Reader is an actively evolving project, and feedback is always welcome. Join the community on Discord: https://discord.gg/EchPmVtueY For further support: simflightchris@gmail.com