Help:How To Edit/Props

Props

Free Form Editing

Please add content, screenshots, tips, and clarifying information to existing sections. We value your contribution!

Structured Data

This is open to change in the future, but for the sake of data modeling here are some important groups.

Use

• Building Shells are constructed buildings that provide a structure for building out fitouts and staffing workers. Example: Small Shop
• Dressing are decorative and may provide additional tourist benefits like generating EGO or improving tourist wellbeing. Example: Groffle Ride
• Disposals permanently remove resources (with or without a reward). Example: Garbage Disposal.
• Extractors extract a resource from another prop (ie: Mana Extractor extracts Raw Mana from Mana Nodes). Example: Mana Extractor
• Fitouts are placed in a building shell and provide retail goods or services to tourists. Example: Candy Shop
• Generators create resources. Examples: Fishing Spot, Stone Mining Node
• Housing allows townies to move in and work. Example: Apartments
• Processors transform resources into another resource. Example: Foundry
• Vehicles are transportation for the player. Example: Truck
• Terrains are used for terraforming. Example: Grass
• Tools are instruments used for the player and workers to perform tasks like cutting down trees, mining stone, and fishing. Worker management is also grouped into tools (time clocks). Examples: Drill Tool, Farm Zone Time Clock

All Props

Param	Description	Format	Example	Used In
name	The name of an item that will be displayed in tables, etc. Should match the page name.	string	Planks	Infobox, Item Tables, Page Detail
description	The in-game description for an item.	string	Houses four townies	Infobox
category	The primary category of the item.	Options: Building Disposal Extractor Fitout GeneratorProcessor Vehicle Tile Tool	Building	Infobox, Item Tables, Page Detail
sources	A list of sources this prop can be acquired from.	AnyList-compatible string	2-Basic Housing#ETLink,4-Basic Housing#ETLink,5-Expanded Job Slots#ETLink,7-Basic Housing#ETLink,9-Basic Housing#ETLink,Import App	Infobox, Item Tables, Page Detail
needed_for_challenges	Comma-separated list of challenge=quantity	string	1=10	Page Detail
needed_for_townies	Comma-separated list of townies that require this prop to be built	string	Scruffs,Wheels	Item Table, Page Detail

Additional Params for Building Shells

Param	Description	Format	Example	Used In
fitouts	A list of fitouts this shell supports.	string	Eat N' Go,Craft Corner,Book Nook,Fish N' Chip Shop,Fortune Teller,Pizzeria,Hat Shop	Infobox, Detail, Table

Additional Params for Constructables (Build Menu)

Param	Description	Format	Example	Used In
has_permits	The prop has a limited amount that can be built based on the number of permits unlocked via EGO Tech, the import app, or discovering it (via fishing, etc.)	Yes/No	Yes
build_menu	The primary build menu where the prop is found.	Options: Terraforming Zones Dressing Town Centre Storage Farming Zone Fishing Zone Forestry Zone Mining Zone	Dressing	Infobox, Prop Table, Prop Detail
build_submenu	The build submenu where the prop is found.	Options: Barriers Seating Lighting Points of Interest ...etc	Lighting	Infobox, Prop Table, Prop Detail
build_cost	The cost in coins to build the prop.	number	85	Infobox, Prop Table, Prop Detail
build_materials	A list of materials and their quantities required to build the prop.	AnyList-compatible string	Planks=4,Metal Ingots=3	Infobox, Prop Table, Prop Detail
build_size	The number of grid squares on the ground that the prop requires.	string	2x3	Infobox, Prop Table, Prop Detail
build_terrain	The terrain required to build the prop.	string	Water	Infobox, Prop Table, Prop Detail
build_rotate	Whether the prop can be rotated when placing.	Yes/No	No	Infobox, Prop Table, Prop Detail
build_connections	Whether the prop requires any specific build connections beyond the build terrain requirements. For example, the courier building requires connection to road and footpath.	string	Road=1,Footpath=2
repair_needs	Whether the prop requires repair after a given amount of time or interactions.	Yes or empty	Yes	Infobox, Detail
repair_materials	The list of materials required to repair the prop.	AnyList-compatible string	Metal Ingots=1	Infobox, Detail

Additional Params for Disposals

Param	Description	Format	Example	Used In
disposes_of	A comma-separated list of items the disposal disposes of.	AnyList-compatible string	Garbage	Infobox, Detail

Additional Params for Extractors

Param	Description	Format	Example	Used In
extracts_from	The prop this prop extracts from	string	Mana Node	Infobox, Detail
extracts_item	The item this prop extracts	string	Raw Mana	Infobox, Detail

Additional Params for Fitouts

