Skip to content

Installation and basic setup

HungryProton edited this page Jan 2, 2021 · 1 revision

Installation

  • Clone this repository in your addons folder
  • If you downloaded the GitHub archive, make sure to rename the folder, it must be called scatter, not scatter-master.
  • Navigate to Project -> Project Settings -> Plugin and enable the Scatter plugin

Getting started

Check the two scenes under addons/scatter/demos to get an idea of how this add-on can be used.

Scatter nodes

  • Add a Scatter node to you scene tree

  • Add a ScatterItem node as a child

    • ScatterItem has a Item Path parameter. It expects a path to the scene containing the mesh you want to scatter.
    • You can add multiple ScatterItem under a single Scatter node to use different meshes in the same area
  • Use these buttons on top of the viewport to draw a path on your scene. By default, objects will be placed inside the path. path_controls

  • The Snap to colliders button to force the points to stay on the surface of anything with a collision shape

    • This won't work if there's is nothing to collide with
  • Lock to plane forces the path points on the xz plane instead of moving them in screen space.