Exporting to WolvenKit

This guide explains how to go from an Object Spawner build to a native world edit

Usage

• When building something using Object Spawner, it will use an intermediary format optimized for editing

• In order to go from that editing focused format to the final native world edit, Object Spawner provides a workflow to make this as easy as possible

If you just want to quickly convert your project to a native edit, jump to the Export section. It is highly recommended to read the previous sections on the theory and things to consider tho.

Requirements

Tools

• Object Spawner

• ArchiveXL

• Codeware (1.15.0 or newer)

• WolvenKit (With latest version of Object Spawner import script)

Knowledge

• You need to have a basic understanding of:

  • Working with WolvenKit

  • Common sense

Sectors and Groups

• While building in Object Spawner, you are able to save things on a root-group level

  • This means you can save any group that is not contained within another group

• The game operates on sectors, which objects are assigned to what sector is an automatic process there

  • For the Object Spawner workflow, each group you saved can get turned into a sector

• A finished mod can consist of multiple root-groups / sectors

Streaming Ranges

• There are different streaming ranges, determining when objects and sectors get streamed in / out

• Object Based Range:

  • These determine when each individual object gets streamed in / out

  • It is usually dependent on the size of the object

  • Can be found under each object's "World Node" header

  

  Streaming Ranges of an object
• Sector Range:

  • This determines when then entire sector gets streamed in / out

  • This over-rules the object based ranges, meaning when the sector streams out all objects within also stream out, even if their individual range is larger

  • Can be found in the export tab, under each groups header

  

  Streaming extents of a group / soon to be sector

Why this matters:

You should keep this in mind while building, and make sure that if you have sub-builds which are far apart, that those are in their own root-groups (Thus becoming their own sectors)

That way you make sure that only the parts of your build that are currently close will be streamed in (Thanks to having separated it into multiple sectors, with their own ranges)

Exporting

Step 1: Export from Object Spawner

1. Start by going to the "Saved" tab, and adding all the groups you want to be part of your finished mod, by using the "Add to export" button of those groups

2. Next, head over to the "Export" tab

3. Enter a project name, this will be used for the folder and file names in WolvenKit

4. Now you can specify sector specific settings:

   1. Sector Category, usually just use interior or exterior

   2. Sector Extents, used for determining when to stream the whole sector in / out

   3. Sector Variants

5. Hit "Export"

Example of the Export tab, with two groups

Step 2: Importing into WolvenKit

1. Open your WolvenKit project (Make a new one if you do not have one yet)

2. In the top menu bar, navigate to

   1. File -> Import -> Object Spawner .json

   

   Click the "Import object spawner .json" button, then choose the file
3. In the file dialog, choose the previously exported file, named projectName_exported.json

4. Multiple files should have been generated (At least one .streamingsector, and one .streamingblock)

5. Click the "Install" button, in the top menu bar