Menu ▾ ▴

Tree [487660] main /
 History

HTTPS git://
HTTPS access

File Date Author Commit
 .github 2025-09-16 YouG-o YouG-o [487660] v0.1.0
 assets 2025-09-15 YouG-o YouG-o [408199] Build script update,
 src 2025-09-15 YouG-o YouG-o [408199] Build script update,
 .gitignore 2025-09-12 YouG-o YouG-o [63b9b2] feat: Added automated Windows portable build sc...
 CHANGELOG.md 2025-09-16 YouG-o YouG-o [487660] v0.1.0
 LICENSE 2025-08-27 YouG-o YouG-o [1ceb9c] feat: implement main UI with channel table and ...
 README.md 2025-09-16 YouG-o YouG-o [487660] v0.1.0
 build-windows-portable.bat 2025-09-15 YouG-o YouG-o [73e3ba] Windows build workflow
 pom.xml 2025-09-12 YouG-o YouG-o [63b9b2] feat: Added automated Windows portable build sc...

Read Me

[![Release Version](https://img.shields.io/github/v/release/YouG-o/StreamWarden?style=flat&logo=github&color=2ea44f)](https://github.com/YouG-o/StreamWarden/releases/latest) [![Github Stargazers](https://img.shields.io/github/stars/YouG-o/StreamWarden?style=flat&logo=github&color=f9d71c)](https://github.com/YouG-o/StreamWarden/stargazers) [![Github Contributors](https://img.shields.io/github/contributors/YouG-o/StreamWarden?style=flat&logo=github&color=blue)](https://github.com/YouG-o/StreamWarden/graphs/contributors) ![LICENSE](https://img.shields.io/github/license/YouG-o/StreamWarden?label=&style=flat&logo=license&logoColor=white&color=3da639)

![StreamWarden icon](./assets/images/app_icon.png) # StreamWarden : Auto Stream Recorder Desktop app to automatically monitor Twitch / YouTube / Kick channels and record livestreams as soon as they go live.

## 🚀 Install

Windows users:
You can download the latest pre-built portable version of StreamWarden directly from the latest release.

No installation required!
The portable zip contains everything you need:
- Java runtime (no need to install Java)
- Streamlink (no need to install it separately)
- All required native dependencies
Just unzip and run the executable on any recent Windows system.

Other platforms (Linux, MacOS):
You need to build the application yourself.
See the Build it yourself section below for instructions.

## Features:
  • Multi-Platform Support: Monitor Twitch, YouTube and Kick channels simultaneously
  • Automatic Detection: Start recording immediately when streams go live
  • Custom Quality Settings: Choose recording quality per channel (best, 1080p, 720p, etc.)
  • Organized Storage: Recordings are automatically sorted by channel in separate folders
  • Cross-Platform: Works on Windows and Linux with automatic tool detection
The application uses Streamlink under the hood for reliable stream capture and supports automatic monitoring with customizable check intervals.
## Screenshot:
![App screenshot](./assets/images/app_screenshot.png)

# Build it yourself

Clone the repository

# Clone the repository
git clone https://github.com/YouG-o/StreamWarden.git
cd StreamWarden

Then choose the method that fits your needs:

1. Development Build (Cross-platform)

Prerequisites

  • Java Development Kit (JDK) 22 or higher
  • Maven 3.6+
  • Streamlink installed on your system (7.3.0 or higher for Kick support) (tested on 7.6.0)
  • Python (required by Streamlink)

Installation & Run

# Build and run the application in development mode
mvn clean javafx:run

This will launch the app directly from source.
You must have Streamlink and Python installed and available in your system PATH.

2. Windows: Build a Portable Executable

If you are on Windows, you can generate a portable .exe version of StreamWarden using the provided batch script:

build-windows-portable.bat

This script will:
- Automatically download and prepare all required native dependencies (Streamlink portable, JavaFX & Maven)
- Build the application with Maven
- Package everything into a portable app-image using jpackage

How to use:

  1. Make sure you have the Java Development Kit (JDK) 22 or higher.
  2. Open a terminal in the project root directory.
  3. Run the script
  4. After completion, you will find the portable executable in the StreamWarden_Win_Portable folder.

# Contributors: Contributions are welcome! Whether you want to fix bugs, add features, or improve documentation, your help is appreciated.

# Support This Project

This application is completely free and open-source. If you find it valuable, you can support its development with a pay-what-you-want contribution!


[![Support me on Ko-Fi](./assets/images/support_me_on_kofi.png)](https://ko-fi.com/yougo) [![Support with Cryptocurrency](https://img.shields.io/badge/Support-Cryptocurrency-8256D0?style=for-the-badge&logo=bitcoin&logoColor=white)](https://youtube-no-translation.vercel.app/?donate=crypto)


You can also support this project by:

  • Starring this repository
  • Sharing it with others who might find it useful
  • Following me on GitHub

# Legal Notice ⚠️ **Important:** Before recording any stream, make sure you have the creator's permission or that the content is not protected by copyright. Always respect the terms of service of streaming platforms (Twitch, YouTube, etc.). This software is provided for educational and personal use only. I do not encourage copyright infringement and cannot be held responsible for improper use of this application. # LICENSE This project is licensed under the [GNU Affero General Public License v3.0](LICENSE)