Custom collection integration

(This page assumes that you are familiar with the structure of GameBox files).

To integrate a custom collection with TMUnlimiter, you need to add 0x3f'007'000 header chunk to your .Collection.Gbx file.

This integration is compatible with TMUnlimiter version 2.0.6 and above. Earlier versions of the TMUnlimiter do not support custom collections.

Header chunk (0x3f'007'000):
|
|- Real: SquareSize                      # Size of the block square in XZ axis.
|- Real: SquareHeight                    # Size of the block square in Y axis.
|- Nat8: Flags                           # first bit:  Collection use pylons (like on Desert or Snow).
|                                        # second bit: Collection is compatible with nations clients.
|
|- DecorationInfo[]: DecorationsInfo
|  |
|  |- Nat32 SizeX                        # Decoration build area size in X axis.
|  |- Nat32 SizeY                        # Decoration build area size in Y axis.
|  |- Nat32 SizeZ                        # Decoration build area size in Z axis.
|  |- Nat32 GroundBaseHeight             # Base Y coordinate at which default ground blocks are created.
|  |- DecorationIdent[] DecorationIdents # A pair of identifier and author that uniquely identifies a decoration.
|     |
|     |- MwId Id                         # Decoration identifier (example: "Day")
|     |- MwId Author                     # Decoration author (example: "Nadeo")
|
if DecorationsInfo.length > 1
|  |
|  |- Nat32 DefaultDecorationInfoIndex   # Default decoration info index that will be always used while creating a new challenge.
|
|- MwId[] BaseZoneIds                    # Default zone identifiers (On Stadium: "StadiumGrass")
|- MwId[] ReplacementZoneIds             # Replacement zone identifiers (On Stadium: "StadiumDirt")
|- Nat32[] ObjectsToRemove_SkyOnly       # Object scene indices that should be removed from the scene when decoration visibility is set to "Sky"
|- Nat32[] ObjectsToRemove_WarpOnly      # Object scene indices that should be removed from the scene when decoration visibility is set to "Background"