Elevate Your Viewing Game with niketsu! 🚀

Say goodbye to disjointed viewing sessions! Introducing niketsu — your go-to platform for synced-up, social video streaming. Elevate your hangouts on Zoom, Teams, or any other VoIP of your choice, and get everyone literally on the same frame.

Why niketsu? 🔥🎬

Unrivaled Performance: Built on the rock-solid foundation of the esteemed mpv video player.

One-Stop Shop: Whether it's local files or streaming YouTube videos, we've got you covered. Share your screen, not the limitations.

Zero Learning Curve: Designed to be intuitive and lightweight—so you can focus on binge-watching, not troubleshooting.

Ready to Dive In? 🎉

Head to our Download page to get started or build it your way. We even roll out nightly builds on Github for the adventurous.

First Steps 👟

For a quick guide, visit our Usage Page, or explore our in-depth wiki via the sidebar.

Join the Party 🎈

We're thrilled to announce the latest update to niketsu, featuring groundbreaking Peer-to-Peer (P2P) functionality. This new capability transforms your viewing experience, allowing you to connect directly with other users, bypassing the need for centralized servers. Enjoy faster, more reliable video synchronization, even with large groups.

Key Highlights:

Direct Connections: Establish peer-to-peer connections for a smoother, more efficient streaming experience.
Enhanced Privacy: By eliminating central servers, your data stays between you and your peers.
Optimized Performance: Experience reduced latency and improved synchronization, ensuring everyone stays on the same frame.

niketsu continues to redefine social video streaming. With this update, you get more control, better performance, and a truly decentralized experience. Upgrade now to explore the future of synced viewing!

Show-Stopping Features 🌟

In-Sync Excellence: Achieve seamless video synchronization across local mpv instances.
Frontend Flexibility: Choose from our high-speed Rust clients, be it ratatui for TUI or iced for GUI. 🛠️
Backend Brilliance: Our relay infractructure is optimized for both cost-efficiency and scalability, all thanks to Rust. 🌐

Don't just watch — experience. niketsu is not just another product; it's your social viewing revolution. 🌈

News

For nightly updates, check out GitHub.

Latest Updates 📪

Decentralized peer to peer connections via hole punching
Fuzzy search for easily adding videos
Fully functional terminal client (tui) using ratatui

Current Development 📭

