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.

1. Clone & Navigate

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

2. Compile

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

3. 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

1. Install Nix.
2. Clone the repository.
3. 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. 🌠