Skip to content

Commit 135518d

Browse files
authored
Revise README for clarity on StreamTweak usage
Updated README to clarify StreamTweak integration and project affiliation.
1 parent 1a5d52a commit 135518d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
[![Built on Moonlight](https://img.shields.io/badge/built%20on-Moonlight-blue?logo=github)](https://github.com/moonlight-stream/moonlight-qt)
2-
# 🎮 StreamLight
31

4-
**A Moonlight fork with StreamTweak integration to manage host NIC speed before streaming**
52

6-
> ⚠️ StreamLight is designed to be used exclusively in combination with [StreamTweak](https://github.com/FoggyBytes/StreamTweak). Without StreamTweak running on the host PC, the StreamTweak-specific features will not function.
3+
# 🎮 StreamLight [![Built on Moonlight](https://img.shields.io/badge/built%20on-Moonlight-blue?&logo=github)](https://github.com/moonlight-stream/moonlight-qt)
4+
5+
**A Moonlight fork with [StreamTweak](https://github.com/FoggyBytes/StreamTweak) integration to manage host NIC speed before streaming**
6+
7+
> 🚨 This project is not affiliated with or endorsed by the Moonlight project.
8+
9+
> ⚠️ StreamLight is designed to be used exclusively in combination with [StreamTweak](https://github.com/FoggyBytes/StreamTweak) — Auto-Switch Ethernet speed for a stutter-free Moonlight ↔ Sunshine/Apollo experience, and more. Without StreamTweak running on the host PC, the StreamTweak-specific features will not function.
710
811
---
912

@@ -18,9 +21,9 @@ StreamLight is currently available for **Windows only**.
1821
## ✨ Changes from upstream Moonlight
1922

2023
- **StreamTweak integration** — right-clicking a paired host PC now exposes two additional actions:
21-
- **Show host NIC speed** — queries StreamTweak on the host via TCP and displays the current Ethernet adapter speed
22-
- **Set host to 1 Gbps** — sends a command to StreamTweak to switch the host NIC to 1 Gbps before connecting; a 10-second countdown is shown before the connection is available. If no connection is made within 30 seconds, the host reverts to its original speed automatically
23-
- **Visual theme** aligned with StreamTweak's color palette for a consistent look across both apps
24+
- **Show host NIC speed** — queries [StreamTweak](https://github.com/FoggyBytes/StreamTweak) on the host via TCP and displays the current Ethernet adapter speed
25+
- **Set host to 1 Gbps** — sends a command to [StreamTweak](https://github.com/FoggyBytes/StreamTweak) to switch the host NIC to 1 Gbps before connecting; a 10-second countdown is shown before the connection is available. If no connection is made within 30 seconds, the host reverts to its original speed automatically
26+
- **Visual theme** aligned with [StreamTweak](https://github.com/FoggyBytes/StreamTweak)'s color palette for a consistent look across both apps
2427
- **Window title** changed to `StreamLight (a Moonlight fork)`
2528
- **Discord link removed** — as a fork, the upstream Moonlight Discord is not the appropriate support channel
2629
- **Auto-update checker removed** — to prevent prompts to update to upstream Moonlight releases

0 commit comments

Comments
 (0)