https://github.com/zorig/gopeerflix
Peerflix in Go POC
https://github.com/zorig/gopeerflix
Last synced: 3 months ago
JSON representation
Peerflix in Go POC
- Host: GitHub
- URL: https://github.com/zorig/gopeerflix
- Owner: Zorig
- License: mit
- Created: 2025-03-10T07:06:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-10T08:04:08.000Z (3 months ago)
- Last Synced: 2025-03-10T08:26:52.110Z (3 months ago)
- Language: Go
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 GoPeerflix
> **The Lightweight, High-Performance Torrent Streaming CLI for VLC**
[](https://github.com/zorig/gopeerflix/releases)
[](https://github.com/zorig/gopeerflix/actions)
---
## ✨ Features
- 🚀 **Blazing Fast:** Stream torrents instantly—no need to wait for full downloads!
- 🦋 **Lightweight & Efficient:** Minimal memory usage and optimized chunk streaming.
- 📺 **VLC Ready:** Seamlessly integrates with VLC media player.
- 🛠️ **Cross-Platform:** Supports Windows, Linux, and macOS.
- 🌎 **Magnet & Torrent Support:** Stream from magnet links or `.torrent` files.
## Planning to implement
- 🔄 **Auto Updates:** Automatically checks and updates itself.
- 📈 **Real-time TUI:** Interactive terminal UI showing real-time progress, speed, and ETA.
---
## 📦 Installation
### 📥 Download Pre-Built Binaries
Visit the [Releases](https://github.com/zorig/gopeerflix/releases) page to download binaries for Linux, Windows, or macOS.
### 🛠️ Build from Source
Ensure you have [Go installed](https://golang.org/dl/):
```bash
git clone https://github.com/zorig/gopeerflix.git
cd gopeerflix
go build -o gopeerflix ./cmd
```
## 🚩 Usage
```sh
./gopeerflix [magnet-link | torrent-file] --vlc
```
### 🎬 Example
Stream from a magnet link:
```sh
./gopeerflix "magnet:?xt=urn:btih:yourmagnetlinkhere" --vlc
```
Or stream from a local torrent file:
```sh
./gopeerflix ./myvideo.torrent --vlc
```
---
### 📺 VLC Integration
Ensure VLC is installed:
- Linux:
```sh
sudo apt install vlc
```
- macOS:
```sh
brew install vlc
```
- Windows
[Download VLC](https://www.videolan.org/vlc/download-windows.html)
GoPeerflix automatically opens VLC for instant streaming.
### ⚡ Performance Optimizations
- Efficient Buffering: Low memory footprint.
- Direct Chunk Streaming: Streams immediately without full downloads.
- Connection Management: Limited torrent connections for optimized performance.
- HTTP Range Requests: Smooth seeking and playback.
### 🔨 Contributing
Contributions are welcome! Please fork, submit pull requests, or open issues if you encounter bugs or have suggestions.
🌟 Star the Project!
If you find this useful, please ⭐️ star the repository—it helps keep me motivated!
### 📝 License
MIT License