Files
youtube-generator/docs/FEATURES.md
T
poli0981andClaude Opus 5 08be7d1ff8 docs: correct the i18n guide's registration claim, document v0.35.0
**docs/I18N.md was wrong in a way that would waste a contributor's afternoon.**
It said adding a locale to `SUPPORTED_LANGUAGES` was "the only registration
step". It is one of four, and the missing ones fail differently: the
`SupportedLanguage` union is a compile error, `MULTILINGUAL_TAGS` is a compile
error, but `detectBrowserLanguage`'s own hardcoded copy of the list fails
*silently* — the language works and simply never auto-selects for a visitor
whose browser is set to it. Also noted: `SUPPORTED_LANGUAGES` is not type-bound
to the union and every consumer casts, so a mismatch compiles cleanly.

Also documents the `--copy-english` / `--force` flags on the locale generator,
which only started existing in v0.35.0 despite having been advertised in
package.json since v0.1.

Elsewhere:

- **DEVELOPMENT.md** — the five new npm scripts, including why `format:check`
  excludes markdown and locale JSON, and why `typecheck:all` exists.
- **TECH-SPEC.md** — the real CI job, a new Field Limits section, and how
  over-limit enforcement derives from the engine's long-ignored `warnings`.
- **ARCHITECTURE.md** — the settings→engine mapping and its two guards, the
  two-source validation state, and an honest note that the first Strict Mode
  implementation typechecked, passed tests, and did nothing.
- **FEATURES.md** — the settings table still listed `Default Genre` and
  `Auto-save Draft`, removed in v0.22.0 and v0.3. Replaced, plus a guardrails
  section.
- **README.md** — guardrails in the feature list, and a link to the wiki.

The wiki itself (12 pages: quick start, glossary, field reference, guardrails,
batch/social, import-export, languages, privacy, troubleshooting, FAQ, release
process) is published separately — it lives in its own repository.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-17 11:32:09 +07:00

15 KiB
Raw Blame History

Complete Feature List

YTDescGen — All Features (Current + Planned)


🎬 Video Types (20 types)

Twenty video types, each driving a dedicated description template, title structure, and tag bias. The complete table — every type with its icon and the extra fields the editor reveals — is in Content Inventory.

🌐 Languages (6 shipped)

All six locales ship today — UI strings and description templates fully translated and parity-validated by npm run validate:locales.

Code Language Native Name Status
en English English ✅ Shipped
vi Vietnamese Tiếng Việt ✅ Shipped
ja Japanese 日本語 ✅ Shipped
es Spanish Español ✅ Shipped
ko Korean 한국어 ✅ Shipped
zh Chinese (Simplified) 简体中文 ✅ Shipped

Further locales (French, German, Portuguese, Russian, Thai, Arabic) are tracked in Roadmap § 5.3.

Each language requires:

  • ui.json — UI labels, buttons, placeholders, error messages
  • templates.json — Title patterns, description sections, CTA text

🎮 Game Genres (41 genres)

Forty-one genres feed the title format, the tag pool, and (when configured in Settings → Genre Playlists) the pinned-comment playlist recommendation. The complete list — with icons and bulk-select groups — is in Content Inventory.

🛒 Store Platforms (9 platforms)

ID Label URL Prefix
steam Steam https://store.steampowered.com/app/
epic Epic Games Store https://store.epicgames.com/
ps PlayStation Store https://store.playstation.com/
xbox Xbox / Microsoft Store https://www.xbox.com/games/
nintendo Nintendo eShop https://www.nintendo.com/store/
gog GOG https://www.gog.com/game/
itchio itch.io https://itch.io/
humble Humble Bundle https://www.humblebundle.com/store/
amazon Amazon Luna https://www.amazon.com/luna/

Donate

ID Label Prefix
kofi Ko-fi https://ko-fi.com/
patreon Patreon https://patreon.com/
buymeacoffee Buy Me a Coffee https://buymeacoffee.com/
paypal PayPal https://paypal.me/
streamlabs Streamlabs https://streamlabs.com/

Social

ID Label Prefix
github GitHub https://github.com/
twitter Twitter / X https://x.com/
discord Discord https://discord.gg/
twitch Twitch https://twitch.tv/
tiktok TikTok https://tiktok.com/@
instagram Instagram https://instagram.com/
website Website —

💻 Rig Fields (8 fields)

ID Label Example
cpu CPU Intel i9-14900K / AMD Ryzen 9 7950X
gpu GPU NVIDIA RTX 4090 / AMD RX 7900 XTX
ram RAM 32GB DDR5-6000
storage Storage 2TB Samsung 990 PRO NVMe
motherboard Motherboard ASUS ROG Maximus Z790
monitor Monitor LG 27GP950 27" 4K 144Hz
capture Capture Software OBS Studio 30.x
controller Controller DualSense / Xbox Elite Series 2

📄 Output Sections (Description Structure)

Mỗi ngôn ngữ có description structure như sau (tất cả sections optional):

