Modding - Revision history

Gary: Proofread spelling, grammar and sentence flow.

2026-10-12T00:03:14Z

Proofread spelling, grammar and sentence flow.

← Older revision		Revision as of 00:03, 12 October 2026
Line 2:		Line 2:

	== Installing mods ==		== Installing mods ==
	The easiest way to install mods is through Steam Workshop. Browse through the workshop for mods and subscribe ones that interest you. The next time you start the game through Steam, the subscribed mods will automatically be listed in the mods window, waiting for you to enable it for the game. You can enable the mod by toggling the mod on.		The easiest way to install mods is through Steam Workshop. Browse through the workshop for mods and subscribe to ones that interest you. The next time you start the game through Steam, the subscribed mods will automatically be listed in the mods window, waiting for you to enable them for the game. You can enable the mod by toggling the mod on.

	== Creating mods ==		== Creating mods ==
	Mods are data-driven content ~~pack that is~~ defined through ~~a bunch of json~~ files along with your assets. Creating a new mod involves 3 major steps:		Mods are data-driven content packs defined through JSON files along with your assets. Creating a new mod involves 3 major steps:

	# Create a mod template using the in-game mod template generator		# Create a mod template using the in-game mod template generator
Line 12:		Line 12:

	=== Create a mod template ===		=== Create a mod template ===
	The easiest way to get started with a new mod is to use the Mods window and ~~using the~~ 'Create mod' feature. This menu allows you to create mods for most room types, ~~decoration~~, and wallpapers.		The easiest way to get started with a new mod is to use the Mods window and its 'Create mod' feature. This menu allows you to create mods for most room types, decorations, and wallpapers.

	When you click on create mod, the game will generate a skeleton mod folder with a basic structure of a new content pack containing your room. The directory structure of this mod should look something like this:<pre>		When you click on create mod, the game will generate a skeleton mod folder with a basic structure of a new content pack containing your room. The directory structure of this mod should look something like this:<pre>
Line 31:		Line 31:

	=== Edit your new mod ===		=== Edit your new mod ===
	After locating your new mod template ~~location~~, make your changes. Add new assets and define it within the room ~~json~~ definition.		After locating your new mod template folder, make your changes. Add new assets and define them within the room JSON definition.

	Ensure that you add any necessary translations, update the mod pack icon, and update the mod manifest ~~json~~ file to include your changes. Refer to the technical details in the sections below.		Ensure that you add any necessary translations, update the mod pack icon, and update the mod manifest JSON file to include your changes. Refer to the technical details in the sections below.

	=== Verify and publish ===		=== Verify and publish ===
	If your mod is working, you should be able to see it listed in the mod window. Select your mod and click on 'Verify' to ensure it is readable and compatible with the game. You can then publish the mod by clicking on 'Publish to Steam'		If your mod is working, you should be able to see it listed in the mod window. Select your mod and click on 'Verify' to ensure it is readable and compatible with the game. You can then publish the mod by clicking on 'Publish to Steam'.

	Open '''Mods''' on the title screen to enable or disable local packs. Restart the game after installing, removing, enabling, disabling or editing a pack because the content catalog is built at startup.		Open '''Mods''' on the title screen to enable or disable local packs. Restart the game after installing, removing, enabling, disabling or editing a pack because the content catalog is built at startup.
Line 122:		Line 122:

	== Custom maps ==		== Custom maps ==
	Use the Map Mod Kit to create custom maps. This kit is a separate Godot project that you can ~~ope~~. It allows you to use the Godot editor to import assets and draw out the map tilemap. The included scripts will then convert your defined map into a compatible mod content pack.		Use the Map Mod Kit to create custom maps. This kit is a separate Godot project that you can open. It allows you to use the Godot editor to import assets and draw out the map tilemap. The included scripts will then convert your defined map into a compatible mod content pack.

	=== Using the map mod kit ===		=== Using the map mod kit ===

Leo at 09:04, 10 October 2026

2026-10-10T09:04:12Z

Show changes

Gary: Categorize for shared dynamic Main Page and navigation groups

2026-10-06T17:50:34Z

Categorize for shared dynamic Main Page and navigation groups

← Older revision		Revision as of 17:50, 6 October 2026
Line 115:		Line 115:
	Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.		Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.

	~~[[Category:Game mechanics]]~~
	{{Guide navigation}}		{{Guide navigation}}

			[[Category:Creating mods]]

Gary: Remove player-facing audit and build-check boilerplate

2026-10-05T22:33:00Z

Remove player-facing audit and build-check boilerplate

← Older revision		Revision as of 22:33, 5 October 2026
Line 115:		Line 115:
	Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.		Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.

	~~<small>Format checked 5 October 2026 against current project snapshot bffae344 and working files (project version 0.1.9); later formats may differ.</small>~~
	[[Category:Game mechanics]]		[[Category:Game mechanics]]
	{{Guide navigation}}		{{Guide navigation}}

