UmweltDocs
Get started/Installation

Installation

One engine, written in Rust, reached four ways. Every client speaks the same JSON protocol and passes the same conformance cases.

Command line

Download the umwelt command from the latest release, or build it with Rust:

Terminal
cargo install \
  --git https://github.com/Kallamo/Umwelt \
  umwelt-cli

umwelt call answers one request and exits; umwelt serve keeps the file open and reads one JSON request per line.

TypeScript

Terminal
npm install @kallamo/umwelt

Requires Node.js 22 or newer. The package includes the engine for Windows, Linux and macOS, and gives every operation a typed method. See the TypeScript client.

.NET

Terminal
dotnet add package Kallamo.Umwelt

For .NET 6 or newer. The engine runs in your process, through its native library. See the .NET binding.

Any language

Terminal
umwelt serve world.umw

Speak the JSON protocol over standard input and output, or load the C ABI in your process.

Was this page helpful?