1. Intro line (auto-generated from video type + game name)
2. No Commentary tagline
3. ─── Timestamps ─── (if provided)
4. ─── Store Links ─── (if any platform link provided)
5. ─── Video Settings ─── (resolution / FPS / graphics)
6. ─── My Rig ─── (if any rig field provided)
7. ─── Content Warnings ─── (if any selected — 248 IDs across 12 groups)
8. ─── Donate Links ─── (if any provided)
9. ─── Social Links ─── (if any provided)
10. ─── Playlist Link ─── (if provided)
11. ─── Contact Email ─── (if provided)
12. CTA line (Like / Subscribe / Share)
13. Hashtags (3 max, auto-generated)

🔁 Cross-Post Captions (Social tab)

A dedicated Social tab re-packages the same editor source that drives the YouTube description into short-form captions for other platforms — no re-typing. Each caption is derived live from the current form.

Platform Caption limit Popular hashtags appended
TikTok 4,000 #fyp #foryou #foryoupage #gaming #gamingtiktok #gameplay #gamer
Instagram Reels 2,200 #reels #reelsinstagram #gaming #gamingreels #gamer #instagaming #videogames
Facebook Reels 2,200 #reels #facebookreels #fbreels #gaming #gameplay #gamingcommunity #videogames

Each caption pulls, in order: Title (quality badge suppressed for short-form), My Rig, Content Warnings, Thanks / sponsor credit, Copyright, and hashtags (game + primary genre + the curated per-platform popular set, deduplicated case-insensitively).

  • Overflow handling — when a caption exceeds the platform limit, optional blocks are dropped in priority order (warnings → copyright → thanks → rig). The title and the hashtag line are never dropped, and there is no mid-string truncation.
  • Single mode — platform tabs with a live character counter and over-limit warning.
  • Bulk mode — generate a part range (e.g. Parts 1–10) across selected languages in one pass, reusing the Batch loop.
  • Import / Export — round-trip the generated captions as a typed JSON bundle (_type: "social"); import is display-only since captions are derived artifacts (the source round-trips via Profiles / Presets).

🏷 Tag Generation

Tag Pools by Category

Pool Triggered By Sample Output
Core Always [game] gameplay, [game] no commentary, gameplay no commentary
Genre Genre selection horror game no commentary, RPG gameplay no commentary
VideoType Video type [game] boss fight, [game] speedrun, [game] all endings
Platform Platform field [game] PC, PC gameplay, [game] Steam
Quality Resolution/FPS [game] 4K, 4K gameplay no commentary, [game] 4K 60FPS
Multilingual JA Always [game] ゲームプレイ, [game] 実況なし
Multilingual VI Always [game] gameplay không bình luận
Multilingual ES If ES enabled [game] sin comentarios, juego de acción
Trending Always [game] 2026, best [genre] games 2026

Tag Pipeline

  1. Collect tags from all applicable pools
  2. Deduplicate (Set-based)
  3. Priority sort (core first, trending last)
  4. Trim to 500 character limit (drop lowest priority first)
  5. Output as comma-separated string

💾 Data Persistence

Profile (saved once, reused always)

interface Profile {
  id: string;            // uuid
  name: string;          // "Main Channel"
  channelName: string;
  contactEmail: string;
  social: Record<string, string>;
  rig: Record<string, string>;
  resolution: string;
  fps: string;
  graphicsPreset: string;
  createdAt: string;
  updatedAt: string;
}

Game Preset (saved per game, reused for all parts)

interface GamePreset {
  id: string;
  gameName: string;
  gameNameLocalized?: Record<string, string>;
  genre: Genre;
  platform: string;
  storeLinks: Record<string, string>;
  spoilerWarning: boolean;
  matureWarning: boolean;
  createdAt: string;
}

History Entry (auto-saved per generation)

interface HistoryEntry {
  id: string;
  gameName: string;
  videoType: VideoType;
  language: SupportedLanguage;
  title: string;
  description: string;
  tags: string;
  createdAt: string;
}

⌨️ Keyboard Shortcuts

Shortcut Action
Ctrl+Enter Generate output (switch to Output tab)
Ctrl+Shift+C Copy all (title + description + tags)
Ctrl+Shift+T Copy title only
Ctrl+Shift+D Copy description only
Ctrl+Shift+G Copy tags only
Ctrl+S Save current form as draft
Ctrl+P Quick-switch profile
Ctrl+/ Show keyboard shortcuts
Escape Close modal / clear selection

🔧 Settings

Setting Type Default Description
Theme dark / light dark App color theme
App Language SupportedLanguage browser-detected Language of the interface
Default Output Language SupportedLanguage en Pre-selected for new drafts
Show Character Count boolean true Display char counters on output. Does not affect copy blocking
Compact Tag Display boolean false Tags as comma list vs chip display
Strict Mode boolean false v0.35.0. Blocks Generate / Copy / Export while any field has a hard error
History Limit number 100 Max history entries to keep
Log Retention 1–90 days 7 Log files older than this are deleted at boot
Include Multilingual Tags boolean true Add per-language tags to tag output
Include Trending Tags boolean true Add year-based trending tags
Hashtag Count 1-3 3 Number of hashtags to generate
Genre Playlists map {} One playlist URL per genre (42), collapsed by default

