mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-25 23:18:44 -07:00
Alexa
d1cc50622b
Rewrites main as a docs-only landing branch. Adds: - BRANCHES.md — per-branch chart (client build, status, notes) - versions.json — machine-readable manifest the Easy launcher reads - Branch-picking step + Easy-app/Docker URLs updated in README + docs/advanced-setup.md Drops the per-folder README stubs (server/, admin-ui/, client-mod/, docker/, easy-app/, tools/) — the actual code lives on per-version branches now, not on main.
117 lines
4.4 KiB
Markdown
117 lines
4.4 KiB
Markdown
# DorkNet
|
|
|
|
A self-hostable reimplementation of the 2020 Rec Room backend. Bring your
|
|
own client; run a private server for yourself and your friends.
|
|
|
|
> ⚠️ **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) | Pending import |
|
|
|
|
See [BRANCHES.md](BRANCHES.md) for the full per-branch breakdown
|
|
(supported features, schema notes, plugin compatibility). Programs that
|
|
need the mapping in machine-readable form (the Easy launcher, install
|
|
scripts) 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. All actual server / patcher code lives on the per-version
|
|
branches above.
|
|
|
|
---
|
|
|
|
## Two ways to run it
|
|
|
|
### 🎮 Easy mode — desktop app
|
|
|
|
One download. Pick a client version on first launch. Hosts can switch
|
|
between supported builds without re-installing the launcher.
|
|
|
|
- **Host a server** — runs a local server + Cloudflare tunnel for the
|
|
client version you choose, patches your Rec Room install, 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 client patcher for the
|
|
host's server version.
|
|
|
|
→ **[Easy setup guide](docs/easy-setup.md)** — screenshots, ~5 minutes.
|
|
|
|
[Download the latest Easy app →](https://github.com/DorkSquadRR/DorkNet/releases/latest)
|
|
|
|
### 🛠️ Advanced mode — Docker / source
|
|
|
|
For community-server hosts, modders, and contributors. Pick the branch
|
|
matching your client build, clone, run.
|
|
|
|
```bash
|
|
# Example: hosting for December 2020.12.18 clients
|
|
git clone --branch december-2020-12-18 https://github.com/DorkSquadRR/DorkNet
|
|
cd DorkNet/docker
|
|
cp .env.example .env # fill in 2-3 values
|
|
docker compose up -d
|
|
```
|
|
|
|
→ **[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.) | ⚠️ Photon-dependent; works in dev, untested at scale |
|
|
| Mobile / Junior accounts | ⚠️ Partial — Junior chat-restrictions disabled by default in Easy mode |
|
|
| 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) — desktop-launcher path
|
|
- [Advanced setup](docs/advanced-setup.md) — Docker / VPS path
|
|
- [Joining a server](docs/joining-a-server.md) — for players
|
|
- [Architecture](docs/architecture.md) — how the code is laid out
|
|
- [FAQ](docs/faq.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
- [Contributing](CONTRIBUTING.md)
|