|
Download README.md from Snapkitty/orbital-one: direct link, hf CLI and curl.
- Browser
- Download file 4.69 kB
-
https://huggingface.co/datasets/Snapkitty/orbital-one/resolve/main/README.md
- Command line
-
hf download hf://datasets/Snapkitty/orbital-one/README.md
-
curl -L -o README.md https://huggingface.co/datasets/Snapkitty/orbital-one/resolve/main/README.md
4.69 kB
| license: agpl-3.0 | |
| language: | |
| - en | |
| tags: | |
| - typescript | |
| - simulation | |
| - spacecraft | |
| - physics | |
| - three-js | |
| - browser | |
| - sdk | |
| - zero-dependencies | |
| - sovereign | |
| - snapkitty | |
| - flight-model | |
| - telemetry | |
| - guidance | |
| - hardware | |
| - javascript | |
| task_categories: | |
| - other | |
| size_categories: | |
| - n<1K | |
| pretty_name: orbital-one — Browser Spacecraft Simulator + SDK | |
| # orbital-one | |
| **Browser spacecraft simulator and headless flight-model SDK.** | |
| Launch from the pad, fly a two-stage ascent to orbit — or import the sim engine directly into your own project. | |
| SnapKitty West / SNAPKITTYWEST — MIT License — 2026 | |
| --- | |
| ## What It Is | |
| A browser 3D spacecraft simulator built on Three.js + Vite, with a **zero-dependency TypeScript SDK** that exposes all 8 sim modules for headless use in Node, Deno, Bun, or any bundler. | |
| ```ts | |
| import { createState } from './src/sim/state.js'; | |
| import { tick } from './src/sim/physics.js'; | |
| import { telemetry } from './src/sim/telemetry.js'; | |
| const s = createState(); | |
| for (let i = 0; i < 6000; i++) tick(s); // 100 simulated seconds | |
| console.log(telemetry(s).altitude); // metres above surface | |
| ``` | |
| --- | |
| ## Repository | |
| ``` | |
| orbital-one/ | |
| ├── src/ | |
| │ ├── sim/ | |
| │ │ ├── state.ts Mission state (vehicle, fuel, orbit elements) | |
| │ │ ├── physics.ts Tick-based physics integrator | |
| │ │ ├── guidance.ts Ascent + orbital guidance laws | |
| │ │ ├── navigation.ts Inertial navigation system | |
| │ │ ├── propulsion.ts Engine model (thrust, Isp, staging) | |
| │ │ ├── mission.ts Mission sequencer (pre-launch → orbit → coast) | |
| │ │ ├── telemetry.ts Telemetry snapshot (altitude, velocity, apoapsis...) | |
| │ │ └── math.ts Orbital mechanics primitives (Kepler, RK4) | |
| │ ├── render/world.ts Three.js scene (planet, vehicle, trajectory trail) | |
| │ ├── ui/ | |
| │ │ ├── cockpit.ts Flight deck HUD | |
| │ │ └── instruments.ts Instrument panel (altitude tape, velocity, TWR) | |
| │ ├── audio.ts Engine audio (Web Audio API) | |
| │ ├── input.ts Keyboard + gamepad bindings | |
| │ └── main.ts App entry point | |
| ├── tests/ | |
| │ ├── flight.test.ts Headless physics tests | |
| │ ├── browser/flight.spec.ts Playwright end-to-end | |
| │ └── profile.ts Performance profile harness | |
| └── docs/verification.md Simulation verification notes | |
| ``` | |
| --- | |
| ## Sim Modules — SDK Reference | |
| | Module | Export | Description | | |
| |---|---|---| | |
| | state | `createState()` | Fresh mission state | | |
| | physics | `tick(state)` | Advance simulation 1/60 s | | |
| | guidance | `guidanceUpdate(state)` | Pitch program + orbit insertion | | |
| | navigation | `navUpdate(state)` | Inertial position/velocity | | |
| | propulsion | `propulsionTick(state)` | Thrust, Isp, staging events | | |
| | mission | `missionSequencer(state)` | Phase transitions | | |
| | telemetry | `telemetry(state)` | Snapshot (altitude, velocity, apoapsis, etc.) | | |
| | math | `keplerStep`, `rk4` | Orbital mechanics primitives | | |
| All modules are zero-dependency TypeScript. `package.json` exports map wires every entry point. | |
| --- | |
| ## Quick Start | |
| ```sh | |
| npm ci && npm run dev # browser app → http://127.0.0.1:5173 | |
| npm test # headless physics tests | |
| npm run test:browser # Playwright (requires Chrome) | |
| npm run build # → dist/ (static, serve over HTTP) | |
| ``` | |
| Requires Node.js 22.12+. | |
| --- | |
| ## Stack | |
| | Layer | Tool | | |
| |---|---| | |
| | 3D rendering | Three.js r180 | | |
| | Bundler | Vite 7 | | |
| | Language | TypeScript 5.9 | | |
| | Tests | Vitest + Playwright | | |
| | License | MIT | | |
| --- | |
| ## Related Repos | |
| | Repo | Description | | |
| |---|---| | |
| | [SNAPKITTYWEST/sov](https://huggingface.co/datasets/SNAPKITTYWEST/sov) | Sovereign Package Switchboard | | |
| | [SNAPKITTYWEST/mantra](https://huggingface.co/datasets/SNAPKITTYWEST/mantra) | Deterministic auditable language | | |
| | [GitHub](https://github.com/SNAPKITTYWEST/orbital-one) | Source + CI | | |
| --- | |
| ## License | |
| Licensed under **AGPL-3.0**. Full text: [LICENSE](LICENSE). | |
| Releases published before 2026-10-07 were licensed under MIT; copies obtained under those terms keep them. | |
| ### 💼 Commercial License | |
| SnapKitty code is free and open under **AGPL-3.0** for open-source use. Building a commercial product or service? A **proprietary commercial license** from Snapkitty Collective LLC lets you ship this code without the AGPL's source-sharing and network-use obligations. | |
| **[→ Get a commercial license](mailto:A.parr@belespritdaccord.uk?subject=Commercial%20license:%20orbital-one)** · A.parr@belespritdaccord.uk | |