Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 2.25 KB

GETTING_STARTED.md

File metadata and controls

42 lines (29 loc) · 2.25 KB

Getting Started with Nearcade

Nearcade lets you share local games with friends over the internet using WebCodecs and WebRTC.

Hosting Options

You have two ways to host a session.

  1. Private Tunnels: You can set up a custom tunnel through Cloudflare or Zrok to create a permanent link for your friends. This works best for private groups.
  2. Nearcade Arcade: The Arcade is a public directory for finding local co-op games. Sessions are restricted to 80 minutes to keep the lobby active. You must use a verified tunneling provider like Cloudflared or Zrok to list a session. You can view the public lobby at https://nearcade.cutefame.net/arcade and join active games.

Launching a Session

Follow these steps to start hosting.

  1. Install Node.js version 18 or newer and Python 3 on your machine.

  2. Most users will launch the compiled executable directly. The app manages permissions and tunnels automatically.

  3. If you use the source code, open your terminal and navigate to the bin folder to run the setup script.

    cd bin
    sudo ./linux_setup.sh
  4. The Linux application requests permission to load the uinput kernel module. This step is required to build native virtual controllers.

  5. Click the Host Session button to open the capture dashboard.

  6. Send the generated link and Session PIN to your viewers. The Rust router blocks all video and audio streams until the host application validates the PIN from the viewer.

KDE Wayland Hosts: "Remote control requested" Dialog

On KDE Plasma 6 (Wayland), the host may pop a "Remote control requested" permission dialog whenever a viewer presses the Start/pause button. The injected virtual controllers are grabbed by Steam Input, and Steam's desktop navigation re-injects that input through XWayland, which the XDG Desktop Portal turns into a remote-desktop permission request (see KDE bug 490666). Other button presses do not trigger it.

Grant the portal permission once to silence it permanently:

flatpak permission-set kde-authorized remote-desktop "" yes

The empty app ID covers Steam/XWayland requests. You can verify the entry with:

flatpak permission-show kde-authorized

This project uses artificial intelligence large language models for code generation and structure planning.