Warren — setup guide
Install Warren, generate a first dungeon, then choose between the included automatic setup and the module API. This guide matches the public v0.1.1 revision 3 package.
Setup
Insert Warren
Insert the purchased Warren model into Workspace. If Studio asks whether to enable the included Generate Script, enable it.
Generate the first level
Press Play. The default configuration builds 16 connected rooms and places the player in Start. Warren moves its own room templates to ServerStorage and leaves unrelated objects alone.
Change the layout
Select Warren > Settings and edit the Value objects in Properties. Fire workspace.Warren.Regenerate:Fire() for a fresh effective seed, or pass a non-zero integer such as 12345 for bounded repeatability.
Use the module API
Turn GenerateOnStart off when your own server code should control generation. The module exposes plan, generate, validateRooms, activate, deactivate and destroy.
Customize rooms safely
Copy an included one-cell template and preserve its Origin, four Door* attachments and four Plug* parts. Run validateRooms before generation; malformed or unsafe inputs are refused before a live level is replaced.
Know the boundary
Warren builds a connected one-floor layout and clones its rooms. Add enemies, loot, working doors, traps, persistence and navigation with your own game systems.
Settings
| Setting | Default | What it does |
|---|---|---|
| Seed | 0 | Zero chooses and reports a fresh effective seed; a supported non-zero integer requests a repeatable layout when the documented inputs and Warren version stay unchanged. |
| RoomCount | 16 | Rooms including Start and Exit. Accepted range: 1–400; the cap is a configuration guard, not a performance promise. |
| CellSize | 32 | Grid pitch in studs. The 13 included templates are validated for 32. |
| Ceilings | true | When false, generated BaseParts whose names begin with Ceiling are removed. |
| SpawnAtStart | true | Creates Warren's SpawnLocation and places current and later characters at Start. |
| HideTemplates | true | Moves Warren's captured room-template folder to ServerStorage before committing the live level. |
| GenerateOnStart | true | Runs the included server bootstrap on Play; disable it for module-driven control. |
These settings are Value objects under Warren > Settings and are saved with your place. Move LevelOrigin to move logical cell (0, 0).
Changelog
0.1.1 revision 3 2026-08-25
Current Creator Store revision. Adds bounded readiness handling for slow or custom characters and keeps stale placement work from surviving replacement, deactivation or destruction.
0.1.1 2026-08-25
Adds strict configuration and room validation, structural fingerprints, explicit lifecycle APIs and transactional candidate generation.
0.1.0 2026-08-08
Initial release: 13-room BasePart kit, seeded runtime generator, automatic bootstrap, Settings, Regenerate event and module API.