# Uchusen Rockets 宇宙船 — line drawings and 3D views of rockets

> Uchusen Rockets 宇宙船: line drawings and 3D views of rockets, as a web component. Every variant with its own sourced sizes, a typed way to assemble a rocket from parts, stack and separate. No logos. three.js is a peer dependency.

Install with `npm install @johnmorrisdotca/uchusen-rockets`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/uchusen-rockets/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/getting-started.md): Put a rocket on a page, take it apart, change how it looks, and read its sizes from code, in about ten minutes.
- [Looks, views and parts](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/looks-views-and-parts.md): Choose how a rocket is drawn, from where, and which parts of it show, with the same words in HTML, React and code.
- [Build a rocket from parts](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/build-from-parts.md): Mix parts of different rockets, ask whether they go together, and get a mesh and a drawing without three.js.
- [Lit engines and flights](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/engines-and-flights.md): Light the engines at full thrust, play a flight phase by phase from a published timeline, and know which parts of the picture are sourced.
- [Rockets to scale](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/scale-lineups.md): Stand rockets on one baseline at one scale beside a ruler, a person and a building, as an element or as SVG text.
- [Put a rocket on your own site](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/embed-on-your-site.md): Six ways to copy a rocket into a page, from a script tag to a plain image, and how a painted rocket's credit travels with it.
- [Journey mode](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/journey.md): Fly a real rocket or a ship of the SPX fleet from the Earth to the Moon or a planet. Launch windows from real positions, the burns, the flip and the numbers, as plain functions.
- [React and other frameworks](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/react-and-frameworks.md): Use the rocket in React with the wrapper, and in Vue, Svelte, Angular or plain HTML as a custom element, each as an example that is built and opened in a browser.
- [Ready files and 3D models](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/assets-and-3d-files.md): Use the shipped .glb and .svg files directly, make your own with build, and know what is inside them.
- [Bundlers and CDNs](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/bundlers-and-cdn.md): Use the rocket from unpkg, with Vite, or with webpack, as examples that are built and opened in a browser.
- [TypeScript and Node](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/typescript-and-node.md): Use the package's types in TypeScript and its core in Node, with no DOM and no three.js, as examples that are type-checked and run.
- [Variants and sourced sizes](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/variants-and-sources.md): Why every rocket comes in versions, how a figure names its source, and what a blank or a disagreement means.
- [Licences, credits and trademarks](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/licences-and-credits.md): What is MIT, what is CC BY 4.0, what is public domain and ODbL, and how a rocket you show carries the right credit.
- [Architecture](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/architecture.md): How the data, the part records, the drawing, the mesh and the element fit together, and why none of them can disagree.
- [Troubleshooting](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/troubleshooting.md): Why the tag does nothing, why the 3D view does not appear, why a painted model is missing, and what the errors mean.
- [Upgrading](https://johnmorrisdotca.github.io/uchusen-rockets/docs/guides/upgrading.md): What changed between versions that a project might feel, and how to move forward without surprises.

## Reference

- [@johnmorrisdotca/uchusen-rockets/build](https://johnmorrisdotca.github.io/uchusen-rockets/docs/api/build/index.md): Build a mesh and a drawing
- [@johnmorrisdotca/uchusen-rockets/journey](https://johnmorrisdotca.github.io/uchusen-rockets/docs/api/journey/index.md): Journey mode: transfers, launch windows and flip-and-burn trips
- [@johnmorrisdotca/uchusen-rockets/element](https://johnmorrisdotca.github.io/uchusen-rockets/docs/api/element/index.md): The web components
- [@johnmorrisdotca/uchusen-rockets/react](https://johnmorrisdotca.github.io/uchusen-rockets/docs/api/react/index.md): The React wrapper
- [@johnmorrisdotca/uchusen-rockets](https://johnmorrisdotca.github.io/uchusen-rockets/docs/api/main/index.md): Rockets, variants, parts and the fit check

## Optional

- [Changelog](https://johnmorrisdotca.github.io/uchusen-rockets/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/uchusen-rockets/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/uchusen-rockets)