Open Source RoboticsRobots, software & learning

SPEAR

Software

Unreal-based simulation framework with Python services and a separate engine/content build workflow. [1] [2] [7] [4] [5] [6]

Installation & first result →Official websiteGetting started

For
Robotics developers evaluating the selected source workflow [1] [2] [7] [4] [5] [6]
Source rights
Named licenses are documented by part. Review licenses

Source researched · Not tested by us
Sources checked · Research details

Licenses & related hardware

Requirements · Research details and dates

On this page

Overview

SPEAR provides an Unreal-based simulation framework with Python access to engine services. Its useful contribution is the source interface and simulation workflow, not a complete robotics asset license or measured simulator performance. Installing the Python package alone does not build or launch the Unreal application. [1] [7]

The inspected getting-started guide selects Unreal Engine 5.5 for main and identifies a separate ue-58 branch for 5.8. It describes platform-specific compiler requirements, Git/CMake, an Anaconda Python 3.11 environment and a recursive clone. The guide names Visual Studio 2022 (17.14) for Windows and XCode 16 or 26 for macOS; XCode 26 needs an upstream workaround and is not officially supported by UE5.5. Linux bundles the SpearSim compiler but still needs an appropriate compiler for third-party dependencies. The Python package metadata requires Python~=3.11 with pinned dependencies. Keep the branch, compiler, engine and package together rather than combining versions from different routes. None was installed or compiled here. [4] [6]

A concrete initial source path is examples/getting_started/run.py. It requires copying user_config.yaml.example to user_config.yaml and setting actual system paths. The configuration determines whether spear.Instance launches a new Unreal application or connects to an existing one; a configuration object alone is not an IPC connection. Inspect that mode before running an example against an already open application. [5] [7]

The example loads a named content blueprint, spawns an actor, changes properties and pairs begin_frame/end_frame blocks around engine calls. It also uses an asynchronous call whose result is retrieved later. These are explicit application/content dependencies and sequencing rules, not a rendered output or determinism result observed by this review. The selected instance implementation contains service setup to inspect with that configuration. [5] [7]

The README declares repository code MIT and repository assets CC0. That distinction does not establish rights for Unreal Engine, separately downloaded content or every third-party tool; inspect those terms separately. Begin with the matched engine/environment and one configured example before exploring larger content pipelines. No native extension build, engine launch, IPC response, scene download, rendering, robotics task or timing benchmark was performed. [1] [2] [4]

Is this for you?

Known limitations
  • Main UE5.5 differs from separate ue-58 branch; package installation alone is not an engine launch.
  • MIT project notice does not clear Unreal Engine or all separately downloaded scene/content assets.
  • No engine build, IPC connection, scene download, rendered output or robotics performance test.

Editorial assessment of bounded source evidence; no runtime, fit, manufacturing or compatibility proof.

[1] [2] [7] [4] [5] [6] · Editorial assessment

What you need

Operating system
  • Windows, macOS, Linux environments compatible with UE5.5 per guide; platform compiler requirements differ.

Source-reported requirement/configuration, not a tested installation, compatibility matrix or measured runtime result.

[4]

Languages / runtimes
  • Python~=3.11 package with separate Unreal/C++ build dependencies.

Source-reported requirement/configuration, not a tested installation, compatibility matrix or measured runtime result.

[4] [6]

Dependencies
  • Unreal Engine 5.5 and platform-specific compiler/CMake/Anaconda setup
  • Python~=3.11 with pinned package dependencies; Unreal project, external content and native extension builds separate

[1] [2] [7] [4] [5] [6]

Compute for the workload
  • Requires compatible Unreal 5.5 engine/compiler environment and selected scene content; no independent numerical CPU/GPU/RAM minimum established by this review.

Source-reported requirement/configuration, not a tested installation, compatibility matrix or measured runtime result.

[4]

Installation & first result

Open the upstream getting-started guide [1] [2] [7] [4] [5] [6]

  • Inspect the pinned implementation and select the exact configuration described in the article.
  • Follow the chosen upstream environment/build route, resolving the listed dependencies before runtime or hardware integration.

Editorial assessment of bounded source evidence; no runtime, fit, manufacturing or compatibility proof.

[1] [2] [7] [4] [5] [6] · Editorial assessment

Installation

Match Unreal 5.5, recursive submodules, Python 3.11 and platform compiler guidance before building engine/native components; configure examples/getting_started/user_config.yaml for the selected launch/connect mode. No install/build performed.

Source-reported requirement/configuration, not a tested installation, compatibility matrix or measured runtime result.

[4] [5] [6]

What we checked

Pinned source and selected artifact structure review only; no dependency installation, upstream build, native CAD/kernel/fit/strength validation, fabrication, wiring, calibration, simulation, powered operation or performance testing. Original archives stay private.

Not yet established

  • Requirements: host computer
  • Version-specific hardware compatibility (ecosystem tags alone do not establish it)

Updates

Upstream last updated
Not established
Latest release
Not established
Profile updated
Nov 1, 2026
Sources last checked
Nov 1, 2026
Next review
Dec 1, 2026
Reviewed revision
2e6aa15

Source files and licenses

Distinct inspectable robotics software/data workflow with specific contribution and bounded next source-investigation step; not performance or physical-build certification.

LayerAvailability / license
softwareavailable · MIT
Selected project implementation; external dependencies, hardware, weights/data and asset rights remain separate. [7] [2]
documentationavailable · MIT
Scoped project declaration; no blanket grant over all linked material. [1] [2]

Outside the selected contribution; no separate released layer claimed.

References

Each source links to the exact revision we read. “Used for” shows where this page relies on it.

Correction guidance · Discussion is not enabled · Profile format 0.7.0-draft.5

Change history