Param	Description	Format	Example	Used In
fitout_inventory	A comma-separated list of items that this fitout sells.	string	Pet Rock,Wooden Trinket,Geode	Infobox, Detail, Table
fitout_shell_size	The building shell size that supports this fitout.	Small Medium Large	Small	Infobox, Detail, Table
fitout_minigame	Which kind of minigame this fitout has for working as the player.	string		Infobox, Detail, Table
fitout_queue_size	Reserved for future use.

Additional Params for Generators

Param	Description	Format	Example	Used In
generates_resources	A list of the resources that a prop generates.	AnyList-compatible string	Fibre Boards,Firefly Lamp post,Froggy Bridge,Garbage,Large Flower	Infobox, Table, Detail
generates_randomly	If the generates_resources list includes more than one item, whether it drops a number of those items randomly, or whether it drops all of them each time.	Yes or empty	Yes	Infobox, Table, Detail
regnerates_resources	Whether the prop disappears after resources have been collected, or remains and needs time to regenerate.	Yes or empty	Yes	Infobox, Table, Detail
needs_tool	Which tool is required, if required, to harvest the from the generator.	string	Drill Tool	Infobox, Table, Detail

Additional Params for Importables

Param	Description	Format	Example	Used In
import_price	The quantity=price from the import app.	string	1=80	Infobox, Prop Table, Import App Inventory Table
import_rotation_max	The number of props that can be imported per Import App rotation cycle.	number	1	Import App Inventory Table

Additional Params for Interactive Props

Param	Description	Format	Example	Used In
is_interactive	Whether a prop is interactive.	Yes or empty	Yes	Infobox
interact_player_actions	The options for the player to interact with the prop.	string	Ride	Infobox
interact_tourist_actions	The options for tourists to interact with the prop.	string	Ride	Infobox

Additional Params for Housing

Param	Description	Format	Example	Used In
residents	The number of residents the housing offers.	number	4	Infobox, Page Detail

Additional Params for Processors

Param	Description	Format	Example	Used In
maker_recipes	A list of the recipes this crafter can process.	AnyList-compatible string	Bricks,Metal Ingots	Infobox, Table, Detail

Additional Params for Storage

Param	Description	Format	Example	Used In
storage_size	The storage size the item, like a truck, holds.	string	2x2x2	Infobox, Storage Table, Vehicle Table
storage_locks	Whether a storage container has the lock feature.	string	Yes	Infobox, Storage Table

Additional Params for Vehicles

Param	Description	Format	Example	Used In
is_vehicle	Whether the prop is a vehicle.	Yes or empty	Yes || Infobox
vehicle_offroads	Whether the vehicle can traverse all terrain.	Yes/No	Yes	Infobox, Vehicle Table

Additional Params for Disposals & Retail

Param	Description	Format	Example	Used In
sales_currency	Whether items are sold for EGO or coins.	Coin Import	Import	Infobox, Table, Detail

Format Helpers

The following templates use page template data for information display.

• Template:PropInfoboxAuto - Creates an infobox from an prop's page data.
• Template:NeededForTabber - Creates the tabber in the "Needed For" section.

You may see references to these on the item page in their respective sections. They look like this:

{{:{{PAGENAME}}|NeededForTabber}}

Page Sections

• Template:SourceList - Displays "How to Obtain" section.
• Template:PropPage/Build - Displays the build, repair, and placement sections.

Other Format Helpers

In addition to the Help:How To Edit/General helpers, some props may also benefit from the following format helpers:

Prop Page Examples

Building Shell Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Small Shop
| description = 
| category = Building
| sources = 0-Small Shops#ETLink,2-Expanded Fitouts#ETLink,4-Expanded Fitouts#ETLink,5-Expanded Fitouts 1#ETLink,Import App
| has_permits = Yes
| import_price = 1=70
| import_rotation_max = 1
| build_menu = Town Centre
| build_submenu = Building Shells
| build_cost = 45
| build_materials = Planks=2,Bricks=2
| build_size = 2x3
| build_terrain = Ground
| build_rotate = No
| fitouts = Eat N' Go,Craft Corner,Book Nook,Fish N' Chip Shop,Fortune Teller,Pizzeria,Hat Shop
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[Building Shells|building shell]] in [[Go-Go Town]].

{{:{{PAGENAME}}|SourceList}}

{{:{{PAGENAME}}|PropPage/Build}}

== Fitouts ==
{{PropTable|props={{:Small Shop|Prop/Data/fitouts}}|type=shell-fitouts}}

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

Disposal Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Garbage Disposal
| description = Automation of garbage collection and permanent removal of garbage
| category = Disposal
| sources = 0-Basic Service#ETLink,7-Automation Service#ETLink
| has_permits = Yes
| import_price = 1=60
| import_rotation_max = 1
| build_menu = Town Centre
| build_submenu = Waste and Cleaning
| build_cost = 60
| build_materials = Bricks=1,Planks=1
| build_size = 3x2
| build_terrain = Ground
| build_rotate = No
| disposes_of = Garbage
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[Props|prop]] in [[Go-Go Town]].

