Skip to content

About

Inverse Kinematics package for Unity, featuring multiple solvers, joint limits and procedural animation samples.

Topics

Resources

Stars

87 stars

Watchers

4 watching

Forks

Repository files navigation

OpenIK

OpenIK is a free, open-source inverse kinematics package for Unity. It features FABRIK, CCD, and Jacobian solvers and supports constraints such as hinge, ball-and-socket, and slider limits.

OpenIK_Trailer_1080p60.mp4

What's included

  • Three solvers: FABRIK and CCD for end-effector position. Damped least-squares Jacobian for position and orientation.
  • Joint constraints: hinge rotation limits, ball-and-socket swing/twist limits, and slider travel limits.
  • Joint speed limits: cap how fast each joint moves by setting its angular or linear speed.
  • Execution control: let solvers run and move the chain every frame, or call them from your own scripts and decide when the result is applied.
  • Editor tools: intuitive component inspectors and constraint gizmos.
  • Importable examples: basic chains, a robotic painting arm, and a walking spider, with reusable assets.
  • Documentation and tests: setup guide, solver/API reference, and optional EditMode regression tests.

Requirements

  • Unity 6 (6000.0) or newer.
  • Unity Mathematics 1.3.3, installed automatically as a package dependency.

The core package does not require a render pipeline or the Input System package. The optional samples use URP and work with the legacy Input Manager, the Input System package, or both.

Install

In Unity, open Window > Package Manager, select + > Install package from git URL (called Add package from git URL in some versions), and paste:

https://github.com/WouterApts/openik-unity.git#v0.3.0

The version tag pins your project to a release. To upgrade later, change the tag in your project's Packages/manifest.json to the desired published version.

For local development, clone the repository outside your Unity project, then use Install package from disk and select its package.json.

Quick start

  1. Create a chain of at least two transforms, parented from root to end effector.
  2. Create a separate target transform.
  3. Add FABRIKSolver, CCDIKSolver, or JacobianIKSolver to a controller object.
  4. Assign the target and populate Chain Joints in root-to-end order.
  5. Optionally add HingeIKJoint, BallSocketIKJoint, or SliderIKJoint components to the transforms that act as joints in your chain.
  6. Press Play and move the target.

By default the solver runs every frame and moves the chain. To control when it runs or applies its result, change Update Mode and Apply Mode in the solver's Execution section.

See Getting started and the Core reference for constraints, speed limits, and execution settings.

Samples

In a Unity 6 URP project, select OpenIK in Package Manager and open Samples. Import Shared Assets first, then Sample Chains, Robotic Painter, or Spider Walker. Open the scenes under Assets/Samples/OpenIK/0.3.0/.

Press Play and click the Game view. The on-screen guide will list the controls. See the sample guide for scenes, controls, and setup.

Tests

Install Unity Test Framework and add "com.wouterapts.openik" to the testables array of your project's Packages/manifest.json. Run the OpenIK EditMode tests from Window > General > Test Runner. These tests are optional and are excluded from player builds.

License

MIT

About

Inverse Kinematics package for Unity, featuring multiple solvers, joint limits and procedural animation samples.

Topics

Resources

Stars

87 stars

Watchers

4 watching

Forks

Releases

Packages

Contributors

Languages