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.

ipv6 = true
keypair = "ed25519keypairstuff"
port = 7766

Stay updated, we're always in flux. 🔄

Niketsu