{{:{{PAGENAME}}|SourceList}}

{{:{{PAGENAME}}|PropPage/Build}}

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

Extractor Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Mana Extractor
| description = 
| category = Extractor
| sources = 3-Expanded Mining#ETLink,6-Expanded Industry#ETLink,Import App
| has_permits = Yes
| import_price = 1=40
| import_rotation_max = 1
| build_menu = Mining Zone
| build_cost = 40
| build_size = 1x1
| build_terrain = Ground
| build_zones = mine-zone
| build_rotate = No
| extracts_from = Mana Node
| extracts_item = Raw Mana
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[Props|prop]] in [[Go-Go Town]].

{{:Mana Extractor|SourceList}}

{{:Mana Extractor|PropPage/Build}}

== How To Use ==
Use the [[Build Menu]] to place a {{PAGENAME}} over a [[Mana Node]] in the {{Zone|Mine}} to collect {{Item|Raw Mana}}. 

Each {{Prop|Mana Node}} produces around {{Item|Raw Mana|qty=10}} before the {{PAGENAME}}  displays red lights. The red lights indicate that it has stopped producing and should be moved to a new node.

'''Hired workers will not move the {{PAGENAME}}. It needs to be moved by the player.'''

<gallery>
Mana Extractor Blue Lights.png|frame|A {{PAGENAME}} with solid blue lights indicates that it is extracting from the {{Prop|Mana Node}}, or that there is {{Item|Raw Mana}} available to collect.
Mana Extractor Red Lights.gif|frame|A {{PAGENAME}} with blinking red lights indicates the {{Prop|Mana Node}} is depleted and can be moved to the next node.|alt=An animation of a {{PAGENAME}} with red lights blinking on and off.
</gallery>

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

== Changelog ==
* '''[[Patch_Notes/0.4.48.15829EA|Build 0.4.48.15829EA]]:''' Updated in-game description to clarify it needs to be placed over a {{Prop|Mana Node}}.

Fitout Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Craft Corner
| description = A fitout for a {{Prop|Small Shop}}
| category = Retail
| sources = 0-Small Shops#ETLink
| fitout_inventory = Pet Rock,Wooden Trinket,Geode
| fitout_shell_size = Small
| needed_for_townies = 
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[Fitouts|fitout]] in [[Go-Go Town]].

{{:{{PAGENAME}}|SourceList}}

== Recipes == 
{{RecipeDataTable|{{:{{PAGENAME}}|Prop/Data/fitout_inventory}}|type=crafter}}

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

[[Category:Fitouts]]

Generator Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Fluff Shrub
| description = 
| category = Generator
| sources = forest,forest-zone
| generates_resources = Fluff,Herbs N' Spice
| generates_randomly = Yes
| regenerates_resources = Yes
}}</onlyinclude>
'''{{PAGENAME}}''' is a forageable [[Props|prop]] in [[Go-Go Town]]. Once harvested, the shrub disappears. More fluff shrubs will generate with time.

== Where to Find ==
{{Prop|{{PAGENAME}}|text={{PAGENAME}}s}} are found in the {{AnyList|list={{:{{PAGENAME}}|Prop/Data/sources}}}}.

== Resources ==
The {{Prop|{{PAGENAME}}}} drops {{AnyList|{{:{{PAGENAME}}|Prop/Data/generates_resources}}}} when foraged.

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

Processor Template

\
<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Foundry
| description = Refines mining resources into construction materials.
| category = Processor
| sources = 0-Starter Industry#ETLink,2-Expanded Mining#ETLink,Import App
| has_permits = Yes
| import_price = 1=50
| import_rotation_max = 1
| build_menu = Mining Zone
| build_cost = 40
| build_size = 1x1
| build_terrain = Ground
| build_zones = mine-zone
| build_rotate = No
| maker_recipes = Bricks,Metal Ingots
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[:Category:Processors|processor]] in [[Go-Go Town]].

{{:{{PAGENAME}}|SourceList}}

{{:{{PAGENAME}}|PropDataMaybeBuild}}

== Recipes ==
{{RecipeDataTable|{{:Foundry|Prop/Data/maker_recipes}}|type=crafter}}

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}

Vehicle Template

<onlyinclude>{{ {{{1|PropInfoboxAuto}}}
| name = Truck
| description = 
| category = Vehicle
| sources = town
| has_permits = No
| import_price = 
| import_rotation_max = 
| storage_size = 4x4x4
| is_vehicle = Yes
| vehicle_offroads = No
}}</onlyinclude>
'''{{PAGENAME}}''' is a [[Props|prop]] in [[Go-Go Town]].

== How to Obtain ==
* Explore the {{Place|town}} for {{Prop|{{PAGENAME}}|qty=2|text={{PAGENAME}}s}}.

== Needed For ==
{{:{{PAGENAME}}|NeededForTabber}}