2.Getting Started #

Unity version

Please do not attempt to import this asset into a Unity 2021 project. It will auto-install the Collections v2.5.1 package, which isn’t compatible with this version. You’d have to manually downgrade it again to fix your project.

Under no circumstances must your project contain a script, without namespace, called “Spline” or “Editor”. This wreaks havoc to no fault of this asset.

Importing

At all times you must ensure your project is free of any console errors. Unresolved code errors will prevent this asset’s scripts from compiling. This results in all of its functionality remaining unavailable.

This asset imports as a package so won’t be placed in the “Assets” folder.

Project Setup

To view the demo scene, a project using the Universal Render Pipeline is required (Default in Unity 6+)

What about the Built-in RP and HDRP? Materials for the demo scene need to be configured for a specific render pipeline, so inherently excludes others. However, this asset works all the same regardless of any rendering configuration

These package depencies will be automatically installed:

Spline 2.8.1
Mathematics 1.3.2
Collections 2.5.7
Burst 1.8.25

Scene Setup

This tool use Unity’s native spline system. Familiarity with it is assumed here. Fortunately, it is rather straightforward to work with.

You can find a quick-start guide here: Quick start

You’ll need to know how to:

Create a Spline object
Use its editor tool
Insert new knots

Converting a Mesh to a Spline Mesh

Any input mesh you use is expected to already be correctly set up for use in Unity. See the Mesh Preparation section.

On any Mesh Filter component, you can access a quick set up option under the context menu:

What it does:

(Optional) Adds a new Spline Container
Adds a Spline Mesher component and assigns the spline and input mesh.

You can also add the Spline Mesher component manually to any other object. You will have to assign a Mesh Filter and Spline Container reference for it to work with.

Converting a Spline to a Spline Mesh

On a Spline Container component, you can access the “Add Spline Mesher” option.

Mesh editing

With the new spline mesh created, you’ll already notice that the geometry reacts to the Spline’s shape as you adjust it. This is the crux of the workflow, but the Spline Mesher component holds various others settings outlined on the Spline Mesher Component page.

Notes:

The Spline Mesher and Spline Container components do not necessarily need to be on the same object. Neither does the Root transform!
Scaling the Spline Container object is supported, but this only yields correct results if the Root transform is entirely separate