How thammin/unity-spring works
Project Type and Purpose
• This is an open-source Unity package: “A minimal spring physics library for Unity.”
• It implements multiple solvers for a damped harmonic oscillator (Closed-form, Semi-implicit Euler, RK4, Verlet).
• It ships as two assemblies: a Runtime DLL for the solvers and an Editor DLL for the visualizer, plus an automated test suite.
File Structure Analysis
• Top-level: LICENSE.md, README.md, package.json (Unity package manifest).
• Runtime/
• Thammin.UnitySpring.asmdef – Unity assembly definition for runtime code
• SpringBase.cs – base class defining the solver interface
• ClosedForm.cs, SemiImplicitEuler.cs, ExplicitRK4.cs, VerletIntegration.cs – concrete solver implementations
• Editor/
• Thammin.UnitySpring.Editor.asmdef – Editor-only assembly
• Visualizer.cs – MonoBehaviour that uses the solvers to render an animated spring in the Editor
• Tests/Editor/
• Thammin.UnitySpring.Tests.asmdef – Editor test assembly
• PerformanceTest.cs – measures solver performance
• Documentation~/ – supporting images and performance graphs
Key Insights from README
• Core functionality: simple C# classes with Evaluate(dt) to step the spring.
• Usage: user code (MonoBehaviour) instantiates one of the solver classes at runtime.
• Distribution: installed via Unity’s Package Manager or OpenUPM.
Detail and Clarity
• Every assembly and its purpose.
• Strategy pattern relationship: SpringBase → concrete solvers.
• Assembly dependencies (Runtime ← Editor, Tests ← Runtime).