Default Genre and Auto-save Draft were removed in v0.22.0 and v0.3 respectively — the draft autosaves unconditionally, so the toggle was dead.

Description toggles

showCopyright · showUsagePolicy · showSponsorCredit · showGameCopyright · showThirdPartyAds · showTranslationQuality · splitContactEmail · showPinnedCommentTemplate · pinnedCommentIncludeAskNextGame · pinnedCommentIncludeGenrePlaylist

🛡 Guardrails (v0.35.0)

Three independent mechanisms. The first two are always on.

Mechanism Scope
Character limits Title 100 / description 5,000 / tags 500. If any one is over, no field can be copied — on Output and Batch. Batch scopes per part; Copy All Batch blocks if any part is over
Field limits Hard maxLength per category: URL 200, email 320, short name 100, label 300, long text 2,000, timestamps 5,000, numeric 10. Imported values are clamped too
Strict Mode Opt-in. Blocks Generate / Copy / Export on hard errors only; warnings (e.g. a working link on a non-standard prefix) never block. Log export is exempt

Emails are capped at three per field, enforced on the increase so an over-cap legacy value stays editable. Invalid input is never committed to the store, so a malformed URL cannot reach the generated description whether Strict Mode is on or off.

🖥 Desktop App Features (Tauri)

Feature Description
System Tray Minimize to tray, quick access
Native Clipboard Direct clipboard write (no browser permission)
File Export Save outputs as .txt / .json to file system
File Import Import profiles/presets from JSON file
Auto-update Tauri updater (check GitHub releases)
Offline Full functionality without internet
Global Hotkey System-wide hotkey to open app (optional)

📱 Android App (v0.29)

An installable, sideloadable .apk built from the same Tauri 2 codebase — no separate mobile project. Build with cargo tauri android build --apk; see PACKAGING.md.

Feature Description
Same codebase One Tauri 2 project produces web, desktop, and Android
Min version Android 11+ (minSdk 30); targetSdk 36 (Android 16)
Tested Android 11 → 16 (emulators); real device on Android 12
Signed APK Self-signed release APK for sideloading; CI publishes it to GitHub Releases
Responsive UI Drawer navigation, touch-sized controls, safe-area insets
File export Routed through the WebView download (lands in Downloads) on Android
Persistence App-private data dir (appDataDir()) + localStorage; works offline
No tray Desktop-only tray / single-instance are #[cfg(desktop)]-gated out

🚦 Error Pages & Offline (v0.27)

A single reusable, fully-localized ErrorPage component (src/components/errors/) backed by a pure kind→meta config (src/config/error-pages.ts). All copy ships in every locale (en/vi/ja/es/ko/zh).

Kind Route Trigger
404 Not found catch-all * A mistyped / dead hash route (live — was a blank screen before)
403 Forbidden /#/403 Designed page, route-reachable for future triggers
419 Expired /#/419 Designed page, route-reachable for future triggers
500 Server error /#/500 Designed page (covers 408/5xx), route-reachable for future triggers
Offline /#/offline + banner navigator.onLine flips false
Runtime crash — A render error caught by ErrorBoundary (shared contained variant)
  • Full-screen, no shell — dedicated error routes render outside AppShell (no Sidebar/Header), with Home / Back / (Reload) / Report-a-bug actions.
  • Non-blocking offline banner — a dismissible bottom strip; the app stays fully usable offline, and a toast confirms when the connection returns.

A first-run consent gate (src/components/ConsentGate.tsx, backed by the pure src/config/legal.ts) blocks the app until the user reviews the legal documents and ticks one "I agree" checkbox.

Aspect Behaviour
Documents Terms of Use, Privacy Policy, Disclaimer, License — linked to the GitHub-hosted copies (open in the browser); also surfaced in About → Legal
Acceptance One combined checkbox; Continue disabled until checked
Persistence Stored in the existing settings record (legalConsentVersion + timestamp) — no cookie, no new storage key
Re-prompt Version-based — only when CURRENT_TERMS_VERSION is raised (terms changed); also re-shows in fresh / incognito storage
Desktop Same in-app gate on Windows/macOS/Linux, plus a license-acceptance page in the Windows MSI/NSIS installer (bundle.licenseFile)
Layout Full-screen, non-dismissible, theme- and locale-aware (all 6 languages)

🔌 Future Extension Points

Extension Description Effort
VS Code Extension Command palette → generate description Medium
CLI Tool ytdesc generate --game "Elden Ring" --type full --lang en Low
Browser Extension Right-click on YouTube Studio → auto-fill High
YouTube API Auto-apply description to video via API High
Template Marketplace Share/import community templates Medium
AI Tag Suggestions Use game name to suggest trending tags Medium
Thumbnail Text Generate text overlay suggestions for thumbnails Low
Multi-channel Support multiple YouTube channels per profile Low