TheSunIsLeaking/DorkNet
3
0
Fork 0
mirror of https://github.com/DorkSquadRR/DorkNet.git synced 2026-10-25 23:18:44 -07:00
Code Issues Packages Projects Releases Wiki Activity

main: branch-aware README + BRANCHES.md + versions.json

Browse Source 
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.
This commit is contained in:
Alexa
2026-05-26 01:17:14 +03:00
parent dc1e5436b5
commit d1cc50622b
11 changed files with 178 additions and 332 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+54 -22
View File
@@ -1,38 +1,65 @@
# DorkNet
A self-hostable reimplementation of the 2020 Rec Room backend. Bring your own
client; run a private server for yourself and your friends.
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 2020.12.18
> 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. Double-click. Choose "host" or "join" on first launch.
One download. Pick a client version on first launch. Hosts can switch
between supported builds without re-installing the launcher.
- **Host a server** for you and your friends — runs a local server + tunnel,
patches your Rec Room install, and gives you a shareable join code.
- **Join a server** someone shared with you — paste the code, point at your
Rec Room install, hit play.
- **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, takes 5 minutes.
→ **[Easy setup guide](docs/easy-setup.md)** — screenshots, ~5 minutes.
[Download the latest Easy app →](https://github.com/YOUR_GH_USERNAME/dorknet/releases/latest)
[Download the latest Easy app →](https://github.com/DorkSquadRR/DorkNet/releases/latest)
### 🛠️ Advanced mode — Docker
### 🛠️ Advanced mode — Docker / source
For people running a community server, doing custom modding, or contributing
back. Postgres + Redis + the ASP.NET Core server behind an nginx reverse proxy.
For community-server hosts, modders, and contributors. Pick the branch
matching your client build, clone, run.
```bash
git clone https://github.com/YOUR_GH_USERNAME/dorknet
cd dorknet/docker
# 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
```
@@ -43,6 +70,9 @@ docker compose up -d
## 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 | ✅ |
@@ -69,16 +99,18 @@ docker compose up -d
- **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.
- DorkNet is a clean-room reimplementation of the 2020 backend protocol
for educational and personal use.
---
## Docs
- [Easy setup](docs/easy-setup.md)
- [Advanced setup](docs/advanced-setup.md)
- [Joining a server](docs/joining-a-server.md)
- [Architecture](docs/architecture.md)
- [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)