The release
Every SDK is the release sdk-<build id> of this repository, at https://github.com/sunrise-org/sunrise/releases/download/sdk-<build id>/<file>. Its files:
From Sunrise's modding bookead8a1e
This table is generated when the book is built: see it in the published book.
The compiled slices exist once per host; a file named …-server.tar.xz is the dedicated server's. Everything else exists once per build. .tar.xz files are tar archives compressed with xz; surface.json is the file itself.
A Nightly carries a copy of its build's sdk.json in its own signed sums. The launcher learns which build a game is from the copy in that game's release, and keeps the answer, so it is known offline afterwards.
Which slices a build needs
The launcher fetches only the compiled slices the instance's mods need, decided once for the whole set of enabled mods. The routes and their slices come from the same input list the launcher and the packager read:
This table is generated when the book is built: see it in the published book.
Each slice unpacks into its own folder. Using a kept slice again checks only its files' names and sizes against a stamp written after its verified unpack; it does not hash them again.
sdk.json
The index. Readers ignore fields they don't know and refuse a schema they don't know: adding a field keeps the number, removing or redefining one changes it.
| Field | What it is |
|---|---|
schema | The index's schema number (1). |
build.commit | The build id: the game's full commit sha. |
build.game | The vanilla version the build implements (26.3). |
build.date | The commit's date, YYYY-MM-DD, UTC. |
build.nightly | The Nightly name that ships this build, when one does. |
package_ | The prebuilt package's layout number. A reader takes only the number it was made for. |
toolchain.rust | The Rust release everything in the SDK was compiled with. |
content_ | The content manifest's version: the api key of sunrise-mod.toml. |
surface.hash | surface.json's own hash: equal hashes, equal surface. |
surface.previous | The build id of the SDK published before this one, which it is compared with. Absent on the first. |
surface.source | That comparison in one word, its worst change: identical, additive, conditional or breaking (classes). |
surface.changes | The ids of the records that changed, breaking ones first. |
surface.notes | The change notes attached to them, each { ids, why, migrate } (notes). |
mixins.rev, mixins.patch | The pinned horizon-mixins tool's revision and the SHA-256 of the patch carried on it. |
assets | Every file of the release but sdk.json and the sums, by name: sha256, size, kind, codec (none or xz), and for a compiled slice its target and side (client or server). |
inputs | The files each route needs, named before any download, build or packaging starts: its SDK slices, the programs beside the game and the checkout files, how to make each, and what each slice must hold. |
How a download is checked
The mod tool and the launcher check an SDK the same way, whatever the base it came from, and refuse it by name at the first step that fails:
SHA256SUMScarries Sunrise's signature for the tagsdk-<build id>. That signature never passes for a game release, and a game release's never passes for an SDK.sdk.jsonis the file those sums list, names this build, has a schema and package format the reader knows, and lists only assets of known kinds and codecs under plain file names.- Every other file has the size and SHA-256
sdk.jsongives, checked before it is decoded. An archive unpacks into a temporary folder, renamed into place only when every entry unpacked, and is refused past an unpacked size limit or for any entry that is not a plain file or folder inside it.
An SDK newer than the launcher reads (its schema, package format or Rust) asks for a launcher update; one made with an older Rust than the launcher compiles with asks for a newer game build.
Edit this page on GitHub · Spotted something wrong? Open an issue or ask on Discord.



