Getting Started

Installing #

Import the package. Everything lands in one folder, Assets/AllInOnePrefabBuilderKit/. There is nothing else to set up: no packages to install, no registration, no project settings changed.

  • Unity 6000.0 LTS or newer (tested on 6000.0, 6000.3 and 6000.6).
  • Built-in Render Pipeline, URP or HDRP. The sample models take the project's pipeline's own materials when they import. In HDRP, the sample scenes have no sky of their own: add a Volume with a sky (HDRP's Wizard sets up a default one) or shaded sides look very dark.
  • Works with Enter Play Mode Options (domain reload off).

Where your data lives #

The Prefab Builder never writes into its own folder. Everything you make, kits, styles, rule sets, character profiles, palettes, and the placeable copies of pack pieces, goes into a data folder:

Assets/AllInOnePrefabBuilderData/ by default (the dataFolder project setting).

It is created the first time something is saved there. Updating the Prefab Builder replaces only its own folder, so your data is never overwritten.

Project-wide settings (layer and tag names, surface names, scene folders, pack detection) are stored in ProjectSettings/AllInOneWorldBuilderSettings.asset, so they are shared through version control but are not part of any exported package.

Thumbnails are cached in Library/AllInOneWorldBuilder/Thumbnails/ (this computer only; deleting Library simply makes them again).

The menu #

Everything is under Tools > All In One Prefab Builder:

Item What it does
Prefab Builder Opens the Prefab Builder window (see The Prefab Builder Window). Everything else is reachable from it.
Add Pack... Opens the Add Pack wizard (see Adding Packs).
Presets (Export, Import)... Saves or loads rule sets, palettes, kit annotations and settings (see Presets).

First use #

The first time the Prefab Builder needs a rule set, it makes the defaults in your data folder:

  • Default Rule Set: placement rules based on common city-building practice.
  • Standard Human: a Character Profile for a 1.8 m adult.
  • Warm Town and Clean Suburb: two palettes.

All of them are yours to change; see Rules, Profiles, Palettes and Styles.

Home #

The first time you open the Prefab Builder (with no kits yet) it shows Home; ⌂ (top right) comes back to it, and a tab or tool takes you to the tools:

  • Try the sample city: makes the sample kits if they aren't made yet (about half a minute) and opens Try It, a half-built city to try every tool on (you're asked first if the open scene has unsaved changes).
  • Turn my pack into a kit: Add Pack.
  • Take the tour: the tour below, from its first step.
  • Jobs: Lay roads, Build a street of buildings, Plant trees and grass, Dress a street, Fence a yard, Close a road for works, Pile up clutter or rubble, Check the scene: each opens the tool that does it, the palette on the pieces it needs (when your kits have them), and says how to do it. A job's tooltip says the same.
  • Help: Get help, report a bug.

The first-run tour #

The first time you open the Prefab Builder (with no kits yet), a small card at the top of the Place tab takes you through it, one step at a time with Back and Next: add a pack, pick a piece, place it, snapping and the grid, the other ways to place, Roads, Physics, Dress and Fix, Check, and where help is. The first three show a tick once you've done them, and the tour moves on by itself. Skip hides it; Take the tour on Home (or ⋮ > Show the tour again) starts it over.

The sample kits #

The Prefab Builder comes with sample models to try everything on before you add a pack of your own, all Kenney's and CC0 (free for any use): the City Kits (Commercial, Industrial, Roads, Suburban) in Samples/Kenney City Kit, and Modular Buildings in Samples/Kenney Modular Buildings. Click Try the sample kits (in the tour's first step, the empty palette, or the ⋮ menu) and they become two kits:

  • Kenney City (sample): roads, shops, houses, factories, trees, fences, street lights, cones and barriers, sorted into categories, at one scale (×10: 10 m road tiles) on a 10 m grid;
  • Kenney Modular Buildings (sample): blocks with windows, doors, balconies and awnings, corners and flat roofs, at ×5 (a block 5 m wide and a storey tall): they snap together block by block with Stamp, into buildings of any shape.

They're kits like any other: review them, change them, or remove them.

The demo scenes #

Samples/Showcase/Showcase City.unity is a little city of the sample kits: drawn roads, a downtown block, a block of houses, a block of buildings stacked from the modular blocks (hollow: try the cutaway on them), a fenced park, and street lights along every road. Samples/Showcase/Try It.unity is half built, to try the tools on: a road to carry on (Roads), an empty block to stamp, brush and fill in, trees to fence (Fence), containers to drop, settle and untangle (Physics). Each has a Camera spots object: select one of its children and use GameObject > Align View to Selected to look where it looks. Both draw in the Built-in render pipeline and URP (their ground takes the pipeline's own terrain material).

Samples/Demo/Demo City.unity is a small town built from the sample models: a grid of roads with zebra crossings, a fenced park with paths and trees, shops facing it, houses along the side streets, towers and industry in the corners, street lights along every road, a road closure and woodland all round, on a grass terrain. Open it, add the sample kits, and try the tools on it: Replace a shop, Erase some trees, Brush more, dress a street, close another road. It works in the Built-in render pipeline and URP.

Don't need it? The Samples folder can be left out when importing the package (or deleted): nothing else uses it.

Something unclear or wrong? Tell us · Get help