Welkin
Rust reimplementation of OpenSimulator 0.9.3.0 grid services and region simulator. It aims to match the C# server on the wire and in its database schema, so existing grids can migrate without losing content.
Your existing grid, content and viewer, on a server that is easier to run and harder to break.
Status: alpha (v0.1.0-alpha). Welkin builds, runs, and lets a viewer log in to a single-region grid on SQLite. It is not ready for a production grid. See the viewer compatibility page for what works and what does not.
This book has two parts.
Operator guide
For people who run a grid or a region.
- Quick start: build, configure and run
- Configuration reference: every
welkin.tomlandrobust.tomlkey - Database setup: SQLite (verified), MariaDB and PostgreSQL (untested)
- Regions, estate and users: the region console, estate owner, accounts
- ROBUST grid services server, Container deployment, Operator guide, Test grid deployment
- Migration guide: C# to Rust, with rollback at every step
- Viewer compatibility and OSgrid compatibility
Agent build guide
For people and AI agents who develop Welkin.
- Architecture and Crate structure
- Module development guide: write a region module
- Script engine and OSSL reference
- Testing: cargo tests, CI, golden vectors, bots, the LibreMetaverse harness
- OpenSpec workflow and Task system
- Decision log
Phase summaries
Reference
- Licence audit: C# dependencies, compatibility, dropped items
- LSL corpus analysis: function frequency in real scripts
- Naming and trademarks
- Script engine spike results
- Final acceptance review
Security reviews
All security-critical phases receive an adversarial Opus review before acceptance. Current verdicts:
| Review | Verdict | Critical | High | Medium |
|---|---|---|---|---|
| Permissions | CONDITIONAL PASS | 1 | 3 | 4 |
| OSSL API | CONDITIONAL PASS | 0 | 1 | 2 |
| Script sandboxing | CONDITIONAL PASS | 0 | 2 | 4 |
| Remote writes | CONDITIONAL PASS | 1 | 4 | 6 |
| Archives | CONDITIONAL PASS | 0 | 0 | 5 |
| Social modules | CONDITIONAL PASS | 0 | 3 | 10 |
| Hypergrid | CONDITIONAL PASS | 3 | 3 | 3 |
| Voice | CONDITIONAL PASS | 0 | 2 | 3 |
[!WARNING] All phases carry a CONDITIONAL PASS. The tracked findings must be resolved before production deployment. See each review for specifics.
Building the docs
These docs are plain GitHub-Flavored Markdown and render on GitHub with no tooling. To build a static site locally:
cargo install mdbook mdbook-mermaid mdbook-admonish
cd docs
mdbook build
# open book/index.html