mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-26 15:38:45 -07:00
Alexa
e3fb9477b1
Add a short plain-language intro at the top of the README explaining what DorkNet is. Mark VR and Mobile as supported in the feature table, and remove the Junior accounts row.
139 lines
5.3 KiB
Markdown
139 lines
5.3 KiB
Markdown
# DorkNet
|
|
|
|
DorkNet lets you run your own private server for old versions of Rec Room.
|
|
It brings back the 2020-era game — logging in, hanging out in your dorm,
|
|
matchmaking, chatting with friends, building rooms — all on a server you
|
|
host yourself. You supply your own legally-owned copy of Rec Room, and
|
|
DorkNet handles the rest: the server, the client patcher, and the setup
|
|
tools to get you playing again.
|
|
|
|
> ⚠️ **Not affiliated with Rec Room Inc. or Against Gravity.**
|
|
> See [DISCLAIMER.md](DISCLAIMER.md). DorkNet ships no Rec Room game assets
|
|
> or modified binaries — you supply your own legally-acquired Rec Room
|
|
> install.
|
|
|
|
---
|
|
|
|
## Pick your client version
|
|
|
|
DorkNet maintains a separate branch for each Rec Room client build it
|
|
supports. The server, client patcher, and seed data on each branch are
|
|
tuned to that build's wire protocol.
|
|
|
|
| Client build | Branch | Status |
|
|
|---|---|---|
|
|
| **Rec Room 2020.12.18** (December) | [`december-2020-12-18`](../../tree/december-2020-12-18) | Active |
|
|
| **Rec Room 2020.03.10** (March) | [`march-2020-03-10`](../../tree/march-2020-03-10) | Active |
|
|
|
|
See [BRANCHES.md](BRANCHES.md) for the full per-branch breakdown:
|
|
supported features, schema notes, and plugin compatibility. Tools that
|
|
need the same list in machine-readable form read it from
|
|
[versions.json](versions.json).
|
|
|
|
This `main` branch is **docs-only** — it carries the project README, the
|
|
manifest the launcher reads, the per-version setup guides, and the Easy
|
|
app source. Server and patcher code lives on the per-version
|
|
branches above.
|
|
|
|
---
|
|
|
|
## Ways to run it
|
|
|
|
### Windows GUI — `dorknet` launcher
|
|
|
|
One download, two flavours: an **installer** (Start menu shortcut +
|
|
rolling auto-updates) or a **portable `dorknet.exe`** (drop anywhere).
|
|
Pick a Rec Room build on first launch, host or join.
|
|
|
|
- **Host a server** — runs a local server, opens a free Localtunnel
|
|
HTTPS URL for it (no account), patches your Rec Room install for the
|
|
client version you pick, and gives you a shareable join code.
|
|
- **Join a server** — paste the code, point at your Rec Room install,
|
|
hit play. The launcher fetches the matching patcher.
|
|
|
|
→ **[Easy setup guide](docs/easy-setup.md)** — screenshots, ~5 minutes.
|
|
|
|
[Download the latest launcher →](https://github.com/DorkSquadRR/DorkNet/releases/latest)
|
|
|
|
### Linux / macOS host — `dorknet-server` CLI
|
|
|
|
Command-line host for Linux (x64/arm64), macOS (Intel/Apple Silicon),
|
|
and Windows. It runs the same server and tunnel flow as the GUI, so it
|
|
works well on a VPS or permanent home server. Joiners still use the
|
|
Windows launcher to patch their own Rec Room install.
|
|
|
|
```sh
|
|
dorknet-server --photon-id YOUR-APPID --name "Sunday games"
|
|
```
|
|
|
|
→ **[Server CLI guide](docs/server-cli.md)** — install, systemd, launchd.
|
|
|
|
### Advanced — Docker / source
|
|
|
|
For community-server hosts, modders, and contributors. `main` is only
|
|
the launcher and project docs, so the real server instructions live on
|
|
the version branch you plan to run.
|
|
|
|
```bash
|
|
# Example: hosting for December 2020.12.18 clients
|
|
git clone --branch december-2020-12-18 https://github.com/DorkSquadRR/DorkNet
|
|
cd DorkNet
|
|
```
|
|
|
|
From there, follow that branch's `README.md` and `docs/deploy.md`.
|
|
The December branch has the newer microservices/Dokploy path; March is
|
|
the older single-server branch.
|
|
|
|
→ **[Advanced setup guide](docs/advanced-setup.md)**
|
|
|
|
---
|
|
|
|
## What works / what doesn't
|
|
|
|
Feature set varies per branch. The table below is the union — see each
|
|
branch's `BRANCHES.md` row for the exact deltas.
|
|
|
|
| Feature | Status |
|
|
| -------------------------------- | ------ |
|
|
| Account creation + login | ✅ |
|
|
| Dorms (per-player save) | ✅ |
|
|
| Rec Room Originals (RecCenter, Paintball, Stunt Runner, etc.) | ✅ |
|
|
| Maker Pen (build + save rooms) | ✅ |
|
|
| Photon Cloud matchmaking | ✅ |
|
|
| Room chat | ✅ |
|
|
| DM / group chat | ✅ |
|
|
| Friend lists + invites | ✅ |
|
|
| Leaderboards | ✅ |
|
|
| Player profiles + cheer badges | ✅ |
|
|
| Store catalog + gifting | ✅ |
|
|
| Game invites | ✅ |
|
|
| Image upload (polaroids, room thumbnails) | ✅ |
|
|
| VR (Quest/Index/etc.) | ✅ |
|
|
| Mobile | ✅ |
|
|
| Voice chat | ❌ Routes through Photon Voice; needs separate Photon Voice AppId |
|
|
| Cross-server federation | ❌ Out of scope |
|
|
|
|
---
|
|
|
|
## License & legal
|
|
|
|
- **Code**: [AGPL-3.0](LICENSE). Hosted forks must publish their source.
|
|
- **"Rec Room"** is a trademark of Rec Room Inc. See [DISCLAIMER.md](DISCLAIMER.md).
|
|
- DorkNet is a clean-room reimplementation of the 2020 backend protocol
|
|
for educational and personal use.
|
|
|
|
---
|
|
|
|
## Docs
|
|
|
|
- [Branch chart](BRANCHES.md) — which branch matches your client
|
|
- [Easy setup](docs/easy-setup.md) — Windows GUI launcher
|
|
- [Server CLI](docs/server-cli.md) — Linux / macOS / Windows headless
|
|
- [Advanced setup](docs/advanced-setup.md) — source, Docker, VPS, and branch deploys
|
|
- [Joining a server](docs/joining-a-server.md) — for players
|
|
- [Photon setup](docs/photon-setup.md) — getting your AppIds
|
|
- [Architecture](docs/architecture.md) — how the code is laid out
|
|
- [FAQ](docs/faq.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
- [Contributing](CONTRIBUTING.md)
|