# starmap

> Two JavaScript/TypeScript libraries for star universes in games. The first
> describes, validates and queries a galaxy; the second turns it into an SVG
> string. No dependencies, no DOM, no framework — the same code runs in a
> browser, in Node or Bun, in a worker, on a server, or inside a game engine.

The two packages are deliberately separate: one holds the data, the other
decides how it looks. The core does not draw and does not generate universes —
procedural generation is game design, rendering is UI design, and both stay
yours. What they share is the data model.

Every page below is Markdown-friendly prose with runnable examples. For the
whole documentation as a single file, fetch `/llms-full.txt`.

## @industrieh/starmap v0.1.0-beta.0 — Describe, validate and query a star universe.

- [Installation](https://starmap.industrieh.dev/docs/starmap/installation): Add the package to a project, and what it expects of your toolchain.
- [Quickstart](https://starmap.industrieh.dev/docs/starmap/quickstart): A universe in twenty lines, from an object to a query.
- [Data model](https://starmap.industrieh.dev/docs/starmap/data-model): What a galaxy, a system and a body are made of, and what is required.
- [Querying a galaxy](https://starmap.industrieh.dev/docs/starmap/querying): Indexes, neighbours, routes — finding your way around the structure.
- [Animating orbits](https://starmap.industrieh.dev/docs/starmap/animating): Turning a time value into positions, once per frame.
- [Deterministic randomness](https://starmap.industrieh.dev/docs/starmap/randomness): Generating a universe from a seed, and getting it back tomorrow.
- [Recipes](https://starmap.industrieh.dev/docs/starmap/recipes): Short answers to the questions that come up twice.
- [Design decisions](https://starmap.industrieh.dev/docs/starmap/design): The three lines this library does not cross, and why.
- [Architecture](https://starmap.industrieh.dev/docs/starmap/architecture): How the modules fit together, and where to add code.
- [API](https://starmap.industrieh.dev/docs/starmap/api): Every exported function and type, with its signature.

## @industrieh/starmap-render v0.1.0-beta.0 — Turn a universe into SVG. Strings, not components.

- [Installation](https://starmap.industrieh.dev/docs/starmap-render/installation): Add the renderer next to the core, and what it needs from it.
- [Quickstart](https://starmap.industrieh.dev/docs/starmap-render/quickstart): From a galaxy to an SVG string, and where to put it.
- [Drawing](https://starmap.industrieh.dev/docs/starmap-render/drawing): The layers, and how each object is built out of them.
- [Theming](https://starmap.industrieh.dev/docs/starmap-render/theming): Every colour the renderer reads, and how to replace one.
- [Framing & embedding](https://starmap.industrieh.dev/docs/starmap-render/framing): The viewBox, the margins, and the four ways to put a string on a page.
- [Making it interactive](https://starmap.industrieh.dev/docs/starmap-render/interactivity): Click, hover, pan and zoom — none of it here, all of it possible.
- [Recipes](https://starmap.industrieh.dev/docs/starmap-render/recipes): Animating, exporting a file, drawing your own overlay.
- [Design decisions](https://starmap.industrieh.dev/docs/starmap-render/design): Why it returns strings, and why interaction is not its job.
- [Architecture](https://starmap.industrieh.dev/docs/starmap-render/architecture): How the renderer is split, and where a change belongs.
- [Contributing](https://starmap.industrieh.dev/docs/starmap-render/contributing): The house rule, the checklists, and how to review a visual change.
- [API](https://starmap.industrieh.dev/docs/starmap-render/api): Every exported function and type, with its signature.

## Optional

- [Full documentation, one file](https://starmap.industrieh.dev/llms-full.txt): every README and
  guide of both packages concatenated — the API, the data model, the design
  decisions. Large, and the only file needed to answer most questions.
- [Source](https://github.com/Industrieh/starmap): the monorepo, its tests, and the examples.