Zone Sheet โ
When making source sheets, always copy the first 3 rows from the official source sheet and start your data at the 4th row. Do not alter the column order.
Sheet Columns โ
| Column | Type | Description |
|---|---|---|
| id | string | Unique identifier for the zone. If the ID matches a vanilla entry's or another mod's entry's ID, the last sheet to load will override the others. This value cannot contain spaces โ use snake_case style if needed, e.g. mymod_zone_funk_house. |
| parent | string | The parent zone ID. |
| name_JP | string | Zone display name in Japanese. |
| name | string | Zone display name in English. For other languages, use SourceLocalization. |
| type | string | Zone C# type name. This can be an existing Zone type or a Zone subclass from your DLL. |
| LV | int | Danger level. |
| chance | int | Random site spawn chance when tag contains random. |
| faction | string | Faction ID this zone belongs to. |
| value | int | Zone value used in the home ranking list. |
| idProfile | string | Zone profile ID; determines how the map is generated. |
| idFile | string | Map file name placed in the Maps folder. If empty, a random map will be used. |
| idBiome | string | Biome type. |
| idGen | string | Dungeon generator type. Unused. |
| idPlaylist | string | Playlist. CWL is required for custom playlists currently. |
| tag | string | A comma-separated list of tags applied to this zone. See Tag Reference below for common tags. |
| cost | int | Unused. |
| dev | int | Default zone development level. |
| image | string | Unused. |
| pos | int[] | Zone position on the world map, formatted as x,y,icon ID. See World Icon ID below to find icon IDs. |
| questTag | string | Possible quest types in this zone. Ignored when the zone belongs to the player's faction. |
| textFlavor_JP | string | Flavor text shown when entering the zone, in Japanese. |
| textFlavor | string | Flavor text shown when entering the zone. |
| detail_JP | string | Description of the zone, in Japanese. |
| detail | string | Description of the zone. |
Tag Reference โ
Common tags used in the tag column:
| Tag | Description |
|---|---|
addMap | Automatically spawn this map into the world. |
return | Allow this zone to be used as a return location, even if it is not the player's home. |
tech | Use tech-style boxes for merchant inventory backgrounds. |
light | Enable lighting in this zone, even if it is not a player faction zone. |
random | Allow this zone to appear as a random site on the world map. |
closed | Mark this zone as closed / inaccessible. |
World Icon ID โ
The pos column uses x,y,icon ID format. The third value icon ID is the numeric ID of a world-map icon from the game's built-in tileset. Hover over the tileset below to see each icon's ID, then use it in your pos column.
Custom zone icons from external sprites are not yet supported.
Tileset Viewer
Custom Zone Type โ
You can use a custom zone type defined in a C# DLL.
Example:
cs
public class Zone_MyFunkHouse : Zone_Civilized
{
// overrides
}The base class must be derived from Zone, and you can freely choose which Zone type to use.