eneller/vlc-slave
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: README.md

Browse Source
This commit is contained in:
eneller
2025-02-03 08:40:09 +01:00
parent 046b049a01
commit b4900debd5
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@@ -0,0 +1,19 @@
# VLC-Slave
Combination of a tiny server (running on your Multimedia/Home Theater PC) and a small script for your clients to initiate streams.
This is achieved by first sending a quick authentication request to the server, which then uses the IP from that request to open the stream provided by the client.
The goal is to make it easy to stream shows and movies from your primary device to your TV.
## Usage
Either run the script locally from the same folder or move it to your PATH.
```
❯ ./vlcstream
vlcstream: Stream from this device to a computer running vlcslave.
Available Arguments:
screen [slave-address] Stream your current screen. Useful for streaming from a browser.
file [slave-address] Stream a file. Use for media that is saved locally.
```

2
vlcstream
View File

@@ -6,7 +6,7 @@ Available Arguments:
screen [slave-address] Stream your current screen. Useful for streaming from a browser.
file [slave-address] Stream a file. Use for media that is already saved locally.
file [slave-address] Stream a file. Use for media that is saved locally.
"
err() {