https://github.com/eneller/vlc-slave
Server + Client Script to easily control and stream to vlc for Media HTPCs
https://github.com/eneller/vlc-slave
Last synced: 3 months ago
JSON representation
Server + Client Script to easily control and stream to vlc for Media HTPCs
- Host: GitHub
- URL: https://github.com/eneller/vlc-slave
- Owner: eneller
- Created: 2025-02-02T23:42:58.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-02-15T00:41:54.000Z (4 months ago)
- Last Synced: 2025-02-15T01:18:43.275Z (4 months ago)
- Language: Go
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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] [file] Stream a file. Use for media that is saved locally.
stream [slave-address] [url] Just tell the slave to listen for an already existing stream on the network.
```
## Dependencies
- [VLC](https://www.videolan.org/vlc) for streaming and receiving the stream
- [bash](https://www.gnu.org/software/bash/) for running the client script
- [curl](https://curl.se/) for the request from client to server
## Installation
1. Place the server executable on your server and create a [systemd service](https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html) for it.
2. Copy the `vlcstream` script to your client(s)
3. Ensure your client and server are on the same network
4. Run script with the address of your server