SatSim JS
=========
[](https://github.com/ssc-ai/satsimjs/actions/workflows/tests.yml)
SatSim source code was developed under contract with AFRL/RDSM, and is approved for public release under Public Affairs release approval #AFRL-2022-1116.
## Installation from NPM
```sh
npm install satsim
```
## Usage
### NPM Installation (Recommended)
index.js
```javascript
import { Universe, createViewer } from "satsim";
import "cesium/Build/Cesium/Widgets/widgets.css";
const universe = new Universe();
const viewer = createViewer("cesiumContainer", universe);
```
index.html
```html
```
### CDN Usage
For quick prototyping or when you don't want to set up a build system, you can use the CDN version:
```html
SatSim CDN Example
```
**Note:** The CDN file is approximately 4.4MB as it includes the entire Cesium library. For production applications, we recommend using the NPM version with a proper build system for better optimization and code splitting.
## Example Webpack Application
```sh
git clone https://github.com/ssc-ai/satsimjs-example.git
cd satsimjs-example
npm install
npm start
```
## Example NextJS Application
```sh
git clone https://github.com/ssc-ai/satsimjs-nextjs-example.git
cd satsimjs-nextjs-example
npm install
npm run dev
```
## Optional Runtime Layer
SatSim also includes an optional runtime foundation for applications that need
an authoritative simulation process with read-only or read/write clients.
Browser-safe imports:
```javascript
import { RuntimeClient, SessionManager, SimulationRuntime } from "satsim";
```
Node server import:
```javascript
import { HttpRuntimeServer } from "satsim/src/runtime/node.js";
```
The runtime API exposes scenario load/start/stop, snapshots, SSE state
streaming, ordered runtime events, and session-based write policies:
`multi`, `single`, or `readOnly`. Domain-specific protocol adapters should be
composed by the embedding application.
Command schemas and command-family behavior are documented in
[`docs/commands.md`](docs/commands.md).