UmweltDocs
v0.1UmweltDiscord

Umwelt documentation

Record what happened, who knows it and how they learned it. Then ask, from anyone’s point of view.

QuickstartRecord a scene and ask who knows it, from the command line, TypeScript or .NET.A few minutesConceptsFacts, Holdings, positions and perspectives: the vocabulary, in one read.Eleven short pagesGuidesCampaigns, novels, games and AI characters: how each maps onto Umwelt.Four guidesReferenceEvery operation, its payload and result, the errors and the guarantees.70 operations
RecipesComplete programs for things people build: a rumor, a fading memory, a save system, an AI character. Each in its own world, in TypeScript and .NET.10 recipes
  • Village life simA rumor that spreads
  • Survival horrorA memory that fades
  • Detective mysteryThe interrogation
  • Faction intrigueSpies and secrets
  • Novel with flashbacksThe reader and the character
  • RoguelikeSave and load the day
  • AI characterThe AI innkeeper
  • HeistThe masquerade
  • Tabletop campaignWhat each player knows
  • Court romanceFeelings that change

Most used operations

All 70
queryholdsDoes a holder hold a claim at a position? The answer comes with the Holding behind it.queryperspectiveEverything a holder holds, is aware of and feels at a position: their whole point of view in one read.commandcommitWrites one event with its records and transitions, atomically: all of it or nothing.commandtransmitOne holder tells another something they hold, honestly or deceptively.commandwitnessEveryone at a scene sees the same claims: one commit, one Holding per witness and claim.querytraceHow a record came to be: its event, its transitions, and every link of who told whom, back to the source.querycheck.utteranceChecks claims a holder says or thinks against what they hold, and tells canon apart.querycontext.admitDecides which records and events may enter a context for a perspective, within a budget, with a reason for every refusal.

Install

Installation guide
Command line
cargo install \
  --git https://github.com/Kallamo/Umwelt \
  umwelt-cli
TypeScript
npm install @kallamo/umwelt
.NET 6+
dotnet add package Kallamo.Umwelt
Any language
umwelt serve world.umw

Clients

Protocol
TypeScript@kallamo/umweltTyped methods for every operation. The engine ships inside the package..NETKallamo.UmweltThe engine in your process, through its native library.Command lineumweltOne call at a time, or a server over standard input.Any languageJSON protocol v1Speak the protocol, or load the C ABI.