Find your next open-source project

Search by name, purpose, or keyword — or paste a GitHub repository URL

siliconjungle/shapeshift-labs-ink-studio

Media & Design

A JavaScript toolkit for sculpting SDF solids into pixel-art Gaussian splats, then animating, simulating and rendering them headlessly.

103
11
JavaScript
new today

What it is

Ink Studio is a Node-based JavaScript toolkit for authoring pixel-art scenes built from Gaussian splats. Solids are described as signed-distance fields, sculpted with primitives, joins, warps and materials, then baked into splat data with a palette-oriented look. On top of that it supplies animation, deformation, particles, physics, procedural environment tools and a headless software renderer. The outputs are PNG/APNG images and runtime world data, not an interactive editor: a host application must provide the viewport and UI.

It is aimed at technical artists and developers who are comfortable writing JavaScript or JSON scene definitions and who want programmatic, reproducible pixel-art rendering and animation. The built-in demos and lab scenes serve as references.

Quick start

Requires Node 18 or later. From a checkout of the repository, inspect the available commands and scenes:

node cli/ink-studio.js help
node cli/ink-studio.js scenes
node cli/ink-studio.js render watcher --t 2.6 --colored

The last command writes a rendered frame, normally under studio/out/. To check the numerical and pixel tests, run npm test.

The package is private, so installing it in another project from GitHub requires credentials that can read the repository:

npm install github:siliconjungle/shapeshift-labs-ink-studio
npx ink-studio help
npx ink-studio render watcher --colored

A first authored scene can be a JavaScript module exporting { id, name, seed, build(seed) }. The build function creates a builder and sculptor, adds solids, calls S.bake() and returns B.finish(...) with camera settings. A complete example is available in examples/sculpt.js; render it with:

npx ink-studio render model.js --colored

JSON scenes follow the same idea with a style mapping material roles to palettes, and can be validated and rendered through the CLI. See the first-scene walkthrough and JSON scene section for the full field lists.

Authoring model and lifecycle

A world is built in a fixed order: create the builder with a seed and palette, install rigs or deformation tags before baking, add solids and bake, allocate splat pools before B.finish() fixes the data span, then finish with camera metadata and attach a stage or puppet. Static scenery should be baked before moving objects are added so it does not capture their holes or shadows. The baked world stores a Float32Array with 16 floats per splat, and toolkit systems should be used to modify it so covariance, color and changed-row tracking stay consistent. Stateful animations must be stepped forward; returning to an earlier time means rebuilding the world.

Main capabilities

The toolkit covers several layers, all usable from the CLI or from JavaScript:

  • Geometry and materials: balls, boxes, lathes, tubes, rocks, vegetation, joins such as cut and union, warps and folds, palette-ramp materials, glass, fur and wax looks.
  • Animation: rigs, hierarchical puppets, pose clips, easing, layers, state machines, facial controls, action clips and input-driven characters.
  • Particles and interaction: pools, emitters, flow fields and scripted taps via --poke.
  • Simulation: breaking and rubble, jelly and sand, a material-point solver, cloth, hair, ropes, voxel-based fire/frost/growth and interior splats.
  • Procedural content: scattering and growth, crystals and cave forms, fracturing, erosion, fitted architecture, weather and flocks.
  • Import: OBJ, glTF and GLB meshes converted into distance-field solids with palette ramps; texture images are not imported.

The module layout is listed in the module reference, and feature lookup is supported by ink-studio catalog <words>.

Rendering and embedding

The CLI provides headless rendering, frame sheets, turns, APNG clips, ghost overlays, statistics, performance measurements, motion inspection and baseline comparison. Rendering options include --colored, --raw, --fine, --bounce, --focus, --follow and --clean; camera angles are radians. The renderer resolves a lower-resolution pixel grid from the scene's detail settings and uses palette quantization and dithering by default. See the command reference.

For browser embedding, studio.bundle() returns the toolkit sources as one script string that defines the authoring names in script scope, but no DOM interface or WebGL viewport. A host must supply rendering, input handling and the animation update loop. Scenes for the CLI can be collected through an ink-studio.config.js load callback.

Constraints and known limits

  • Node 18+ is required. The package is private and versioned 0.1.0, with license metadata UNLICENSED; it is not declared as published to a package registry.
  • load() compiles and caches a bundle in dist/standalone.js, so the package directory must be writable on first use and after source changes.
  • There is no bundled interactive viewport or editor; the software renderer is for the CLI, and browser hosting is the integrator's responsibility.
  • The JSON schema supports a defined subset of solids, styles and motion commands; use validate to get all diagnosed problems rather than the first one.
  • Clip rotations use degrees, while matrix rotations and many geometry options use radians.
  • Visual baselines are not bundled; create them with snap and compare with check.

HotRepo's take

The repository appeared on HotRepo's new-project list on 2026-11-16 with 103 stars and 11 forks gained in a seven-hour observation window, and it has no recorded all-language daily rank. Those figures describe a short early window only; they say nothing about sustained adoption. What stands out technically is the breadth behind a single command: signed-distance sculpting, splat baking, headless rendering and simulation systems are all documented together, with runnable examples and a 171-check numerical self-test suite. The practical caveat is distribution: the package is private and unlicensed, so the repository as provided works best as a checkout or a credentialed Git install rather than a public dependency.

Written by AI from the project's README, updated . The project's own docs are the source of truth.