Skip to content

JSON Blueprint

Tony Bark edited this page May 3, 2024 · 2 revisions

The JSON Blueprint, or JBlueprint, serves as My Simulation's variant of The Sims Online's XML-based blueprint file, originally employed for creating instances of jobs from these static files. The JBlueprint format is inspired by FreeSO's modified version of the same XML format utilized during the alpha phase. Intended initially for testing features during development by providing players with their sandbox, these files would be written and streamed back to other clients from the host. Technically, JBlueprint is considered version 3.0, with FreeSO's XML-based format being version 2.0 and The Sims Online's version 1.0.

While the JSON variant functions similarly and possesses comparable properties, it also represents a new format in its own right, unencumbered by the legacy baggage of its predecessor. This allows My Simulation to extend it beyond The Sims Online's original capabilities, particularly useful for P2P mode where environmental scripting can potentially be introduced.

JBlueprint Structure

House

Property Required Description
version Yes The version of the JBlueprint format.
size Yes The size of the house.
category Yes The category of the house.
world Yes The properties defining the world within the house.
items Yes The list of items within the house.

World

Property Required Description
floors Yes Contains an array of floor configurations.
walls No Contains an array of wall configurations.

Floors

Property Required Description
level Yes The level of the floor.
x Yes The x-coordinate of the floor placement.
y Yes The y-coordinate of the floor placement.
value Yes The value associated with the floor.

Walls

Property Required Description
level Yes The level of the wall.
x Yes The x-coordinate of the wall placement.
y Yes The y-coordinate of the wall placement.
segment Yes The segment of the wall.
placement Yes Additional placement information for the wall.
tls Yes
trs Yes
tlp Yes
trp Yes
blp Yes
brp Yes

Items

Property Required Description
guid Yes The GUID of the item.
level Yes The level of the item.
x Yes The x-coordinate of the item placement.
y Yes The y-coordinate of the item placement.
dir Yes The direction of the item.
group Yes The group to which the item belongs.