mechanicsdsl-unity 0.1.0

Unity and Unreal Engine plugin packages for MechanicsDSL — physically accurate simulation components compiled from DSL notation

mechanicsdsl-unity

Physically accurate simulation components for Unity and Unreal Engine, compiled from DSL notation.

---

Overview

mechanicsdsl-unity provides Unity MonoBehaviour components generated from MechanicsDSL DSL specifications. All components bypass PhysX with Lagrangian equations of motion, include Noether-based energy monitoring, and expose parameters in the Unity Inspector for real-time tuning.

---

Components

Classical Mechanics

Component	System	Conserved	Gizmos
PendulumComponent	Simple pendulum	Energy (Noether)	Pivot, rod, bob
DoublePendulumComponent	Double pendulum (chaotic)	Energy (Noether)	Full double pendulum
CoupledPendulumsComponent	Coupled pendulums	Energy (Noether)	Both pendulums + spring

Utilities

Component	Description
ConservationMonitor	On-screen HUD for energy drift across any MechanicsDSL component
PhaseSpaceTrail	Renders θ vs ω phase portrait as a LineRenderer trail
MechanicsDSLMath	Generic RK4, symplectic Euler, angle wrap, bob position helpers

Editor

Script	Description
PendulumComponentEditor	Live state readout (θ, ω, t, E, |ΔE/E₀|) + Reset button
DoublePendulumComponentEditor	Dual-angle live readout + Reset button

---

Repository Structure

mechanicsdsl-unity/
├── Runtime/
│   ├── Components/
│   │   ├── PendulumComponent.cs
│   │   ├── DoublePendulumComponent.cs
│   │   └── CoupledPendulumsComponent.cs
│   ├── Utilities/
│   │   ├── ConservationMonitor.cs
│   │   ├── PhaseSpaceTrail.cs
│   │   └── MechanicsDSLMath.cs
│   └── com.mechanicsdsl.unity.runtime.asmdef
├── Editor/
│   ├── PendulumComponentEditor.cs
│   ├── DoublePendulumComponentEditor.cs
│   └── com.mechanicsdsl.unity.editor.asmdef
├── Tests/Runtime/
│   ├── TestPendulumEOM.cs
│   ├── TestDoublePendulumEOM.cs
│   └── MechanicsDSL.Tests.Runtime.asmdef
├── Samples~/
│   ├── SimplePendulum/README.md
│   └── DoublePendulum/README.md
├── docs/
│   ├── getting_started.md
│   ├── components_reference.md
│   └── adding_systems.md
└── package.json                (UPM manifest)

---

Installation

Via UPM (Unity Package Manager):

1. Open Window → Package Manager
2. Click + → Add package from git URL
3. Enter: https://github.com/MechanicsDSL/mechanicsdsl-unity.git

---

Quick Start

1. Add MechanicsDSL → Classical → Pendulum to any GameObject
2. Create a Sphere child and drag to Bob Transform
3. Press Play — the sphere is driven by MechanicsDSL-generated Lagrangian equations

The Inspector shows live θ, ω, E, and |ΔE/E₀| during Play Mode. Click Reset to return to initial conditions without stopping.

---

Running Tests

Window → General → Test Runner → PlayMode → Run All

Tests cover energy conservation (5–10 s), reset/initial conditions, equilibrium stability, and bob Transform updates.

---

Generating New Components

pip install mechanicsdsl-core
mechanicsdsl generate my_system.msl --target unity --out Assets/Physics/

See docs/adding_systems.md for the full workflow.

---

Contributing

See CONTRIBUTING.md.

License

MIT License — see LICENSE.