mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-25 23:18:44 -07:00
Add installer updater and server CLI
This commit is contained in:
Alexa
+3
-1
@@ -3,9 +3,11 @@
|
||||
| Doc | For who |
|
||||
| ---------------------------------------------- | ------------------------------------------------------ |
|
||||
| [../BRANCHES.md](../BRANCHES.md) | Anyone picking which branch matches their Rec Room build |
|
||||
| [easy-setup.md](easy-setup.md) | Hosts who want the desktop-app one-click experience |
|
||||
| [easy-setup.md](easy-setup.md) | Windows hosts using the desktop launcher |
|
||||
| [server-cli.md](server-cli.md) | Linux / macOS hosts using the headless `dorknet-server` |
|
||||
| [advanced-setup.md](advanced-setup.md) | Hosts running a community server on Docker / a VPS |
|
||||
| [joining-a-server.md](joining-a-server.md) | Players whose friend gave them a join code |
|
||||
| [photon-setup.md](photon-setup.md) | How to get a free Photon Cloud account + AppIds |
|
||||
| [architecture.md](architecture.md) | Contributors hacking on the code |
|
||||
| [faq.md](faq.md) | Common questions before you ask in issues |
|
||||
| [troubleshooting.md](troubleshooting.md) | Known failure modes + fixes |
|
||||
|
||||
+276
-44
@@ -1,63 +1,287 @@
|
||||
# Easy mode — host your own server
|
||||
|
||||
> Built for non-technical hosts. If you can install Discord, you can do this.
|
||||
>
|
||||
> **On Linux or macOS?** This guide is for the Windows GUI launcher.
|
||||
> For headless hosting from a Linux box / a Mac / a VPS, see
|
||||
> [server-cli.md](server-cli.md). Joiners on those platforms are not
|
||||
> supported yet — Rec Room itself is a Windows game.
|
||||
|
||||
DorkNet bundles everything you need to run a private Rec Room server on
|
||||
your own machine and hand a join code to your friends. The launcher is a
|
||||
single Windows app that:
|
||||
|
||||
- runs the server,
|
||||
- opens a public tunnel so friends anywhere can connect,
|
||||
- patches your local copy of Rec Room to point at the server,
|
||||
- packages a join code your friends paste into their launcher.
|
||||
|
||||
## What you'll need
|
||||
|
||||
- A Windows PC (Mac and Linux support coming later)
|
||||
- A copy of **Rec Room 2020.03.10** — the specific old build DorkNet targets.
|
||||
You acquire this yourself; see [Getting the 2020 client](#getting-the-2020-client) below.
|
||||
- Windows 10 or 11 (Mac and Linux support are not planned)
|
||||
- A copy of **Rec Room 2020.03.10** — the specific old build DorkNet
|
||||
targets. You acquire this yourself; see
|
||||
[Getting the 2020 client](#getting-the-2020-client) below.
|
||||
- A free Photon Cloud account — the launcher walks you through this on
|
||||
first run.
|
||||
- ~5 GB free disk space
|
||||
- About 10 minutes
|
||||
- About 10 minutes for first-run setup, ~30 seconds per subsequent launch
|
||||
|
||||
## Step 1 — Download DorkNet
|
||||
## Download
|
||||
|
||||
Grab `dorknet.exe` from the [latest release](https://github.com/YOUR_GH_USERNAME/dorknet/releases/latest).
|
||||
Two flavours on the
|
||||
[latest release](https://github.com/DorkSquadRR/DorkNet/releases/latest):
|
||||
|
||||
> Windows SmartScreen may warn you. The exe is code-signed; click "More info"
|
||||
> → "Run anyway".
|
||||
- **`dorknet-setup-<version>.exe`** *(recommended)* — installer.
|
||||
Drops the launcher under `%LocalAppData%\Programs\DorkNet`, adds
|
||||
Start menu + (optional) desktop shortcut, sets up the auto-updater,
|
||||
registers an uninstaller. No admin rights required.
|
||||
- **`dorknet.exe`** — single-file portable. Drop it anywhere; state
|
||||
lives in `%APPDATA%\DorkNet`. No shortcuts, no auto-updates.
|
||||
|
||||
## Step 2 — First launch
|
||||
Either works the same once it's running. Pick the installer if you'd
|
||||
like Start-menu integration and rolling updates; pick the portable exe
|
||||
if you'd rather no system changes.
|
||||
|
||||
When you open DorkNet for the first time, you'll see a welcome screen
|
||||
asking what you want to do.
|
||||
> Windows SmartScreen may warn you on first launch because the binary
|
||||
> isn't EV-signed. Click "More info" → "Run anyway".
|
||||
|
||||
### Auto-updates
|
||||
|
||||
The installed launcher checks GitHub on every launch for a newer
|
||||
release. If one's available, a small banner appears in the sidebar
|
||||
with an **Install & restart** button. Click it; the launcher
|
||||
downloads the new binary, shuts itself down, swaps the exe in place,
|
||||
and relaunches.
|
||||
|
||||
Turn this off during setup by un-ticking *Check for updates on launch*,
|
||||
or any time later by editing `HKCU\Software\DorkNet\AutoUpdate` (0
|
||||
disables). The portable `dorknet.exe` doesn't auto-update — pull a new
|
||||
release yourself when you want one.
|
||||
|
||||
## First launch — the welcome screen
|
||||
|
||||
The very first time you open DorkNet you get a hero screen.
|
||||
|
||||
|
||||
|
||||
Click **🏠 Host a server**.
|
||||
Click **GET STARTED** to enter the setup wizard. The wizard only runs
|
||||
once; future launches drop you straight into the main view.
|
||||
|
||||
## Step 3 — Patch your Rec Room install
|
||||
## The setup wizard
|
||||
|
||||
DorkNet needs to redirect Rec Room to talk to your server instead of the
|
||||
official one. This is a one-time patch.
|
||||
Five steps, top stepper shows your progress. **Back** and **Next** sit
|
||||
in the bottom bar; the choice cards on the first step auto-advance when
|
||||
clicked.
|
||||
|
||||
1. Click the **Patch game** tab.
|
||||
2. Click **Browse for Rec Room install...** — point it at the folder where
|
||||
`Recroom_Release.exe` lives.
|
||||
3. Click **Patch**. Takes 30 seconds.
|
||||
### Step 1 — Pick a mode
|
||||
|
||||
|
||||
|
||||
|
||||
✅ You're done with patching. You won't need to do this again unless you
|
||||
reinstall Rec Room.
|
||||
- **Run a server** — you'll host. The launcher will set up the tunnel
|
||||
and hand you a join code.
|
||||
- **Use a code** — a friend already hosts and gave you a join code.
|
||||
See [joining-a-server.md](joining-a-server.md) for that path.
|
||||
|
||||
## Step 4 — Start the server + tunnel
|
||||
This page is also reachable later via **Re-run setup** in the sidebar,
|
||||
so don't worry about getting it wrong.
|
||||
|
||||
1. Click **Start server** on the Status tab.
|
||||
2. After ~5 seconds you'll see a public URL like
|
||||
`https://abc-def-ghi.trycloudflare.com`. Anyone with that URL + a
|
||||
matching join code can connect to you.
|
||||
### Step 2 — Find your Rec Room install
|
||||
|
||||
|
||||
The wizard auto-detects common manual-install locations (it never
|
||||
touches your Steam library). If detection works you'll see a green
|
||||
"Detected install" banner with the path; otherwise click **Browse…** and
|
||||
point at your `Recroom_Release_Data` folder.
|
||||
|
||||
## Step 5 — Share the join code with your friends
|
||||
The path should look like `…\<install>\Recroom_Release_Data` — the
|
||||
*_Data sibling of `Recroom_Release.exe`. The launcher validates this
|
||||
when you continue.
|
||||
|
||||
1. Click the **Share** tab.
|
||||
2. Click **Copy join code**.
|
||||
3. Paste it to your friend in Discord / iMessage / wherever.
|
||||
### Step 3 — Set up your server
|
||||
|
||||
That's it for hosting. Your friend opens DorkNet, picks "Join a server",
|
||||
pastes the code, and they're in.
|
||||
- **Server name** — what shows up in your join code. Use whatever your
|
||||
friends will recognise ("Adam's Sunday games", "DorkSquad Test", etc.).
|
||||
- **Who can join?** — three options, only one shows extra inputs:
|
||||
- **Friends anywhere · Tunnelto** *(default, recommended)* — the
|
||||
launcher runs a Tunnelto tunnel that gives your server a public
|
||||
`*.tunnelto.me` URL. Works for anyone, anywhere. No router config.
|
||||
- **Tunnelto wildcard base** — advanced. If you've got a wildcard
|
||||
Tunnelto subscription, paste the apex domain. Subdomains like
|
||||
`api.<base>`, `auth.<base>`, etc. get auto-generated.
|
||||
- **Same WiFi only · sslip.io** — bind on your LAN only. Friends must
|
||||
be on the same network. No tunnel, lowest latency.
|
||||
|
||||
### Step 4 — Connect your Photon account
|
||||
|
||||
Photon Cloud runs the in-room realtime sync (positions, voice, room
|
||||
state). DorkNet doesn't ship one — you bring your own free account.
|
||||
|
||||
Click **OPEN WALKTHROUGH** to launch the in-app Photon wizard. It opens
|
||||
your browser to `dashboard.photonengine.com` and walks you through
|
||||
creating two apps (Realtime + Voice). The wizard waits for you to paste
|
||||
the AppIds back in. Voice is optional; without it, voice chat is
|
||||
text-only and you can use Discord on the side.
|
||||
|
||||
If you've already got AppIds from a previous setup, paste them directly
|
||||
into **REALTIME APPID** and **VOICE APPID** in step 4 and skip the
|
||||
walkthrough.
|
||||
|
||||
> For a standalone screenshot-by-screenshot guide to the Photon
|
||||
> dashboard, see [photon-setup.md](photon-setup.md). Useful if you
|
||||
> get stuck mid-walkthrough or want to re-do it later.
|
||||
|
||||
### Step 5 — Done
|
||||
|
||||
Confirmation card. Click **Finish** to enter the main view.
|
||||
|
||||
## The main view
|
||||
|
||||
The launcher's everyday UI:
|
||||
|
||||
|
||||
|
||||
- **Sidebar** (left): **Host a server**, **Join a friend**, **Settings**,
|
||||
**Re-run setup**. The brand-coloured stripe marks the active section.
|
||||
The footer at the bottom shows your server's live status (Idle /
|
||||
Starting / Live / Failed) and the launcher version.
|
||||
- **Header** (top of content): a short eyebrow describing the view,
|
||||
the title, and a **Screen mode** checkbox top-right.
|
||||
- **Content**: two panels — **Server** and **Photon Cloud** — followed
|
||||
by the action bar.
|
||||
|
||||
Everything in the wizard is editable here. If you change anything mid-
|
||||
session, the new values get used the next time you hit Start hosting.
|
||||
|
||||
### Server panel
|
||||
|
||||
- **REC ROOM INSTALL** — same picker as the wizard. The path shows in
|
||||
monospace so you can sanity-check it.
|
||||
- **SERVER NAME · SHOWN TO JOINERS** — text input. Updates the embedded
|
||||
name inside your next join code.
|
||||
- **REC ROOM VERSION TO HOST FOR** — dropdown. Pre-selects the version
|
||||
matching your install. Picking a different version means the launcher
|
||||
will fetch that server build the next time you Start hosting.
|
||||
- **WHO CAN JOIN?** — the same three options as step 3 of the wizard.
|
||||
- **TUNNELTO BASE HOST** — only visible when you pick the wildcard
|
||||
option. Auto-generated otherwise; not needed for the default or LAN
|
||||
modes.
|
||||
|
||||
### Photon Cloud panel
|
||||
|
||||
- **REALTIME APPID** — required. Realtime is the matchmaking + room
|
||||
sync layer. Click the **WALKTHROUGH** button (top-right of the
|
||||
panel) any time you want to re-run the in-app Photon wizard.
|
||||
- **VOICE APPID · OPTIONAL** — if set, voice chat works through Photon
|
||||
Voice. If empty, players use Discord.
|
||||
- **CLOUD REGION** — picks the Photon datacenter. All clients must
|
||||
match. Default is US; change for European / Asian players.
|
||||
|
||||
### Screen mode
|
||||
|
||||
The **Screen mode** checkbox in the header passes `+forcemode:screen`
|
||||
when launching Rec Room, opening the game in 2D desktop mode instead
|
||||
of looking for a VR headset. Useful for testing or for friends who
|
||||
don't have VR.
|
||||
|
||||
## Starting your server
|
||||
|
||||
Hit **START HOSTING** (orange button, bottom of the content panels).
|
||||
The launcher runs through six steps in order:
|
||||
|
||||
1. **Download server** — fetches the matching server build into
|
||||
`%LOCALAPPDATA%\DorkNet\servers\<version>\`. ~50 MB the first time;
|
||||
reused on subsequent launches.
|
||||
2. **Open tunnel** — starts Tunnelto and assigns a public hostname.
|
||||
Skipped in LAN mode.
|
||||
3. **Start server** — boots the server process. SQLite database lives
|
||||
in `%APPDATA%\DorkNet\dorknet.db`.
|
||||
4. **Download patcher** — fetches the client-patcher payload that
|
||||
matches your version.
|
||||
5. **Strip Steam DRM** — only runs if your install is a Steam build
|
||||
(Steamless does the unwrap; original `Recroom_Release.exe` is backed
|
||||
up next to itself).
|
||||
6. **Apply patch** — rewrites the game's network URLs, Photon AppIds,
|
||||
and embedded keys in place.
|
||||
|
||||
Progress steps show inline. If any step fails, the row turns red and
|
||||
**Retry** appears under the steps list (along with **Get help** which
|
||||
opens the troubleshooting docs).
|
||||
|
||||
## Sharing your server
|
||||
|
||||
When step 6 finishes, the join code panel appears with the orange
|
||||
"SERVER LIVE" header.
|
||||
|
||||
You get:
|
||||
|
||||
- a **QR code** on a white tile — scan with a phone to get the join
|
||||
string into your friend's clipboard,
|
||||
- the join code itself in monospace,
|
||||
- three share actions:
|
||||
- **COPY CODE** — copies just the code,
|
||||
- **Copy as message** — wraps it in a friendly Discord-ready blurb
|
||||
that links back to the DorkNet download,
|
||||
- **Email** — opens your mail client with subject + body filled in.
|
||||
|
||||
Your friend opens DorkNet, picks **Join a friend** on first launch
|
||||
(or from the sidebar later), pastes the code, and gets the matching
|
||||
patcher.
|
||||
|
||||
## Launching the game
|
||||
|
||||
Once your server is live, the **LAUNCH REC ROOM** button (teal, sits
|
||||
next to **STOP**) becomes visible. Click it; the launcher starts your
|
||||
patched copy with the right command-line args. Toggle **Screen mode**
|
||||
in the header first if you want desktop play.
|
||||
|
||||
## Stopping the server
|
||||
|
||||
**STOP** kills the server process and the tunnel cleanly, hides the
|
||||
join code panel, and re-enables **START HOSTING**. Your data
|
||||
(`dorknet.db`) persists; relaunching restores everything.
|
||||
|
||||
The launcher also stops the server automatically when you close the
|
||||
window. Don't quit mid-game — your friends will get disconnected.
|
||||
|
||||
## Settings
|
||||
|
||||
Sidebar → **Settings**.
|
||||
|
||||
- **Cache locations** — read-only paths to your state file, server
|
||||
cache, patcher cache, and logs. Useful for "I want to clear the
|
||||
cache" or "where did my db go".
|
||||
- **Dev overrides** — only appears when one of the `DORKNET_LOCAL_*`
|
||||
env vars is set. Lists which overrides are active. Unset the env
|
||||
vars to return to the normal release-fetching mode.
|
||||
- **About** — version, license (AGPL-3.0), and a link to the GitHub
|
||||
repo.
|
||||
|
||||
The sidebar also has a **Re-run setup** entry. It clears the
|
||||
"setup-complete" flag without losing your saved values, so the wizard
|
||||
walks again from step 1 — handy if you want to change modes (host
|
||||
↔ join) or re-do the Photon walkthrough.
|
||||
|
||||
## Switching from host to join
|
||||
|
||||
From the sidebar, click **Join a friend**. Your host settings are
|
||||
preserved (Photon AppIds, server name, etc.) so switching back later
|
||||
picks up where you left off. The SQLite database also stays put.
|
||||
|
||||
See [joining-a-server.md](joining-a-server.md) for the join-side flow.
|
||||
|
||||
---
|
||||
|
||||
## Hosting-mode deep-dive
|
||||
|
||||
| Mode | Tunnel | Public URL | Best for |
|
||||
| --- | --- | --- | --- |
|
||||
| Friends anywhere · Tunnelto | yes | `dorknet-<random>.tunnelto.me` | Default — works for everyone, no setup |
|
||||
| Tunnelto wildcard base | yes | `<your-apex>` + `api.<apex>`, `auth.<apex>`, … | Power users with a wildcard Tunnelto plan |
|
||||
| Same WiFi only · sslip.io | no | `<lan-ip>.sslip.io` | LAN games, lowest latency, no internet exposure |
|
||||
|
||||
Default mode is the right pick for >95% of cases. The wildcard mode is
|
||||
only useful if you've already got a stable apex domain set up. LAN mode
|
||||
is for when everyone's in the same room.
|
||||
|
||||
---
|
||||
|
||||
@@ -80,14 +304,22 @@ DorkNet's authors can't help you obtain the game. Search the web for
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
See [troubleshooting.md](troubleshooting.md) for common issues.
|
||||
See [troubleshooting.md](troubleshooting.md) for the full list.
|
||||
|
||||
The most common ones:
|
||||
- **"This site can't be reached" when joining** — your tunnel URL changed.
|
||||
Get the new one from the Status tab and share it again. (Cloudflare
|
||||
Quick Tunnels give a new URL each session. See
|
||||
[advanced-setup.md](advanced-setup.md) if you want a stable one.)
|
||||
- **Friend can't connect** — they need to use the same Photon region as
|
||||
you. Settings → Photon region. Default is `eu`.
|
||||
- **Game launches but stays on the loading screen** — your friend isn't
|
||||
patched. Make sure they ran the Patch tab in their copy of DorkNet.
|
||||
The most common problems:
|
||||
|
||||
- **Server starts but friend can't connect** — Cloudflare Quick Tunnels
|
||||
rotate the URL on every restart. Re-share the join code if you've
|
||||
restarted hosting.
|
||||
- **"Photon CustomAuth 401" in the server log** — your Realtime AppId
|
||||
on the server doesn't match what the launcher patched into the
|
||||
client. Make sure both sides use the same AppIds.
|
||||
- **Game launches but stays on the loading screen** — your friend
|
||||
didn't run the patcher. Their Join view needs to complete step 3
|
||||
(Apply Patch) before launching Rec Room.
|
||||
- **Game launches but goes straight back to the title screen** — your
|
||||
Photon region setting differs from your friend's. Both clients must
|
||||
match. Set in Photon Cloud → CLOUD REGION.
|
||||
|
||||
Logs live at `%LOCALAPPDATA%\DorkNet\logs\` and capture the full
|
||||
server output for each session.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 112 KiB After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 129 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 129 KiB |
+147
-36
@@ -1,67 +1,178 @@
|
||||
# Joining someone's DorkNet server
|
||||
# Joining a friend's DorkNet server
|
||||
|
||||
> Built for players whose friend already runs a server and gave them a
|
||||
> code. If you want to *host* instead, see [easy-setup.md](easy-setup.md).
|
||||
|
||||
A "join code" is a one-line string your host's launcher generated when
|
||||
they hit Start hosting. It contains everything DorkNet needs to point
|
||||
your Rec Room at their server: the public hostname, the Photon AppIds,
|
||||
the version, and the server's display name. The launcher decodes it
|
||||
locally — nothing is sent anywhere until you actually launch the game.
|
||||
|
||||
## What you'll need
|
||||
|
||||
- A Windows PC
|
||||
- A copy of **Rec Room 2020.03.10** (your own — see
|
||||
[Getting the 2020 client](easy-setup.md#getting-the-2020-client))
|
||||
- The join code your friend gave you (looks like `dorknet://join?...`)
|
||||
- Windows 10 or 11
|
||||
- A copy of **Rec Room 2020.03.10** — your own, see
|
||||
[Getting the 2020 client](easy-setup.md#getting-the-2020-client)
|
||||
- The join code your friend gave you (a base64-looking blob a few hundred
|
||||
characters long)
|
||||
- About 2 minutes
|
||||
|
||||
## Step 1 — Download DorkNet
|
||||
You **don't** need a Photon account of your own. The join code carries
|
||||
your friend's AppIds; the launcher rewrites them into your client.
|
||||
|
||||
Grab `dorknet.exe` from the [latest release](https://github.com/YOUR_GH_USERNAME/dorknet/releases/latest).
|
||||
## Download
|
||||
|
||||
## Step 2 — First launch
|
||||
Grab `dorknet.exe` from the
|
||||
[latest release](https://github.com/DorkSquadRR/DorkNet/releases/latest).
|
||||
Same single-file binary as the host's. Drop it anywhere; state lives in
|
||||
`%APPDATA%\DorkNet`.
|
||||
|
||||
On the welcome screen, click **🎮 Join a server**.
|
||||
## First launch
|
||||
|
||||
|
||||
Welcome screen → **GET STARTED** → setup wizard.
|
||||
|
||||
## Step 3 — Paste the join code
|
||||
|
||||
|
||||
Your friend's code goes in the big text box. DorkNet decodes it and shows
|
||||
you what you're about to connect to so you can sanity-check:
|
||||
### Wizard step 1 — Pick "Use a code"
|
||||
|
||||
|
||||
The right-hand card.
|
||||
|
||||
Make sure the server name matches what your friend told you. Codes from
|
||||
strangers can point anywhere — only paste codes from people you trust.
|
||||
|
||||
|
||||
## Step 4 — Patch your Rec Room install
|
||||
Join mode skips the host-only wizard steps (server name + Photon), so
|
||||
your wizard runs 3 steps total instead of 5.
|
||||
|
||||
1. Click **Browse for Rec Room install...** — point at the folder with
|
||||
`Recroom_Release.exe`.
|
||||
2. Click **Patch & launch**.
|
||||
### Wizard step 2 — Find your Rec Room install
|
||||
|
||||
DorkNet patches the game (one-time), then launches it pointed at your
|
||||
friend's server. You'll see the normal Rec Room login screen, log in with
|
||||
the account you made on your friend's server, and you're in.
|
||||
The launcher auto-detects common manual-install locations. If detection
|
||||
worked you'll see a green "Detected install" banner; otherwise click
|
||||
**Browse…** and point at your `Recroom_Release_Data` folder (the *_Data
|
||||
sibling of `Recroom_Release.exe`).
|
||||
|
||||
### Wizard step 3 — Done
|
||||
|
||||
That's it for the wizard. Click **Finish** to land in the main view.
|
||||
|
||||
## The main view — Join
|
||||
|
||||
|
||||
|
||||
- **Sidebar** (left): same nav as the host's launcher — **Host a
|
||||
server**, **Join a friend**, **Settings**, **Re-run setup**. You're
|
||||
on **Join a friend**.
|
||||
- **Header** (top): JOIN eyebrow, "Join a friend" title, and the
|
||||
**Screen mode** checkbox top-right.
|
||||
|
||||
### Paste the join code
|
||||
|
||||
Paste the code your friend sent you into the **PASTE THE CODE YOUR
|
||||
HOST SHARED** textbox. Hit **Preview** — the launcher decodes the code
|
||||
and pops a "Server preview" panel showing:
|
||||
|
||||
- the server's display name,
|
||||
- the public host (Tunnelto hostname, sslip.io address, or wildcard
|
||||
apex),
|
||||
- the version key (must match your install — the patcher will warn if
|
||||
not).
|
||||
|
||||
Sanity-check it. **Codes from strangers can point anywhere — only paste
|
||||
codes from people you trust.** A malicious code wouldn't compromise
|
||||
your machine, but it could send your Rec Room login traffic to someone
|
||||
else's server.
|
||||
|
||||
### Confirm your Rec Room install
|
||||
|
||||
Same picker as on the wizard. The path shows in monospace below the
|
||||
Rec Room install header. Click **Browse…** to change it if needed.
|
||||
|
||||
## Applying the patch
|
||||
|
||||
Click **APPLY PATCH** (the orange button below the install picker; it
|
||||
stays disabled until you've pasted a valid code).
|
||||
|
||||
The launcher runs three steps:
|
||||
|
||||
1. **Download patcher** — fetches the version-specific patcher payload.
|
||||
~10 MB, cached for next time.
|
||||
2. **Strip Steam DRM** — only runs if your install is a Steam build.
|
||||
3. **Apply patch** — rewrites network URLs and Photon AppIds in place.
|
||||
|
||||
Progress steps show inline. If anything fails, the row turns red and
|
||||
you get **Retry** + **Get help** buttons.
|
||||
|
||||
The original `Recroom_Release.exe` and its DRM-stripped copy are
|
||||
preserved as backups next to the modified files; the patcher is
|
||||
reversible.
|
||||
|
||||
## Launching Rec Room
|
||||
|
||||
When the patch completes, the **LAUNCH REC ROOM** button (teal)
|
||||
appears. Click it. The launcher starts your patched Rec Room with the
|
||||
right command-line.
|
||||
|
||||
Tick **Screen mode** in the top-right of the header first if you want
|
||||
to play in 2D desktop mode instead of VR.
|
||||
|
||||
You'll see the regular Rec Room login screen — log in with the account
|
||||
your host gave you (each DorkNet server has its own player database),
|
||||
and you're in their world.
|
||||
|
||||
---
|
||||
|
||||
## I already patched for a different server. Can I switch?
|
||||
## Switching to a different friend's server
|
||||
|
||||
Yes — DorkNet's patcher is reversible. Click **Repair / unpatch** in the
|
||||
Patch tab to undo, then re-patch with a new join code. Or just re-run
|
||||
**Patch & launch** with the new code; the patcher detects an existing
|
||||
patch and updates the destination.
|
||||
You can re-patch any time. Paste the new code, hit **Preview** to
|
||||
verify, click **APPLY PATCH** again. The patcher detects the existing
|
||||
patch and updates the destination — no need to repair first.
|
||||
|
||||
## My account doesn't exist on the new server
|
||||
If you want to go back to the official Rec Room servers, the patcher's
|
||||
backups are still there: rename `Recroom_Release.exe.bak` (or
|
||||
`.steamless.bak`) back to `Recroom_Release.exe`. Or just reinstall.
|
||||
|
||||
Each DorkNet server runs its own account database. You'll need to create
|
||||
a new account the first time you join a server. Your friend can sign you
|
||||
up via their admin panel, or you can use the in-game "Create account"
|
||||
flow if the server has signups enabled.
|
||||
## Switching to host mode
|
||||
|
||||
Sidebar → **Host a server**. You'll need to fill in server name +
|
||||
Photon AppIds before you can host. See
|
||||
[easy-setup.md](easy-setup.md) for that workflow. The launcher
|
||||
preserves your install path and screen-mode preference when you switch.
|
||||
|
||||
---
|
||||
|
||||
## My account doesn't exist on the server
|
||||
|
||||
Each DorkNet server runs its own player database. The first time you
|
||||
join, you need an account on that server. Your friend can sign you up
|
||||
through their admin panel, or you can use the in-game "Create account"
|
||||
flow if signups are enabled.
|
||||
|
||||
If you've joined the same server before and switched away, your old
|
||||
account is still on their database — log in with the same credentials
|
||||
you used before.
|
||||
|
||||
## Voice chat doesn't work
|
||||
|
||||
Voice routes through Photon Voice, which requires a separate Photon Voice
|
||||
AppId. If your friend hasn't set one up, voice chat is text-only for now.
|
||||
Voice routes through Photon Voice, which is a separate AppId. If your
|
||||
host hasn't set one up, voice chat won't work in-game. You can still
|
||||
use Discord or any other voice tool alongside.
|
||||
|
||||
## "Photon CustomAuth 401" or game stuck on the loading screen
|
||||
|
||||
Almost always one of:
|
||||
|
||||
- Your host set up a new Photon AppId since your last join. Paste the
|
||||
new code, re-apply the patch.
|
||||
- Your Photon **region** in the code doesn't match the server's. This
|
||||
is set by the host; ask them to confirm the region.
|
||||
- The patch didn't actually apply — check the launcher's progress
|
||||
panel; a red row means the patcher errored.
|
||||
|
||||
## "Check your internet connection" / black screen
|
||||
|
||||
Most often: your host's tunnel URL changed (Tunnelto sometimes rotates
|
||||
hostnames between sessions). Get a fresh join code from them and
|
||||
re-apply the patch.
|
||||
|
||||
## More troubleshooting
|
||||
|
||||
See [troubleshooting.md](troubleshooting.md).
|
||||
[troubleshooting.md](troubleshooting.md) lists the rest.
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
# Getting your Photon AppIds
|
||||
|
||||
DorkNet uses Photon Cloud for in-room realtime sync (positions, voice,
|
||||
matchmaking). It's free for small private servers and the launcher
|
||||
never ships one — you bring your own. This guide walks through getting
|
||||
one if the in-app walkthrough doesn't work for you (e.g. you're using
|
||||
the Linux/macOS [`dorknet-server`](server-cli.md) CLI).
|
||||
|
||||
You only need to do this **once**. The AppIds are saved on your host
|
||||
machine and embedded into the join code so your friends never see them.
|
||||
|
||||
## What you're getting
|
||||
|
||||
- **Realtime AppId** — required. Powers position sync, room state,
|
||||
RPCs. Free Photon plan covers 20 concurrent users which is enough
|
||||
for a friends-only server.
|
||||
- **Voice AppId** — optional. Powers in-game voice chat. Skip it if
|
||||
your group uses Discord on the side.
|
||||
|
||||
Both are GUIDs that look like `abc12345-6789-...`. Treat them like
|
||||
loose credentials: they're not secret-secret (the join code carries
|
||||
them to joiners), but don't paste them in public chat.
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Sign up
|
||||
|
||||
Go to **[dashboard.photonengine.com](https://dashboard.photonengine.com/)**
|
||||
and click "Sign up". Email + password; the free tier doesn't ask for a
|
||||
card.
|
||||
|
||||
|
||||
|
||||
> If you already have an account from another project, log in instead.
|
||||
> Multiple DorkNet servers can share the same Photon account, but each
|
||||
> server needs its own AppId pair so concurrent player counts don't
|
||||
> collide.
|
||||
|
||||
## Step 2 — Create a Realtime app
|
||||
|
||||
After login, click **CREATE A NEW APP** on the dashboard. The form asks
|
||||
for:
|
||||
|
||||
- **Photon Type** — pick **Photon Realtime**. Not Fusion, not Quantum,
|
||||
not Bolt.
|
||||
- **Name** — anything you'll recognise later ("DorkNet Realtime",
|
||||
"Sunday Server", etc.). Joiners don't see this.
|
||||
- **Description** — optional.
|
||||
|
||||
Click **CREATE**.
|
||||
|
||||
|
||||
|
||||
## Step 3 — Copy the Realtime AppId
|
||||
|
||||
You land back on the dashboard with your new app at the top. The AppId
|
||||
is the long string under the app name — click it to copy.
|
||||
|
||||
|
||||
|
||||
That's your **Realtime AppId**. Paste it into:
|
||||
|
||||
- the launcher's first-run wizard step 4, **REALTIME APPID** field, OR
|
||||
- the launcher's Host view → Photon Cloud panel → **REALTIME APPID**, OR
|
||||
- the CLI: `dorknet-server --photon-id <paste-here>`
|
||||
|
||||
## Step 4 — (Optional) Create a Voice app
|
||||
|
||||
If you want in-game voice chat, repeat Step 2 with **Photon Voice**
|
||||
selected instead of Realtime. Same flow.
|
||||
|
||||
|
||||
|
||||
Copy the Voice AppId from the dashboard the same way as Step 3 and
|
||||
paste it into:
|
||||
|
||||
- the wizard's **VOICE APPID** field, OR
|
||||
- the launcher's Host view → Photon Cloud panel → **VOICE APPID · OPTIONAL**, OR
|
||||
- the CLI: `--voice-id <paste-here>`
|
||||
|
||||
## Step 5 — Pick a region
|
||||
|
||||
Both apps default to a global routing layer, but for the lowest latency
|
||||
you want all your players hitting the same Photon datacenter.
|
||||
|
||||
In the launcher, **CLOUD REGION** sits below the AppId fields:
|
||||
|
||||
| Code | Region |
|
||||
| --- | --- |
|
||||
| `us` | US East (default) |
|
||||
| `eu` | EU Amsterdam |
|
||||
| `asia` | Asia Singapore |
|
||||
| `jp` | Japan Tokyo |
|
||||
| `sa` | South America São Paulo |
|
||||
| `kr` | Korea Seoul |
|
||||
| `in` | India Chennai |
|
||||
| `au` | Australia Sydney |
|
||||
|
||||
Pick the region closest to most of your players. The CLI flag is
|
||||
`--region <code>`.
|
||||
|
||||
> **All joiners must use the same region as the host.** This is baked
|
||||
> into the join code, so as long as everyone uses the same code,
|
||||
> they'll match. If you change the region later, regenerate the code.
|
||||
|
||||
## Step 6 — Paste into DorkNet
|
||||
|
||||
That's it. In the launcher:
|
||||
|
||||
1. Open the Host view.
|
||||
2. Paste **Realtime AppId** under Photon Cloud.
|
||||
3. Paste **Voice AppId** (if you made one).
|
||||
4. Pick the **Cloud Region**.
|
||||
5. Click **START HOSTING** when ready.
|
||||
|
||||
For the CLI:
|
||||
|
||||
```
|
||||
dorknet-server \
|
||||
--photon-id <realtime-appid> \
|
||||
--voice-id <voice-appid> # optional \
|
||||
--region eu # whatever region you picked \
|
||||
--name "Sunday games"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What's safe to share
|
||||
|
||||
| Value | Share with friends? | Why |
|
||||
| --- | --- | --- |
|
||||
| Realtime AppId | Yes (via join code) | The launcher embeds it into the join code so joiners can connect. |
|
||||
| Voice AppId | Yes (via join code) | Same. |
|
||||
| Photon dashboard login | **No** | Anyone with your login can delete your apps + see usage logs. |
|
||||
| Photon billing details | **No** | Self-explanatory. |
|
||||
|
||||
If you accidentally publish an AppId somewhere public, you can rotate
|
||||
it: delete the app in the Photon dashboard, create a new one, paste
|
||||
the new AppId into DorkNet. Existing join codes stop working; share
|
||||
new ones.
|
||||
|
||||
## Free tier limits
|
||||
|
||||
At time of writing the Photon free tier covers:
|
||||
|
||||
- 20 concurrent users (CCU) — i.e. 20 people simultaneously connected
|
||||
through your Realtime app
|
||||
- 60 messages/second/user
|
||||
- No card required, no expiry
|
||||
|
||||
For a friends-and-family server this is enough. You'll see a warning on
|
||||
the Photon dashboard if you start hitting limits; the paid plans bump
|
||||
the CCU cap.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Photon CustomAuth 401" in the server log
|
||||
|
||||
The Realtime AppId on the server doesn't match what got embedded in
|
||||
your patched client. Either:
|
||||
- You changed the AppId in the launcher after applying the patch —
|
||||
re-share the join code and have joiners re-patch.
|
||||
- You're running an older patched client from a previous join code —
|
||||
re-patch with the current one.
|
||||
|
||||
### Joiner can't reach the room (game stuck loading)
|
||||
|
||||
Region mismatch. Both sides must use the same region. Confirm in your
|
||||
launcher's **CLOUD REGION** dropdown; ask your friend to re-patch with
|
||||
your latest join code.
|
||||
|
||||
### Voice chat is silent
|
||||
|
||||
You either didn't set a Voice AppId, or you set one but the joiner's
|
||||
patched client doesn't have it. Re-patch with a fresh join code that
|
||||
includes both AppIds.
|
||||
@@ -0,0 +1,275 @@
|
||||
# Headless host — Linux & macOS
|
||||
|
||||
> For hosts running a server from a Linux box, a Mac, or a VPS. Joiners
|
||||
> on Windows still use the [Windows launcher](easy-setup.md) to apply
|
||||
> the patch to their copy of Rec Room.
|
||||
|
||||
`dorknet-server` is a small command-line tool that does the host side
|
||||
of what the Windows launcher does: downloads the server build, opens a
|
||||
[Tunnelto](https://tunnelto.dev) tunnel, runs the server, and prints
|
||||
a join code. It runs on Linux, macOS, and Windows.
|
||||
|
||||
## What you'll need
|
||||
|
||||
- A machine running Linux (x64 or arm64), macOS (Intel or Apple
|
||||
Silicon), or Windows
|
||||
- [Tunnelto](https://github.com/agrinman/tunnelto) on PATH (for the
|
||||
default mode that exposes your server publicly)
|
||||
- A Photon Realtime AppId — see [photon-setup.md](photon-setup.md)
|
||||
- ~500 MB free disk (server binary + SQLite database)
|
||||
|
||||
You **do not** need Rec Room installed on the host machine. The server
|
||||
doesn't run the game; joiners run their own (Windows) copy.
|
||||
|
||||
## Install
|
||||
|
||||
Grab the matching archive from the
|
||||
[latest release](https://github.com/DorkSquadRR/DorkNet/releases/latest):
|
||||
|
||||
| Platform | Asset |
|
||||
| --- | --- |
|
||||
| Linux x64 | `dorknet-server-linux-x64.tar.gz` |
|
||||
| Linux arm64 | `dorknet-server-linux-arm64.tar.gz` |
|
||||
| macOS Apple Silicon | `dorknet-server-osx-arm64.tar.gz` |
|
||||
| macOS Intel | `dorknet-server-osx-x64.tar.gz` |
|
||||
| Windows x64 | `dorknet-server-win-x64.zip` |
|
||||
|
||||
Unpack, then either keep it where it is or move the `dorknet-server`
|
||||
binary onto your `PATH`.
|
||||
|
||||
```sh
|
||||
# Linux / macOS
|
||||
curl -L https://github.com/DorkSquadRR/DorkNet/releases/latest/download/dorknet-server-linux-x64.tar.gz | tar xz
|
||||
chmod +x dorknet-server
|
||||
./dorknet-server --help
|
||||
```
|
||||
|
||||
```pwsh
|
||||
# Windows (PowerShell)
|
||||
Invoke-WebRequest https://github.com/DorkSquadRR/DorkNet/releases/latest/download/dorknet-server-win-x64.zip -OutFile dorknet-server.zip
|
||||
Expand-Archive dorknet-server.zip
|
||||
.\dorknet-server\dorknet-server.exe --help
|
||||
```
|
||||
|
||||
### Tunnelto
|
||||
|
||||
The CLI shells out to `tunnelto` for the public tunnel. Quickest install:
|
||||
|
||||
```sh
|
||||
# macOS (Homebrew)
|
||||
brew install tunnelto
|
||||
|
||||
# Linux (cargo)
|
||||
cargo install tunnelto
|
||||
|
||||
# Or grab a binary from github.com/agrinman/tunnelto/releases
|
||||
```
|
||||
|
||||
Skip Tunnelto if you're running in `--mode lan` (LAN-only, no public
|
||||
URL).
|
||||
|
||||
## Usage
|
||||
|
||||
The minimum invocation is just your Photon AppId:
|
||||
|
||||
```sh
|
||||
dorknet-server --photon-id 12345678-aaaa-bbbb-cccc-1234567890ab
|
||||
```
|
||||
|
||||
The CLI prints progress, then a join code:
|
||||
|
||||
```
|
||||
DorkNet server CLI · v0.1.0
|
||||
mode: Internet
|
||||
server: DorkNet Server
|
||||
photon: ********90ab (us)
|
||||
|
||||
[server] downloading…
|
||||
54.2% (27.1 / 50.0 MB)
|
||||
[server] cached at /home/alex/.local/share/DorkNet/servers/march_2020_03_10
|
||||
[tunnel] starting tunnelto…
|
||||
[tunnel] live at https://dorknet-abc123.tunnelto.me (apex=dorknet-abc123.tunnelto.me)
|
||||
[server] starting…
|
||||
[server] listening (logs: /home/alex/.local/share/DorkNet/logs/server-…log)
|
||||
|
||||
══════════════════════════════════════════════════════
|
||||
Server live: DorkNet Server
|
||||
Address: https://dorknet-abc123.tunnelto.me
|
||||
|
||||
Join code (paste this into your friend's launcher):
|
||||
|
||||
eyJob3N0IjoiZG9ya25ldC1hYmMxMjMudHVubmVsdG8ubWUiLCJ2I...
|
||||
|
||||
Ctrl-C to stop.
|
||||
══════════════════════════════════════════════════════
|
||||
```
|
||||
|
||||
Copy the join code, send it to your friend, they paste it into their
|
||||
Windows launcher's **Join a friend** view.
|
||||
|
||||
Stop the server with `Ctrl-C` — the CLI shuts the server + tunnel
|
||||
down cleanly.
|
||||
|
||||
## Common options
|
||||
|
||||
```
|
||||
--photon-id <guid> Required. Photon Realtime AppId.
|
||||
--voice-id <guid> Optional. Photon Voice AppId (Discord on the side
|
||||
works fine without this).
|
||||
--region <code> Photon cloud region — us, eu, asia, jp, sa, kr,
|
||||
in, au. Default: us. All joiners use the same.
|
||||
--name "<text>" Server display name in the join code.
|
||||
Default: "DorkNet Server".
|
||||
--mode <kind> tunnelto (default) — public, friends anywhere
|
||||
wildcard — your own Tunnelto apex
|
||||
lan — same WiFi only, no tunnel
|
||||
--apex <hostname> Wildcard apex. Required for --mode wildcard.
|
||||
Example: dorknet.example.tunnelto.me
|
||||
--version <key> Rec Room version key. Default: march_2020_03_10
|
||||
(the only branch currently supported).
|
||||
--server-dir <path> Skip download — use a local build at this path.
|
||||
Useful for dev work on the server itself.
|
||||
```
|
||||
|
||||
Run with `--help` for the canonical list.
|
||||
|
||||
## Examples
|
||||
|
||||
```sh
|
||||
# Sunday games server with a custom name, EU region
|
||||
dorknet-server \
|
||||
--photon-id 12345678-aaaa-bbbb-cccc-1234567890ab \
|
||||
--name "Sunday games" \
|
||||
--region eu
|
||||
|
||||
# LAN party — no tunnel, joiners must be on the same WiFi
|
||||
dorknet-server --photon-id ... --mode lan
|
||||
|
||||
# Custom Tunnelto wildcard base
|
||||
dorknet-server \
|
||||
--photon-id ... \
|
||||
--mode wildcard \
|
||||
--apex dorknet.acme.tunnelto.me
|
||||
|
||||
# Voice chat enabled
|
||||
dorknet-server --photon-id ... --voice-id 87654321-...
|
||||
|
||||
# Iterate on a local server build during dev
|
||||
dorknet-server --photon-id ... \
|
||||
--server-dir /home/alex/src/DorkNet/DorkNet.Server/bin/Debug/net9.0
|
||||
```
|
||||
|
||||
## Run as a systemd service (Linux)
|
||||
|
||||
Make a service so the server restarts on reboot:
|
||||
|
||||
```ini
|
||||
# /etc/systemd/system/dorknet.service
|
||||
[Unit]
|
||||
Description=DorkNet private Rec Room server
|
||||
After=network-online.target
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=alex
|
||||
ExecStart=/home/alex/bin/dorknet-server \
|
||||
--photon-id 12345678-aaaa-bbbb-cccc-1234567890ab \
|
||||
--region eu \
|
||||
--name "Sunday games"
|
||||
Restart=on-failure
|
||||
RestartSec=10
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
```sh
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable --now dorknet
|
||||
journalctl -fu dorknet # follow the logs
|
||||
```
|
||||
|
||||
> Heads-up: each new tunnel session gets a fresh `*.tunnelto.me`
|
||||
> hostname, so the join code rotates on restart. Either re-share
|
||||
> the new code with your friends, or use `--mode wildcard` with a
|
||||
> stable apex.
|
||||
|
||||
## Run as a launchd agent (macOS)
|
||||
|
||||
```xml
|
||||
<!-- ~/Library/LaunchAgents/com.dorknet.server.plist -->
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
|
||||
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>Label</key><string>com.dorknet.server</string>
|
||||
<key>ProgramArguments</key>
|
||||
<array>
|
||||
<string>/usr/local/bin/dorknet-server</string>
|
||||
<string>--photon-id</string><string>YOUR-APPID</string>
|
||||
<string>--region</string><string>us</string>
|
||||
</array>
|
||||
<key>RunAtLoad</key><true/>
|
||||
<key>KeepAlive</key><true/>
|
||||
<key>StandardOutPath</key><string>/tmp/dorknet.log</string>
|
||||
<key>StandardErrorPath</key><string>/tmp/dorknet.err</string>
|
||||
</dict>
|
||||
</plist>
|
||||
```
|
||||
|
||||
```sh
|
||||
launchctl load ~/Library/LaunchAgents/com.dorknet.server.plist
|
||||
```
|
||||
|
||||
## Files & state
|
||||
|
||||
The CLI follows XDG-ish conventions on Linux/macOS and the standard
|
||||
`%APPDATA%` / `%LOCALAPPDATA%` paths on Windows:
|
||||
|
||||
| Path | Contents |
|
||||
| --- | --- |
|
||||
| `$XDG_DATA_HOME/DorkNet/` (Linux) <br/> `~/Library/Application Support/DorkNet/` (macOS) <br/> `%APPDATA%\DorkNet\` (Windows) | Server SQLite DB (`dorknet.db`), JWT signing secret |
|
||||
| same prefix `/servers/<version>/` | Downloaded server binaries (~50 MB each, cached across runs) |
|
||||
| same prefix `/logs/` | Per-session server stdout / stderr |
|
||||
|
||||
The CLI does not read or write the Windows launcher's `state.json` —
|
||||
it's stateless across runs (all config comes from CLI args).
|
||||
|
||||
## Limitations
|
||||
|
||||
- **No client patcher.** Joiners need the Windows launcher to patch
|
||||
their Rec Room install — there is no patch-from-Linux flow yet
|
||||
because Rec Room is a Windows game and the patcher manipulates a
|
||||
Windows PE binary.
|
||||
- **No GUI.** Use the Windows [`dorknet.exe`](easy-setup.md) if you
|
||||
want a graphical launcher.
|
||||
- **No auto-updates.** Pull a new release manually when you want one.
|
||||
Watch the GitHub releases feed or run a periodic check in your
|
||||
service.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### `tunnelto was not found`
|
||||
|
||||
The CLI couldn't find a `tunnelto` binary. Install it (see above) or
|
||||
drop the binary next to `dorknet-server`.
|
||||
|
||||
### `couldn't fetch versions.json`
|
||||
|
||||
You're offline or GitHub is blocked. Either fix the connection or
|
||||
point `DORKNET_LOCAL_MANIFEST` at a local copy of versions.json.
|
||||
|
||||
### `No server binary found in …`
|
||||
|
||||
The downloaded archive doesn't contain the expected `DorkNet.Server`
|
||||
file. Likely cause: the release for your platform hasn't been
|
||||
published yet. Workaround: build the server from source and pass
|
||||
`--server-dir /path/to/built/server`.
|
||||
|
||||
### Same Photon errors as the GUI launcher
|
||||
|
||||
Photon issues (CustomAuth 401, region mismatch, voice silent) have
|
||||
the same fixes as on Windows. See
|
||||
[photon-setup.md → Troubleshooting](photon-setup.md#troubleshooting).
|
||||
Reference in New Issue
Block a user