Guide Setup

Installation

The goal of installation is simple: get the package into Unity, make sure the editor compiles cleanly, and confirm you can create and execute a graph before you start building real content. If you want the runtime side of that flow, jump to Runtime Generation?.

Requirements

  • Unity 2022.3+
  • OctoShaper latest version, grab it here

Setup Walkthrough

Get started

  1. Add OctoShaper to the project using the package on itch.io
  2. Let Unity finish importing and confirm the Console is clear of OctoShaper compile errors.
  3. Get started using Tools > OctoShaper > Getting Started.

Runtime smoke test

If you want a quick code-level check after import, this minimal MonoBehaviour exercises the public runtime bootstrap API and confirms the graph can execute. The returned data is an ElementSet?, and the graph boundary is explained in Node Graph Basics?.

using CuriousTrove.OctoShaper;
using CuriousTrove.OctoShaper.Core.Data;
using UnityEngine;

public sealed class OctoShaperSmokeTest : MonoBehaviour
{
    [SerializeField] private ProceduralGraph graph;

    private void Start()
    {
        var context = OctoShaperRuntime.CreateExecutionContext(graph);
        var executor = OctoShaperRuntime.CreateExecutor(graph);
        var configuration = new ProceduralConfiguration();

        executor.Execute(context, ElementSet.CreateImplicitSingle(), configuration);

        Debug.Log("OctoShaper graph executed successfully.", this);
    }
}