Build 0.2 native launcher and portable Classic runtime (by Codex)
This commit is contained in:
1 parent
3a021fc160
commit
2552528176
84 files changed
+5004
-197
No files matched your search
+1
-1
@@ -1,6 +1,6 @@
|
||||
# OBW: OpenBMH world, save and pack format (concept, format version 1.0)
|
||||
|
||||
Status: **format concept with a complete Classic installation-content converter** for roadmap 0.2, with preparation for 0.4. `openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds under the guarded [`runtime:classic-v1` contract](obw/classic-v1.md), including all startup inputs and media. The [import guide](obw/import.md) distinguishes this from the explicitly partial `legacy-database-v1` development export. The 0.1 engine still reads legacy installations; OBW runtime integration and savegame conversion are separate work.
|
||||
Status: **format concept with a complete Classic installation-content converter** for roadmap 0.2, with preparation for 0.4. `openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds under the guarded [`runtime:classic-v1` contract](obw/classic-v1.md), including all startup inputs and media. The [import guide](obw/import.md) distinguishes this from the explicitly partial `legacy-database-v1` development export. The 0.2 development branch adds a sealed Classic runtime, portable launcher and native career checkpoints; see [the runtime contract](obw/runtime-0.2.md). The released 0.1 engine still reads legacy installations.
|
||||
|
||||
## 1. Goals and non-goals
|
||||
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-only -->
|
||||
# Classic runtime and portable launcher (0.2 development)
|
||||
|
||||
This contract is for the 0.2 development branch. It is not a release validation claim.
|
||||
|
||||
## Portable layout and lifecycle
|
||||
|
||||
`OpenBMH.exe` (Windows) / `OpenBMH` (Linux and macOS) starts the operating system's
|
||||
native launcher: one selected row, **Name | Art**, and **Start, Add, Delete, Rename, End**.
|
||||
No installation is auto-selected on first launch. Add converts an externally owned
|
||||
installation; original assets never belong in a distribution.
|
||||
|
||||
```
|
||||
OpenBMH[.exe]
|
||||
mods/<name>/content.obw
|
||||
userdata/<content-id>/*.obs
|
||||
userdata/<content-id>/*.obsettings
|
||||
userdata/<content-id>/*.oblayout
|
||||
userdata/<content-id>/highscore-<signature>.obscore
|
||||
```
|
||||
|
||||
The directory name is the launcher name, separate from `manifest.mod` (`BMH-classic`
|
||||
or `FLTD-classic`). `FTDL-classic` is the requested English directory-name default.
|
||||
Names must be portable single path components; duplicates are case-insensitive.
|
||||
Classic files are sealed, not editable world overlays. Modern gameplay is not implemented.
|
||||
|
||||
Rename changes the directory only. Delete removes mod content after confirmation and
|
||||
retains user data. Reimporting the same content and start year reconnects it. The content
|
||||
identity excludes display title, generator version and the CRC inventory, but includes
|
||||
runtime content and the starting-year configuration. It deliberately changes when content
|
||||
actually changes. User data cannot be silently associated with a different database.
|
||||
|
||||
The launcher starts a child process of the same binary, with `--run-mod` and a separate
|
||||
save directory, and remains available after the child exits. `--mod <content.obw>` bypasses
|
||||
the launcher. A normal GUI/console invocation cannot fall back to original game files.
|
||||
|
||||
## Integrity and content access
|
||||
|
||||
The existing `classic-installation-v1` payload is complemented by
|
||||
`x-classic/seal.json` (`classic-seal@1.0`): SHA-256 for every other archive entry plus
|
||||
`content_id`. The earlier CRC inventory excludes the seal to avoid a circular digest.
|
||||
A missing seal, changed entry or unexpected file in a Classic mod directory prevents start.
|
||||
SHA-256 detects ordinary manual changes/corruption; it is not a signature or a promise
|
||||
against a local owner modifying the validator.
|
||||
|
||||
The runtime decodes indexed images, fonts and palettes into an immutable store. Existing
|
||||
UI aliases such as `KB/29.VGA` select the already decoded object; they are not files.
|
||||
Embedded image palettes are imported separately, preserving the Sportschau/title colours.
|
||||
Original single-byte readme content is preserved in the local package where available.
|
||||
No original executable is reconstructed or executed.
|
||||
|
||||
## Native careers and personal files
|
||||
|
||||
A `.obs` ZIP contains the complete sealed starting world, with its original manifest at
|
||||
`state/world-manifest.json`. The top manifest has `kind: save`,
|
||||
`save_profile: classic-career-v1` and the content identity.
|
||||
|
||||
| Entry | Native contract |
|
||||
|---|---|
|
||||
| `state/career.json` | `classic-state@1.0`: named typed arrays/scalars, name bytes and explicitly addressed compatibility blocks |
|
||||
| `state/rng.json` | `classic-rng@1.0`: both seeds and decimal-string draw counters |
|
||||
| `state/session.json` | `classic-session@1.0`: runtime option bytes, stable desk arguments and manager mappings |
|
||||
| `state/driver.json` | `classic-driver@1.0`: desk stage/order, match groups, referees, event counter and previous results |
|
||||
| `state/information.json` | `classic-bytes@1.0`: Classic browser information fields |
|
||||
| `state/integrity.json` | `save-integrity@1.0`: SHA-256 of every other state entry |
|
||||
|
||||
Only existing manager-desk save boundaries are supported. Runtime callbacks and host
|
||||
pointers are reconstructed. Native saving is RNG-neutral; unlike the old FBM envelope it
|
||||
needs no random encryption fields. Both generator seeds and draw counters resume exactly.
|
||||
Names and compatibility bytes use hexadecimal encoding to retain single-byte values
|
||||
without pretending they are UTF-8. Integer fields have explicit bounds.
|
||||
|
||||
`.obsettings`, `.oblayout` and `.obscore` are JSON documents with kind-specific schema
|
||||
names (`classic-settings@1.0`, `classic-layout@1.0`, `classic-highscore@1.0`) and a
|
||||
`classic-bytes@1.0` payload. They preserve existing availability bits, layout chains and
|
||||
high-score fields. The existing application validators still govern settings and layouts.
|
||||
Writes publish a complete temporary file atomically; overwrites require the existing
|
||||
application confirmation.
|
||||
|
||||
## Legacy migration and Classic dates
|
||||
|
||||
Add defaults to transferring games/settings, with a separately selectable source directory.
|
||||
The source is read-only. Existing personal files are retained rather than overwritten.
|
||||
Individual failures appear in the import report.
|
||||
|
||||
German/OpenBMH V2.24 files use their documented block contract. Original Football Limited
|
||||
V2.20 has its own block translator, including FA Cup, League Cup and additional-cup memory.
|
||||
It is never accepted by merely changing a version string. Like the V2.20 loader, migration
|
||||
rebuilds its unsaved current match groups without replaying daily finances or shuffling
|
||||
saved manager order. Unknown/damaged versions fail explicitly.
|
||||
|
||||
Original FBM files do not contain the clock-seeded Watcom random state. Migration therefore
|
||||
seeds that stream reproducibly from SHA-256 of the source file. A converted career cannot
|
||||
promise the original machine's unknown random future; subsequent native checkpoints retain
|
||||
both streams in full.
|
||||
|
||||
The selected start year changes only displayed years for new careers. Weekdays and the
|
||||
original four-year calendar remain unchanged. Imported careers retain the year from their
|
||||
saved information header when it is valid. This cosmetic origin is independent of the
|
||||
immutable world's start configuration and is carried in the native career.
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-bytes.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,402 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-driver.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-driver@1.0"
|
||||
},
|
||||
"stage": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 2
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"manager_position": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4
|
||||
},
|
||||
"next_event_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
},
|
||||
"loaded_matchday_resume": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"suppress_remaining_pre_match_offers": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"national_nomination_desk": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"enable_national_nomination_desks": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"referee_source": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"referees": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"last_results": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"valid": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"matchday": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"valid",
|
||||
"date",
|
||||
"calendar_entry",
|
||||
"matchday",
|
||||
"groups",
|
||||
"tournament_name"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"stage",
|
||||
"calendar_entry",
|
||||
"manager_position",
|
||||
"next_event_id",
|
||||
"loaded_matchday_resume",
|
||||
"suppress_remaining_pre_match_offers",
|
||||
"national_nomination_desk",
|
||||
"enable_national_nomination_desks",
|
||||
"groups",
|
||||
"referee_source",
|
||||
"referees",
|
||||
"last_results"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-highscore.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-highscore@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 720,
|
||||
"minLength": 720
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-layout.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-layout@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 1728,
|
||||
"minLength": 1728
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-rng.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-rng@1.0"
|
||||
},
|
||||
"watcom": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"game": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"watcom",
|
||||
"game"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-seal.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-seal@1.0"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"content_id",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-session.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-session@1.0"
|
||||
},
|
||||
"runtime": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"value": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"value"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"desk_callargs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"managers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 3,
|
||||
"maxItems": 3
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"runtime",
|
||||
"desk_callargs",
|
||||
"managers"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-settings.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-settings@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 360,
|
||||
"minLength": 360
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,542 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-state.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-state@1.0"
|
||||
},
|
||||
"indoor": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"level": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_rain": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_temperature": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_shooter": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_pick_quality": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"live_scene": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_selection_available": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_club_threshold": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"list_toggle": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"lineups_frozen": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"offer_answer": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"transfer_notice_suppressed": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"pools_open": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"autosave_months": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"autosave_month": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"display_start_year": {
|
||||
"type": "integer",
|
||||
"minimum": 1900,
|
||||
"maximum": 9998
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"season_start": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"development_balance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"trend_rotation": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"season": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"team_morale": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_bonus": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"formations": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_records": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tactics": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_options": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_table": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_bc": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_78": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_b8": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"master_database_metadata": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"referee_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stadium_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_ratings": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"position_history": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"league_rounds": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stocks": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"foreign_strength": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"mailbox": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"squad_slots": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"team_flags": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"manager_teams": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"live_matches": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"sportschau_homes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"sportschau_priorities": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"club_ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_cards": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_name_offsets": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"players": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"form": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"skills": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"identity": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name_hex",
|
||||
"form",
|
||||
"skills",
|
||||
"identity"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4095
|
||||
},
|
||||
"memory": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"reality": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"initialized": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"deflected": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"card_kind": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"distance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"actors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 5,
|
||||
"maxItems": 5
|
||||
},
|
||||
"grid": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"planes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 1144,
|
||||
"maxItems": 1144
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"positions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 24,
|
||||
"maxItems": 24
|
||||
},
|
||||
"ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"previous_ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"planes",
|
||||
"positions",
|
||||
"ball",
|
||||
"previous_ball"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"initialized",
|
||||
"deflected",
|
||||
"card_kind",
|
||||
"distance",
|
||||
"actors",
|
||||
"grid"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"indoor",
|
||||
"level",
|
||||
"chance_rain",
|
||||
"chance_temperature",
|
||||
"last_shooter",
|
||||
"last_pick_quality",
|
||||
"live_scene",
|
||||
"sportschau_selection_available",
|
||||
"sportschau_club_threshold",
|
||||
"list_toggle",
|
||||
"lineups_frozen",
|
||||
"offer_answer",
|
||||
"transfer_notice_suppressed",
|
||||
"pools_open",
|
||||
"autosave_months",
|
||||
"autosave_month",
|
||||
"display_start_year",
|
||||
"date",
|
||||
"season_start",
|
||||
"development_balance",
|
||||
"trend_rotation",
|
||||
"season",
|
||||
"team_morale",
|
||||
"player_bonus",
|
||||
"formations",
|
||||
"manager_records",
|
||||
"tactics",
|
||||
"manager_options",
|
||||
"club_table",
|
||||
"club_heap_bc",
|
||||
"club_heap_78",
|
||||
"club_heap_b8",
|
||||
"master_database_metadata",
|
||||
"referee_names",
|
||||
"stadium_names",
|
||||
"tournament_name",
|
||||
"manager_results",
|
||||
"manager_ratings",
|
||||
"position_history",
|
||||
"league_rounds",
|
||||
"results",
|
||||
"stocks",
|
||||
"foreign_strength",
|
||||
"mailbox",
|
||||
"club_names",
|
||||
"player_names",
|
||||
"squad_slots",
|
||||
"team_flags",
|
||||
"manager_teams",
|
||||
"live_matches",
|
||||
"sportschau_homes",
|
||||
"sportschau_priorities",
|
||||
"club_ids",
|
||||
"player_cards",
|
||||
"player_name_offsets",
|
||||
"players",
|
||||
"memory",
|
||||
"reality"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-integrity.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "save-integrity@1.0"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-manifest.json",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"format",
|
||||
"format_version",
|
||||
"kind",
|
||||
"save_profile",
|
||||
"content_id"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"const": "openbmh-world"
|
||||
},
|
||||
"format_version": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"kind": {
|
||||
"const": "save"
|
||||
},
|
||||
"save_profile": {
|
||||
"const": "classic-career-v1"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
Reference in new issue
Block a user