YT Live Streamer - Windows Edition
Version 2.2.7  (Phase 1 - core features)
=========================================


WHAT THIS IS
------------
A Windows build of YT Live Streamer. Phase 1 brings the full core to Windows:
playlist streaming to YouTube/RTMP, scheduler, download manager, YouTube
search, AI playlist builder, remote API, multi-RTMP, overlays, recording,
chapters, trimmer, SFTP manager, and the player website.

NOT included on Windows yet (Phase 2):
  Webcam / capture card input
  Screen share input
  Picture-in-picture overlay
These use Linux video capture (V4L2/X11) and need a Windows rewrite
(DirectShow/gdigrab) which is planned for Phase 2.


=========================================================================
 STEP 1 - INSTALL PYTHON
=========================================================================

  1. Download Python 3.10 or newer:
       https://www.python.org/downloads/windows/

  2. Run the installer.

  3. IMPORTANT: On the first screen, TICK the box
       "Add python.exe to PATH"
     before clicking Install. If you miss this, the app won't start.

  4. Use the official python.org installer, NOT the Microsoft Store
     version - the Store build can have tkinter issues.

  To verify: open Command Prompt and type:
       python --version
  You should see "Python 3.10.x" or similar.


=========================================================================
 STEP 2 - INSTALL FFMPEG
=========================================================================

  ffmpeg does the actual streaming. Pick ONE method:

  Method A - winget (easiest, Windows 10/11):
       Open PowerShell and run:
         winget install Gyan.FFmpeg
       Close and reopen your terminal afterwards.

  Method B - Chocolatey (if you have choco):
         choco install ffmpeg

  Method C - Manual:
       1. Download from https://www.gyan.dev/ffmpeg/builds/
          (get the "release full" build, a .7z or .zip)
       2. Unzip to somewhere permanent, e.g. C:\ffmpeg
       3. Add C:\ffmpeg\bin to your PATH:
          - Search "Edit the system environment variables"
          - Environment Variables -> Path -> Edit -> New
          - Add: C:\ffmpeg\bin
          - OK out of all dialogs, reopen your terminal

  To verify: open a NEW Command Prompt and type:
       ffmpeg -version
  You should see version info, not "not recognized".


=========================================================================
 STEP 3 - RUN THE APP
=========================================================================

  1. Keep all these files together in one folder:
       streamer.py
       start_streamer.bat
       streamer_plugins\   (the whole folder)

  2. Double-click  start_streamer.bat

  The launcher will:
    - check Python and tkinter
    - check ffmpeg (warns if missing)
    - install yt-dlp automatically via pip if needed
    - check optional plugin packages
    - launch the app

  If a check fails, the window stays open so you can read the message.


=========================================================================
 STEP 4 - PLUGIN PACKAGES (optional)
=========================================================================

  Some plugins need extra Python packages. Install the ones you want
  in Command Prompt:

    pip install flask        (Remote Control API)
    pip install psutil       (Health Monitor - accurate CPU/RAM)
    pip install websockets   (Player website chat server)
    pip install paramiko     (SFTP Manager)

  For My Channel (YouTube OAuth):
    pip install google-auth google-auth-oauthlib google-api-python-client

  You can install them all at once:
    pip install flask psutil websockets paramiko google-auth google-auth-oauthlib google-api-python-client


=========================================================================
 WHERE YOUR FILES ARE SAVED
=========================================================================

  On Windows, the app stores data in your user folder:
    C:\Users\YourName\.yt_live_streamer_settings.json
    C:\Users\YourName\.yt_live_streamer_playlists\
    C:\Users\YourName\.yt_live_streamer_schedule.json
    C:\Users\YourName\streamer_plugins\   (if you move plugins here)
    C:\Users\YourName\Downloads\ai_streams\   (AI builder downloads)

  Note: the app looks for plugins in the folder next to streamer.py first.
  Keep the streamer_plugins folder beside start_streamer.bat.


=========================================================================
 PLUGINS INCLUDED (16)
=========================================================================

  remote_api.py            Remote control REST API
  download_manager.py      yt-dlp download queue
  scheduler.py             Weekly auto-stream schedule
  help_tab.py              Built-in help
  yt_search.py             YouTube search (needs API key)
  my_channel.py            Your channel dashboard (OAuth)
  health_monitor.py        Live stream health stats
  overlays.py              Watermark, ticker, lower-third, etc.
  stream_preview.py        Preview sidebar (preview works; screen/cam capture does not on Windows yet)
  chapter_markers.py       Live chapter markers
  video_trimmer.py         Trim videos without re-encoding
  multi_rtmp.py            Stream to several destinations at once
  recording.py             Record your stream locally
  ai_playlist_builder.py   Topic-to-playlist auto builder
  sftp_manager.py          Transfer/sync files with a VPS

  Not included (Phase 2 - capture):
    webcam.py, screenshare.py, pip_overlay.py


=========================================================================
 QUICK START - YOUR FIRST STREAM
=========================================================================

  1. Launch via start_streamer.bat
  2. Complete the Quick Setup wizard (enter your YouTube stream key)
  3. On the Stream tab, add video files to the playlist
  4. Click Start Stream

  Your stream key comes from YouTube Studio -> Go Live -> Stream settings.


=========================================================================
 KNOWN LIMITATIONS ON WINDOWS (PHASE 1)
=========================================================================

  - Webcam, screen share, and picture-in-picture inputs are not available
    yet (Phase 2). Playlist and RTMP-input streaming work fully.
  - Some short-lived helper processes (thumbnail/probe) may briefly flash
    a console window. The main stream does not.
  - The "open folder" buttons work in most places; a few may not yet.

  Everything else - playlist streaming, scheduling, downloads, search,
  AI builder, API, overlays, recording, multi-RTMP, SFTP, player website
  - works the same as on Linux.


=========================================================================
 TROUBLESHOOTING
=========================================================================

  "python is not recognized"
    Python isn't on PATH. Reinstall from python.org and tick
    "Add python.exe to PATH", or add it manually.

  "ffmpeg is not recognized" / streaming fails instantly
    ffmpeg isn't on PATH. See Step 2. Reopen the terminal after installing.

  App window opens then closes immediately
    Run start_streamer.bat (not streamer.py directly) so the error stays
    visible. Read the message in the window.

  A plugin tab is missing
    Make sure the streamer_plugins folder is next to start_streamer.bat,
    and that the plugin's required pip package is installed (see Step 4).

  Tkinter error on launch
    You may be on the Microsoft Store Python build. Uninstall it and
    install from python.org instead.


=========================================================================
 PLAYER WEBSITE (optional)
=========================================================================

  The player_website folder is for hosting a public stream page with chat.
  It's designed to run on a Linux VPS (nginx + RTMP). See
  player_website\README.txt. You can stream to it from Windows using the
  Multi-RTMP plugin by adding the VPS as a destination.


=========================================================================
 WORDPRESS CONTROL (optional)
=========================================================================

  The wordpress_plugin folder contains a WordPress plugin to control a
  streamer instance running on the same VPS. See its README.txt. This is
  for VPS deployments, not your local Windows machine.


For the full feature documentation shared with the Linux edition, see the
main project README.
