User:Kernelmethod/Sandbox:ZoneBuilders
 |
This page is about modding. See the modding overview for an abstract on modding. |
 |
This article has information that is missing or not up to par.
Reason: This article is currently a work-in-progress. Please check back later. |
Reason: This article is currently a work-in-progress. Please check back later.
Zone builders are bits of code that allow you to shape the generation of a zone. At the lowest level of detail they are used to place and remove objects from zones; more broadly, they can be used to shape the geometry and encounters that a player runs into in a room.
The game provides a limited suite of generic builders that you may find useful for your mod. In general, if you are making small alterations to a zone you do not need to deal with zone builders. On the other hand, if you're planning to create your own maps with custom procedural generation, you will want to know how to write them by hand.
Using zone builders
 |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
Generic, pre-existing zone builders
The game provides a limited suite of zone builders that are sufficiently generic that they can be easily applied to any zone.
| Builder name | Description |
|---|---|
| Connecter | |
| FactionEncounters | Adds encounters with legendary creatures sampled from a provided table. |
| MapBuilder | This builder loads a map from a .rpm file. A MapBuilder is implicitly to a zone by the <map/> tag in Worlds.xml. For example, the map for the  Yd Freehold is added as follows:
<map FileName="YdFreehold.rpm" />
|
| Music | Adds a music track to a zone. A Music zone builder is implicitly added by the <music/> tag in Worlds.xml. For example, the music for the  salt dunes is added with
<music Track="MoghrayiRemembrance" />
|
| SolidEarth | Fills the entire map with  shale. This is useful when you wish to carve out the geometry of your zone (i.e., specify the empty space rather than specify the filled space).
|
| StairConnector | |
| StairsDown | Adds a set of  stairs down to the next Z-level. You can specify X- and Y- coordinates to influence the region in which the stairs are placed.
|
| StairsUp | Adds a set of  stairs up to the previous Z-level. You can specify X- and Y- coordinates to influence the region in which the stairs are placed.
|
| TileBuilding |
In general, the game's existing zone builders tend to be highly monolithic, so any zone builders not listed above are not recommended for use in creating new types of zones. For new zones modders should favor a more modular architecture.
Strategies for creating ZoneBuilders
| |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
The ZoneBuilderSandbox interface
| |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
Helpful utilities
| |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
Creating encounters with zone templates
| |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
Procedural generation
| |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |