The Inochi2D logo was designed by James Daniel

Inochi2D

日本語 | 简体中文

Inochi2D is a library for realtime 2D puppet animation and the reference implementation of the Inochi2D Puppet standard. Inochi2D works by deforming 2D meshes created from layered art at runtime based on parameters, this deformation tricks the viewer in to seeing 3D depth and movement in the 2D art.

https://user-images.githubusercontent.com/7032834/166389697-02eeeedb-6a44-4570-9254-f6aa4f095300.mp4

Video from Beta 0.7.2, LunaFoxgirlVT, model art by kpon

For Riggers and VTubers

If you're a model rigger you may want to check out Inochi Creator, the official Inochi2D rigging app in development. If you're a VTuber you may want to check out Inochi Session. This repository is purely for the standard and is not useful if you're an end user.

System Requirements

| Hardware | Requirement | | -------: | :-------------------------------------------- | | CPU | x86-64 CPU with SSE4+, Aarch64 with NEON. | | Memory | At least 1 GB of RAM for bigger models. | | GPU | Depends on renderer backend. |

Inochi2D has no dependencies on non-D libraries besides a POSIX compliant C standard library.
Do note that until the transition to nogc is complete, you'll have the best experience with glibc on UNIX-like platforms.

SSE and NEON optimisations are only enabled in release and release-debug builds.

Official SDK Bindings

• Unity

Using the Inochi2D SDK

Inochi2D can both be used in and outside of DLang, to use Inochi2D in your D project just add it from dub.
To use Inochi2D within a project written in another language, a C FFI is provided.

To compile using the C FFI you must have the LDC2 compiler installed and the dub build system, run the following command to build the SDK:

dub build --config=dynamic

If your target graphics library does not allow 2D vectors to be used when passing position data to the GPU, you can add --d-version=IN_VEC3_POSITION as an argument, which will change the VtxData to use a 3D vector to store the vertex position.

You can alternatively download precompiled versions of the SDK from the Releases.

Build Configurations

Add with --config=

| Type | Use | | --------: | :-------------------------- | | static | Static D-only library. | | dynamic | Dynamic library with C FFI. |

Build Types

Add with --build=

You can pass the following build types to Inochi2D. | Type | Use | | --------------: | :--------------------------------------------- | | debug | Debug mode, no optimisation, full stacktraces. | | release-debug | Optimized build with some stack traces. | | release | Full release build. |

Build Options

Add with --d-version=

| Option | Use | | -----------------: | :----------------------------------------------------------------- | | IN_VEC3_POSITION | Use 3D vectors to store the POSITION portion of the vertex data. | | IN_NO_LEGACY | Disables legacy features. |

Inochi2D Technical Documentation

Technical documentation for Inochi2D is provided in the tech-docs/ directory, these are shipped with the SDK.