Gary: Add current-format note and refresh guide navigation after category creation

2026-10-05T21:45:13Z

Add current-format note and refresh guide navigation after category creation

← Older revision		Revision as of 21:45, 5 October 2026
Line 115:		Line 115:
	Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.		Saves record required pack identities, compatibility versions and Workshop IDs. To open a save, keep its required packs installed and enabled with matching <code>save_compatibility_version</code> values and all referenced content IDs available. The game reports missing or incompatible content instead of silently substituting it. A similarly named Workshop item is not a replacement for the original item.

			<small>Format checked 5 October 2026 against current project snapshot bffae344 and working files (project version 0.1.9); later formats may differ.</small>
	[[Category:Game mechanics]]		[[Category:Game mechanics]]
	{{Guide navigation}}		{{Guide navigation}}

Gary: Add use/create journeys and verified Map Mod Kit source location; preserve full reference

2026-10-05T21:33:53Z

Add use/create journeys and verified Map Mod Kit source location; preserve full reference

← Older revision		Revision as of 21:33, 5 October 2026
Line 1:		Line 1:
	'''Modding''' in 2D Tower uses data-only content packs. Packs can add room variants based on built-in room behaviours, decorative rooms, wallpapers and custom maps. They cannot supply scripts or replace the game's runtime code.		'''Modding''' in 2D Tower uses data-only content packs. Packs can add room variants based on built-in room behaviours, decorative rooms, wallpapers and custom maps. They cannot supply scripts or replace the game's runtime code.

			Choose [[Using mods]] for installation and save troubleshooting, or [[Creating mods]] for the template-to-publishing walkthrough. This page keeps the complete pack format reference.

	== Create or install a pack ==		== Create or install a pack ==
Line 102:		Line 104:
	The Map template provides a playable harbor example. Map packs can define painted scenery, restricted construction cells, street entrances, sky colors, aerial artwork and a subway line. Their objectives and progression can also differ from the built-in maps. List map JSON files under <code>maps</code> in the manifest.		The Map template provides a playable harbor example. Map packs can define painted scenery, restricted construction cells, street entrances, sky colors, aerial artwork and a subway line. Their objectives and progression can also differ from the built-in maps. List map JSON files under <code>maps</code> in the manifest.

	~~If you have~~ the project's Map ~~Mod Kit~~, copy <code>tools/map-mod-kit</code> into your own working folder and import its <code>project.godot</code> in Godot 4.7. Open <code>map.tscn</code> as a separate project. Use its '''Export Map Mod''' command to produce a data-only pack; the editor project itself is not the pack to install.		The visual '''Map Mod Kit''' is supplied in the project's source checkout at <code>tools/map-mod-kit</code>; this wiki currently provides no separate kit download. The game's '''Mods → Create → Map''' template is available for players with only the game. For the visual editor, copy <code>tools/map-mod-kit</code> into your own working folder and import its <code>project.godot</code> in Godot 4.7. Open <code>map.tscn</code> as a separate project. Use its '''Export Map Mod''' command to produce a data-only pack; the editor project itself is not the pack to install.

	Choose stable lowercase pack and map IDs, edit the title and gameplay settings, paint the map and export. Use the kit's example as a guide to scenery and entrances. Validate the resulting pack in the game's Mods window before publishing it. Map settings and objective plans are customizable, so a modded map need not share the built-in [[Star rating\|star requirements]].		Choose stable lowercase pack and map IDs, edit the title and gameplay settings, paint the map and export. Use the kit's example as a guide to scenery and entrances. Validate the resulting pack in the game's Mods window before publishing it. Map settings and objective plans are customizable, so a modded map need not share the built-in [[Star rating\|star requirements]].
Line 114:		Line 116:

	[[Category:Game mechanics]]		[[Category:Game mechanics]]
	{{~~Navbox All~~}}		{{Guide navigation}}

Gary: Update mod templates, tile-cell artwork, maps, wallpapers and save compatibility

2026-10-05T20:40:02Z

Update mod templates, tile-cell artwork, maps, wallpapers and save compatibility

Show changes

Gary: Create modding guide

2026-09-22T19:39:46Z

Create modding guide

New page

'''Modding''' in 2D Tower uses data-only content packs. A pack can add room variants by inheriting one of the game's built-in room behaviours and changing the supported data fields. Mods cannot include scripts, so they cannot replace game code or add a wholly new runtime behaviour.

== Create or install a pack ==
For a local mod, place one pack folder inside the game's local mods directory:

<pre>
user://mods/
└── my_record_store/
├── manifest.json
├── rooms/
│ └── record_store.json
├── textures/
│ └── records.png
├── i18n/
│ ├── en_US.json
│ └── de_DE.json
└── icon.png
</pre>

''user://'' is Godot's per-user data folder. From the title screen, use '''Mods → Publish → Open local mods folder''' to open the correct location; on a standard Windows installation it is normally <code>%APPDATA%\Godot\app_userdata\2D Tower\mods\</code>. Development builds also discover packs in <code>res://mods/</code>. The game discovers only direct subfolders of these directories that contain <code>manifest.json</code>.

The example pack at <code>examples/mods/records/</code> is a working reference. To use it locally, copy its whole folder to <code>user://mods/records/</code>; examples are not discovered automatically in release builds.

== Manifest ==
<code>manifest.json</code> is at the root of the pack folder. Paths in the manifest are relative to that folder and may not escape it.

<syntaxhighlight lang="json">
{
"pack_id": "my_record_store",
"version": "1.0.0",
"enabled": true,
"dependencies": ["base"],
"rooms": ["rooms/record_store.json"],
"translations": {
"en_US": "i18n/en_US.json",
"de_DE": "i18n/de_DE.json"
}
}
</syntaxhighlight>

* '''pack_id''' is the pack's permanent identifier. It must start with a lowercase letter and otherwise use only lowercase letters, numbers, periods, underscores and hyphens. Keep it stable after publishing because saves refer to it.
* '''version''' identifies the compatible pack revision saved with games. Use a new version when a change would make old saves incompatible.
* '''enabled''' is optional and sets the initial state for a local pack. The '''Mods''' window stores the player's final selection in <code>user://mods.cfg</code>.
* '''dependencies''' lists required pack IDs. Most packs depend on <code>base</code>.
* '''rooms''' is an ordered list of room-definition JSON files.
* '''translations''' is optional. Each key is a locale and each value is a JSON translation file.

Pack folders are scanned in a stable order. Duplicate IDs are rejected; a user pack cannot replace a shipped pack.

== Room definitions ==
Every room JSON file inherits a registered built-in room. The file name supplies the room's local ID unless it has an explicit <code>id</code>. For example, <code>rooms/record_store.json</code> in the <code>my_record_store</code> pack becomes <code>my_record_store:room:record_store</code>. Moving the file to another subfolder does not change that ID.

<syntaxhighlight lang="json">
{
"extends": "base:room:store",
"occupancy_mode": "immediate",
"overrides": {
"display_name": "Record Store",
"description": "A specialist shop selling vinyl records.",
"width": 24,
"height": 1,
"entrance_offset": [6, 0],
"construction_cost": 125000,
"maintenance_cost": 100,
"worker_count": 2
},
"icon": "icon.png",
"visual": {
"texture": "textures/records.png",
"region": [0, 0, 768, 258]
}
}
</syntaxhighlight>

<code>extends</code> must name an existing room. The loader makes an independent copy of that parent, so a mod never changes the original room. The supported general overrides are the display name and description, category and palette order, size and entrance, construction/demolition/maintenance costs, worker count, visit duration and custom-entrance setting. Values have to use the required data type; dimensions, coordinates and texture regions are integers.

Depending on the inherited runtime, a room may also use supported profiles such as <code>commercial</code>, <code>residential</code>, <code>stock</code>, <code>garbage</code>, <code>demand</code> and <code>evaluation</code>. Unsupported fields or profiles cause validation to fail rather than being silently ignored. The title-screen templates for Store, Restaurant, Residential and Office create valid starting packs for their respective parent rooms.

== Artwork and translations ==
<code>icon</code> is a PNG path inside the pack. A custom <code>visual</code> uses a texture and <code>region</code> in the form <code>[x, y, width, height]</code>. The selected region contains two equal-height rows: the open appearance first and the closed appearance second. Without a custom visual, the room keeps its parent's artwork, footprint and appearance definitions.

Optional <code>appearances</code> entries define stable cosmetic IDs and their zero-based open-row sprite frame. A custom texture clears inherited appearances unless the mod provides its own entries. Translation files supply localized text; a short appearance <code>display_name_key</code> is scoped automatically to that room's ID.

== Enable, publish and save ==
Open '''Mods''' on the title screen to enable or disable local packs. Restart the game after installing, removing, enabling, disabling or editing a pack because the content catalog is built at startup.

Steam Workshop packs use the same layout: <code>manifest.json</code> sits at the root of the uploaded folder. Workshop installations stay in Steam's managed directory, not in <code>user://mods</code>. New subscriptions start disabled; enable them in '''Mods''' and restart. The Publish tab can create a template, validate a selected pack folder and publish it privately. Its Workshop sidecar file is stored beside the pack folder; keep it to update the same Workshop item later.

Saves record the enabled pack IDs, versions and Workshop IDs. To open a save, its required packs must be installed, enabled and at matching versions. The game reports missing, disabled and version-mismatched packs instead of silently substituting different content.

[[Category:Game mechanics]]
{{Navbox All}}