mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-25 23:18:44 -07:00
Alexa
bcc5fe1bcb
- Create README.md for project overview and setup instructions - Add admin-ui/README.md for admin UI details and development setup - Introduce client-mod/README.md explaining the MelonLoader mod functionality - Establish docker/README.md for Docker setup and configuration - Create docs/README.md to index project documentation - Implement advanced-setup.md for Docker stack configuration - Document architecture in architecture.md - Provide easy-setup.md for hosting instructions - Add FAQ.md for common questions and legal considerations - Create joining-a-server.md for player connection instructions - Establish troubleshooting.md for common issues and resolutions - Introduce easy-app/README.md for the unified desktop application - Add server/README.md for ASP.NET Core backend details - Document tools/README.md for CLI helper scripts
85 lines
3.0 KiB
Markdown
85 lines
3.0 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 2020.03.10
|
|
> install.
|
|
|
|
---
|
|
|
|
## Two ways to run it
|
|
|
|
### 🎮 Easy mode — desktop app
|
|
|
|
One download. Double-click. Choose "host" or "join" on first launch.
|
|
|
|
- **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.
|
|
|
|
→ **[Easy setup guide](docs/easy-setup.md)** — screenshots, takes 5 minutes.
|
|
|
|
[Download the latest Easy app →](https://github.com/YOUR_GH_USERNAME/dorknet/releases/latest)
|
|
|
|
### 🛠️ Advanced mode — Docker
|
|
|
|
For people running a community server, doing custom modding, or contributing
|
|
back. Postgres + Redis + the ASP.NET Core server behind an nginx reverse proxy.
|
|
|
|
```bash
|
|
git clone https://github.com/YOUR_GH_USERNAME/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 | 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
|
|
|
|
- [Easy setup](docs/easy-setup.md)
|
|
- [Advanced setup](docs/advanced-setup.md)
|
|
- [Joining a server](docs/joining-a-server.md)
|
|
- [Architecture](docs/architecture.md)
|
|
- [FAQ](docs/faq.md)
|
|
- [Contributing](CONTRIBUTING.md)
|