Creating mods - Revision history

Gary: Categorize for shared dynamic Main Page and navigation groups

2026-10-06T17:50:30Z

Categorize for shared dynamic Main Page and navigation groups

← Older revision		Revision as of 17:50, 6 October 2026
Line 26:		Line 26:
	{{Guide navigation}}		{{Guide navigation}}
	[[Category:Guides]]		[[Category:Guides]]

			[[Category:Creating mods]]

Gary: Use the Map Mod Kit README’s exact export-plugin name and settings route

2026-10-05T21:47:40Z

Use the Map Mod Kit README’s exact export-plugin name and settings route

← Older revision		Revision as of 21:47, 5 October 2026
Line 13:		Line 13:
	'''Mods → Create → Map''' supplies a playable harbor template inside the game. Edit its data using the [[Modding#Custom maps\|map reference]].		'''Mods → Create → Map''' supplies a playable harbor template inside the game. Edit its data using the [[Modding#Custom maps\|map reference]].

	The visual '''Map Mod Kit''' is included in the project's source checkout at <code>tools/map-mod-kit</code>. Source-project users can copy that folder into their own working folder and import its <code>project.godot</code> in '''Godot 4.7'''. Open <code>map.tscn</code> and use '''Export Map Mod''' to produce the installable data pack. If the export command is absent, enable ~~the supplied~~ Map Mod ~~Exporter plugin in~~ the kit's ~~project settings, as its~~ README describes.		The visual '''Map Mod Kit''' is included in the project's source checkout at <code>tools/map-mod-kit</code>. Source-project users can copy that folder into their own working folder and import its <code>project.godot</code> in '''Godot 4.7'''. Open <code>map.tscn</code> and use '''Export Map Mod''' to produce the installable data pack. If the export command is absent, enable '''Map Mod Export''' under '''Project → Project Settings → Plugins''', as the kit's README describes.

	This wiki currently provides no separate kit download. Players with only the game can start with the built-in Map template; obtaining the visual kit requires access to the source-project folder. The editor project and its exported pack are separate artifacts.		This wiki currently provides no separate kit download. Players with only the game can start with the built-in Map template; obtaining the visual kit requires access to the source-project folder. The editor project and its exported pack are separate artifacts.

Gary: Add authoring journey and clarify source-checkout Map Mod Kit acquisition

2026-10-05T21:33:43Z

Add authoring journey and clarify source-checkout Map Mod Kit acquisition

New page

Create a data-only pack from a matching template, make one small change, then validate it. Packs can add room variants, decorative rooms, wallpapers and maps. They cannot supply runtime scripts.

== First pack ==
# Open '''Mods → Create''' on the title screen. Enter a title and description and choose Store, Restaurant, Residential, Office, Decor, Wallpaper or Map.
# Select '''Create mod''', then '''Open mods folder''' in the Edit step. The game copies the chosen template into the local mods directory.
# Edit the copied pack. Start with one supported value or artwork change and keep the generated pack ID stable. See [[Modding#Manifest|Manifest]] and [[Modding#Room definitions|Room definitions]] for the exact format.
# Select the pack in '''Mods → Publish''' and choose '''Validate'''. Fix the reported errors.
# Enable the pack, restart the game and check the changed content in a small tower or map before relying on it in an existing save.

See [[Modding#Artwork and translations|Artwork and translations]] and [[Modding#Wallpaper artwork|Wallpaper artwork]] for dimensions and frame mappings. Use the template matching the inherited room behaviour.

== Create a map ==
'''Mods → Create → Map''' supplies a playable harbor template inside the game. Edit its data using the [[Modding#Custom maps|map reference]].

The visual '''Map Mod Kit''' is included in the project's source checkout at <code>tools/map-mod-kit</code>. Source-project users can copy that folder into their own working folder and import its <code>project.godot</code> in '''Godot 4.7'''. Open <code>map.tscn</code> and use '''Export Map Mod''' to produce the installable data pack. If the export command is absent, enable the supplied Map Mod Exporter plugin in the kit's project settings, as its README describes.

This wiki currently provides no separate kit download. Players with only the game can start with the built-in Map template; obtaining the visual kit requires access to the source-project folder. The editor project and its exported pack are separate artifacts.

== Preserve save compatibility ==
Keep published pack and content IDs stable. Saves require the recorded <code>save_compatibility_version</code>, default 1, to match and all referenced content IDs to remain available. Change the compatibility version when breaking the saved-content contract; changing the release version string alone does not make a breaking update compatible. See [[Modding#Enable, publish and save|Enable, publish and save]].

== Publish through Workshop ==
With Steam running, validate the local pack in '''Mods → Publish''' and use '''Upload to Steam Workshop'''. New items begin private. Open '''View on Workshop''' to review the item before choosing its visibility. Keep the Workshop sidecar file beside the pack folder to update the same item later. Use a square preview around 512 × 512 pixels and under 1 MB.

For installation steps, see [[Using mods]]. For all supported fields and restrictions, see [[Modding]].
{{Guide navigation}}
[[Category:Guides]]