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.

Agent build guide

For people and AI agents who develop Welkin.

Phase summaries

Reference

Security reviews

All security-critical phases receive an adversarial Opus review before acceptance. Current verdicts:

ReviewVerdictCriticalHighMedium
PermissionsCONDITIONAL PASS134
OSSL APICONDITIONAL PASS012
Script sandboxingCONDITIONAL PASS024
Remote writesCONDITIONAL PASS146
ArchivesCONDITIONAL PASS005
Social modulesCONDITIONAL PASS0310
HypergridCONDITIONAL PASS333
VoiceCONDITIONAL PASS023

[!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