Predictive and dynamic synchronization based on client caches
Add docker image (and publish to the GitHub registry https://ghcr.io)
Support for home video sharing

Changelog 📤

Once a stable release is reached, changelogs will be added.

Build Like a Pro: Your Comprehensive Guide to niketsu Deployment 🛠️

Requirements

Running the niketsu-client requires an installation of mpv (preferably the latest version).

Hand-Craft Your Source Build 🚀

Join the cutting edge — build niketsu from source.

Clone & Navigate

git clone https://github.com/sevenautumns/niketsu.git
cd niketsu

Compile

# All
cargo build --release
# Client only
cargo build --release --bin niketsu
# Relay only
cargo build --release --bin niketsu-relay

Run
```
./target/release/niketsu
```

Want more control? Run your own niketsu relay after compiling using the instructions above:

./target/release/niketsu-relay

Check out the help page on the command line by using --help or visit the usage web page.

The Nix Nirvana 🌀

Already a Nix enthusiast? We've got you covered.

Effortless Development

Install Nix.
Clone the repository.
Enter Dev-Mode: nix develop

All you need, conveniently packed into one shell.

Running the Beast

Relay-Server: cargo run --release --bin niketsu-relay
Client: cargo run --release --bin niketsu

Examples for Debugging (Client only)

cargo run --example [OPTION]

The Nix Build

Want even more control? Utilize our flake.nix to tailor your build.

Relay-Server: nix build .#niketsu-relay
Client: nix build .#niketsu-client

Whatever your tech stack, niketsu seamlessly integrates, empowering you to create the ultimate shared viewing experience. Build it your way, run it your way. 🌠

Elevate Your Streaming Experience with niketsu 🚀

Your One-Stop Shop for Downloads

Step into the future of synchronized video streaming with niketsu. We offer precompiled binaries for seamless deployment and the source code for the tinkerers out there. Available for Linux and even on your Raspberry Pi! We're inclusive, just like our tech stack.

Client Builds

Fensterreinigung (Windows)
Builds for iOS or static builds for Linux are not yet available

Relay-Server Builds

Linux (x86-64 & ARM64)

Source

Available in Zip and Tar formats here
Running the niketsu-client requires an installation of mpv (preferably the latest version).

A Note from the Makers 📝

This platform has undergone meticulous scrutiny by a dedicated team of Ferris companions. They're fun but serious about code quality. Encountered an issue? Report here.

A Fair Warning: If your malware detector acts up, don't blame us, blame Ferris. For the skeptics, our Github repository is always open for inspection.

niketsu — Because traditional streaming is so 2020.

Usage Guide 🚀

Bootstrapping Your Journey 🛠️

Just landed? Here's the 411 on how to get your niketsu-client game on point.

The Client-Side of Things 👨‍💻

Pre-requisites

mpv: Yup, it's dynamically linked, not static. Make sure you've got this bad boy installed.

The Grand Entrance 🌟

After installing, you're greeted by this UI:

Use niketsu-client to binge content in real-time with your crew. Whether you're into YouTube or good ol' offline videos, we got you covered. Just make sure the source names match across clients. Server logic is "slowest client wins," so no lag-advantage here.

Let's Dive Deep 🌊

Most parameters are now moved to the configuration file, typically found at ~/.config/niketsu/config.toml:

username = "karl"
media_dirs = ["/mnt/point"]
room = "someverylongroomname"
password = "1234"
auto_connect = false
relay = "autumnal.de"
port = 7766

Other options

Set auto-login (auto_connect = true) to directly dive into your adventure without a boring login screen. The save buttons will apply your login data and save it for future calls.

If you host your own relay server, make sure to set relay to the IP/domain of your relay and port to the corresponding port of the service.

Video Time 🎬

Hit "Start," connect, and enjoy dual-window magic with mpv.

Got Issues? 🐛

Debug through the chat box.

What's on the GUI? 🖼️

Chat Box: Left side, for system and user messages.
File Database: Top-right, update when your file system changes.
Room Overview: Shows who's in what room.
Playlist: Bottom-right. Syncs based on the room you're in.

New Additions 🆕

Settings: Top-left corner.
File Search: Beside Settings, for quicker video additions.

Terminal Junkies 🤓

Opt for our text-based UI using --ui ratatui. Keybindings? Press space + h.

Simple and intuitive design.

The Server-Side Saga 🖥️

For the DIY gods, check out building page or snag our precompiled binaries.

Customizing Your Realm 🌍

Configurations can be set via toml or cli found at .~/.config/niketsu-relay/config.toml if available.

Parameters 📋

ipv6 = true
keypair = "ed25519keypairstuff"
port = 7766

Stay updated, we're always in flux. 🔄

niketsu Support—Empowering Your Streaming Journey 🛠️

We're committed to user-centricity and operational excellence. Experiencing a hiccup? Our DevOps ninjas are laser-focused on issue resolution.

Open Source, Open Communication: To report issues, initiate a GitHub Issue or slide into our developers' DMs. We're agile and responsive.

Visualizing Dev Passion: Below, our engineers immersed in a code-sprint, annihilating bugs and deploying hotfixes.

Unstoppable Support, Unbeatable Experience

We're here to bolster your digital transformation in the world of synchronized streaming. Our support system is an amalgamation of AI-driven automations and human touch.

Anytime, Anywhere: Our global team follows the sun model, ensuring round-the-clock support.

Code Review with Care 📝

Intrigued by our methods? Feel free to scrutinize our codebase on GitHub.

niketsu Support—Where your streaming obstacles metamorphose into stepping stones.

Contribute to Niketsu 🚀

Level up your game—be part of something epic. 🌟

Code Slingers Welcome 🛠

Got the chops in Rust? Perfect. Your expertise can elevate this project to the next stratosphere. 🌌

To start:

git clone https://github.com/sevenautumns/niketsu.git
cd niketsu

Bug Busters 🐛

Spotted a glitch in the matrix? Report it, soldier. 🎯

Open up a bug report.

Feature Aficionados 💡

Got an idea for a killer feature? We're all ears. 📣

Submit a feature request.

Pull Request Prodigies 🤝

Got code? Make a PR. Guidelines:

Fork the repo 🍴
Branch off 🌿
Commit your changes 📝
PR to main ➡️

Please follow conventional commits for commit messages.

Peer Review Paladins 👀

Your keen eye can catch what others miss. Review some pull requests. 👓

Docs Demigods 📜

Help write the gospel. Update wikis, READMEs, and inline docs. 🖋

Community Catalysts 💬

Join the convo. Discuss, enlighten, engage. Currently, restricted to Github.

Let's build something legendary. Welcome to the guild. 🛡️

About Niketsu 🌐

Find us on GitHub or dive into our socials that actually matter (none). 📣

The Vision 🎯

Unleash the full potential of social video streaming with Niketsu, your go-to platform for revolutionary video sync experiences. 🌠 We're not just another startup; we're an open-source alliance committed to demolishing boundaries and setting benchmarks (and we are most definitely not a startup).

Why Niketsu? 🚀

Open Source Synergy: Built by devs who get it. Let's flip the script on video sharing. 🤖
Universal Access: Forget geo-fences; we're tearing them down. Global reach, local feel. 🌍
Feature-Rich UX: Our killer features aren't just skin deep. Deep-dive into advanced customization. 🛠️
Real-time Engagement: Chat, react, and vibe in perfect harmony. Seamless and synchronic. 🗨️
Non-Profit Mojo: Not here to line our pockets; we're here to shake up the ecosystem. 🌱

"Here's to the ones who dream, foolish as they may seem." 🌈

Appreciation Corner 🎨

Shoutout to egonelbre for the dope Gopher vectors. Art fuels code. 🖌️👨‍🎨

Let's get disruptive. 🤘

Keyboard shortcuts

Niketsu