@seriousgaming/sdk-tools

The tools for building Serious Gaming games: the seriousgaming-sdk command, the dev server and its console, scaffolding and templates, the build, the test helpers, and the documentation.

pnpm add -D @seriousgaming/sdk-tools

To start a new game, run it without installing:

pnpm dlx @seriousgaming/sdk-tools new package

The scaffolded package installs this package beside @seriousgaming/sdk, which it needs at the same version. The documentation ships inside the package, matched to its version and readable offline: start at dist/docs/index.md, or run pnpm run sdk docs view.

Stability

A version with a prerelease suffix, such as 1.0.0-alpha.1, carries none of these guarantees: it can change in any way before the release it leads to.

From 1.0.0, these follow semantic versioning. A breaking change waits for a major release:

| Surface | What it holds | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | The seriousgaming-sdk command | Commands, flags, the JSON result envelope, exit codes and error codes. Message text is not part of it | | ./client | createTestSession, startDevServer, FakeClock, the stub services and their types, and the command and projection types it re-exports from @seriousgaming/sdk |

These exist for the Serious Gaming platform and this repository's own tooling, not for games, and clause 4(b) of the licence does not allow you to use them to build any other runtime. They are versioned with the package but may change in a minor release:

| Subpath | What it holds | | ----------- | ------------------------------------------------------------------------------------------------------------------------------ | | ./host | The host half of the iframe protocol and its wire types, and how a host reads a guide | | ./runtime | The uses guard, the context merge and projection, the tick-result check, the manifest version and the specification revision |

Everything else in the package is internal: dist/cli.js and the other bundles, the dev console, and the layout of dist/. The exceptions are dist/docs/ and dist/templates/package/, which you may read and copy from, though their contents change with every release.

Licence

The Serious Gaming SDK Tools Licence, in LICENSE. In short: you may install and use the package to build, test and publish games for the Serious Gaming platform, and you own the games you make. Files it generates or copies into your project are yours under the Apache License, Version 2.0. You may not redistribute the package, or use it to build or run another runtime for games. The licence text, not this summary, is what applies.