Skip to main content

Scene Setup

This guide matches the 0.12.x ModuleService workflow. For the fastest route, pair it with Getting Started.

This page describes the minimum scene ingredients required for a working setup.

The 0.12.x runtime entry point​

For 0.12.x, the scene should use ModuleService as the runtime entry point.

Add it to an empty GameObject in your scene.

This service is responsible for:

  • loading ModuleSettings
  • creating core services such as time, action, looking, spawning, and repositories
  • collecting population regions from the scene
  • starting the population and behaviour processors

Minimum checklist​

Your scene should contain or reference all of the following.

1. Module Service​

  • one GameObject with ModuleService

2. Module settings​

Open CIVIL-AI-SYSTEM -> Module Settings and make sure the settings exist and are valid.

For a first working setup, check these areas:

  • nav mode
  • start time and day
  • work behaviour repository selection
  • need behaviour repository selection if the need system is enabled
  • character pool service
  • item name, type, and size collections

3. At least one valid building setup​

You normally need:

  • one house
  • one workplace with at least one valid work role

Buildings provide the simulation with places that agents can own, use, and travel to.

If you use Template and Actions to create a building template, the tool also creates a basic trigger collider and an entrance child object. If you configure buildings manually, make sure they still have valid colliders.

4. At least one population region​

Population regions define where agents are allowed to exist and what content they can use.

You can create a region through CIVIL-AI-SYSTEM -> Template and Actions.

The region area itself needs colliders so the world space is defined correctly.

5. Behaviour content​

Agents need behaviour trees before they can do meaningful work.

At minimum, create:

  • one work behaviour tree
  • one need behaviour tree if the need system is enabled

Then assign them in Module Settings.

6. Character pool data​

The region must have valid characters to spawn. Make sure your pool contains usable entries and that those entries satisfy any configured requirements.

7. Navigation​

Agents need valid navigation support that matches the nav mode configured in Module Settings.

If the world is otherwise correct but agents stand still or never complete move-based actions, inspect navigation first.

A reliable first-scene recipe​

If you want the easiest first success, use this exact shape:

  1. Add ModuleService to the scene.
  2. Open Module Settings and let the tool create defaults if needed.
  3. Assign all three item collections.
  4. Assign a character pool service.
  5. Create one simple work tree.
  6. Create one simple need tree.
  7. Create one house.
  8. Create one workplace with one role.
  9. Create one population region with valid colliders.
  10. Set up navigation and press Play.

Useful editor entry points​

  • CIVIL-AI-SYSTEM -> Help -> Getting Started
  • CIVIL-AI-SYSTEM -> Module Settings
  • CIVIL-AI-SYSTEM -> Behaviour Tree Editor
  • CIVIL-AI-SYSTEM -> Template and Actions

Resource locations​

The 0.12.x package loads most authored content from Assets/CIVIL-AI-SYSTEM/Resources.

That matters when you are looking for generated or module-owned assets such as:

  • module settings assets
  • behaviour tree assets
  • spawn and character pool assets
  • inventory collections and POI type repositories

If something is not working​

Start with Common Issues.

Last updated on