From 0f767b7a33fb2c254368439322e0d728860f8d42 Mon Sep 17 00:00:00 2001 From: ramforth Date: Mon, 3 Nov 2025 12:37:39 +0100 Subject: [PATCH] Update INSTALLATION.md with instructions for compiled executable. --- INSTALLATION.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/INSTALLATION.md b/INSTALLATION.md index 134f23b..5e34657 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -54,6 +54,38 @@ This document provides detailed instructions for setting up and running the `pyt 4. **Save Chat Log:** To exit the script gracefully, press `Ctrl+C`. You will then be prompted if you want to save the chat log. +## Installation and Usage (Compiled Executable) + +For users who prefer a standalone application without needing to install Python or manage dependencies, a compiled executable is available for Linux. + +1. **Download the Executable:** + * Go to the [Gitea Releases page](https://gitea.ramforth.net/ramforth/youtube-chat-webhook-v2/releases). + * Download the `pytchat_listener` executable from the latest release (e.g., `v0.1.0-alpha`). + +2. **Make Executable:** + * Open your terminal and navigate to the directory where you downloaded the executable. + * Make the file executable: + ```bash + chmod +x pytchat_listener + ``` + +3. **Run the Executable:** + * Execute the program directly: + ```bash + ./pytchat_listener + ``` + +4. **Enter Video ID:** + * The program will prompt you to "Enter the YouTube Live Stream Video ID:". Paste the 11-character ID of the live stream you wish to monitor and press Enter. + +5. **Observe Chat:** + * The program will then start fetching and displaying live chat messages in your terminal. + +6. **Save Chat Log:** + * To exit the program gracefully, press `Ctrl+C`. You will then be prompted if you want to save the chat log. + +**Note:** This executable is compiled for Linux. If you are on a different operating system (e.g., Windows, macOS), you will need to follow the "Installation Steps" above to run the script from source. + ## User Colors Persistence (`user_colors.json`) The script assigns unique, persistent colors to chatters. This mapping is stored in a file named `user_colors.json` in the project directory.