WIRESYNDICATEDocumentation

Godot Quickstart Integration

These guides provide a fast, step-by-step path to integrating WireSyndicate placements into your Godot project.

WS Placement Dynamic (2D Texture Injector)

No Account Required: You can test this immediately using our public demo placement.

This is the simplest way to inject a 2D ad texture into a single material on a single MeshInstance3D.

  1. Install Plugin: Install the Godot SDK plugin into your addons/ directory and enable it in Project Settings.
  2. Initialize: The WireSyndicateCore Autoload is injected automatically.
  3. Configure Network Key: In your _ready() function or main startup script, set your key and authenticate: 
    WireSyndicate.network_key = "demo" # Or your actual Org ID
WireSyndicate.authenticate(WireSyndicate.network_key)
  4. Add Placement Node: Add a WSPlacementNode to your scene.
  5. Configure Placement: In the inspector for the node:
    • Set the Placement ID to 22222222-2222-2222-2222-222222222222 (or your actual Placement ID).
    • Assign the Target Path to a valid MeshInstance3D in your scene.
  6. Run: Press Play. The node will authenticate and stream the texture directly onto your geometry.

Global Texture Injection: WS Shared Material Node

Account Required: This requires a valid Developer Account and telemetry configuration.

The Shared Material Node approach allows you to inject an ad texture into a globally shared Godot StandardMaterial3D or ShaderMaterial, updating all instances simultaneously.

  1. Initialize: Ensure your WireSyndicate.network_key is set to your actual Org ID and you have called WireSyndicate.authenticate().
  2. Add Shared Node: Add a WSSharedMaterialNode to your scene tree.
  3. Configure Placement: Set your Placement ID in the inspector.
  4. Assign Target Material: Assign your project's target Material resource in the inspector slot.
  5. Upload Spatial Data (Important):
    • Run the Godot WS Transform Exporter tool to generate your transforms.json file containing all the positions of objects using this material.
    • Upload this JSON file to the Placement in your Developer Dashboard.
  6. Run: Press Play. The SDK will inject the texture into the global material, updating all instances simultaneously while tracking telemetry for the uploaded transforms.

WS Placement 3D (AssetBundles/PCK)

Account Required: This requires a valid Developer Account and an active 3D campaign payload.

Use this to dynamically load and spawn full 3D models (Godot scenes from PCKs) into your scene.

  1. Initialize: Ensure your WireSyndicate.network_key is set to your valid Org ID.
  2. Add 3D Node: Add a WSPlacement3D node to your scene that will act as the spawn point anchor.
  3. Configure Placement: Set your Placement ID in the inspector.
  4. Run: Press Play. The SDK will download the payload and spawn the 3D scene as a child of your anchor node.