Build 0.2 native launcher and portable Classic runtime (by Codex)

This commit is contained in:
Codex committed 2026-10-18 11:28:51 +02:00
1 parent 3a021fc160
commit 2552528176
84 files changed
+5004 -197

No files matched your search

+7 -5
View File
@@ -10,7 +10,7 @@ ctest --test-dir build --output-on-failure
The public checkout does not include game data. Tests that require a game installation are conditional; configure with `-DBMH_DATA="path/to/game"` to make locally available data eligible. Private saved-game fixtures are not supplied by the project. Read the test output to distinguish executed and skipped checks.
Main programs are `openbmh_play` (graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
Main programs are `OpenBMH` (native launcher and graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
## Windows
@@ -26,7 +26,7 @@ With a Visual Studio generator, choose one actually provided by your installed C
## Linux
Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the dialog backend. The default Linux dialog backend uses GTK3. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries.
Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the dialog backend. The native Linux launcher uses GTK3. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries.
The common commands above build the bundled SDL2. To use an installed SDL2 CMake package instead, configure with `-DBMH_USE_SYSTEM_SDL2=ON`. Its version and backend configuration then come from the installed package.
@@ -42,11 +42,13 @@ ctest --test-dir build-macos --output-on-failure
Use native toolchain/dependency architectures consistently. A terminal executable and a Finder-launchable, signed `.app` package are different deliverables. The commands describe the build procedure, not a claim that a particular Windows or macOS binary has passed native acceptance.
## Run with your data
## Import and run your data
Start the native launcher, choose **Add**, and select your original installation. Content and personal files are portable beside the executable. The original installation is needed only for import. See the [0.2 contract](formats/obw/runtime-0.2.md).
```sh
build/openbmh_play --data "path/to/game" --save-directory "path/to/saves"
build/openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --seed 1
build/OpenBMH
build/openbmh_cli --console --mod "build/mods/BMH-classic/content.obw" --seed 1
```
For redistribution, include [LICENSE](../LICENSE), [THIRD_PARTY_NOTICES.md](../THIRD_PARTY_NOTICES.md), the full texts in [licenses/](licenses/README.md), and the corresponding source and build information required by the applicable licenses. Inspect the actual libraries in each platform package; static SDL2 alone does not establish that every dependency is static.
+17
View File
@@ -46,3 +46,20 @@ instead of an added fixed pause. A9 and the existing scene delays can be adjuste
in Settings; loaded saves and EIN files retain their chosen speeds. VGA retrace
animations use a 70-Hz reference instead of the host monitor's refresh rate.
`--live-frame-ms` and `BMH_LIVE_FRAME_MS` remain explicit diagnostic overrides.
## Native data and saves in 0.2
Classic imports preserve the supported BMH and Football Limited structures in sealed OBW
packages. The normal runtime no longer reads the original installation. Package integrity
failures require reimport; Classic overlays and manual content editing are unsupported.
Native saving and autosaving consume no random numbers. The FBM writer previously drew
four Watcom values for its encryption envelope, so future results after a legacy save
operation can differ. A native save/load pair preserves both generators and their draw
counts exactly. Original saves lack the clock-seeded Watcom state; migration derives its
initial value reproducibly from the source file and records the full state thereafter.
The launcher start year affects displayed years only. Classic weekdays and season timing
retain their existing cycle. Imported careers keep the valid year in their own save header.
The launcher exits without confirmation; the running game's existing exit confirmation
remains in effect and returns control to the launcher after a confirmed exit.
+2 -2
View File
@@ -4,12 +4,12 @@ The console is a local control interface for one running career. Human clients,
## Choose a transport
For a single process, start `openbmh_cli --console --data "path/to/game" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
For a single process, start `openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
For separate manager processes, start a local mailbox server:
```sh
openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
```
A client sends one block on stdin to:
+1
View File
@@ -6,6 +6,7 @@ See [Compatibility decisions](COMPATIBILITY.md) for the overall policy. These en
describe deliberate changes; they are not a list of every known compatibility limit.
- [src/app/career_session.cpp](../src/app/career_session.cpp): supports designated set-piece record initialization and validation.
- [src/app/career_session.cpp](../src/app/career_session.cpp): native saves do not consume gameplay randomness for encryption.
- [src/app/quit_confirmation.hpp](../src/app/quit_confirmation.hpp): confirms application exit with a localized native dialog, with cancellation selected by default.
- [src/formats/le.hpp](../src/formats/le.hpp): applies a shared supported rule profile when loading editions with different rule-table values.
- [src/formats/rule_base.cpp](../src/formats/rule_base.cpp): normalizes live-scene defaults, league strength ranges, option defaults, stadium prices and capacities, betting limits, and the foreign-player limit across supported editions.
+17 -2
View File
@@ -12,8 +12,9 @@ OpenBMH is a C++20 engine with graphical and console frontends. The implementati
| `src/ui` | View projections, rendering and input interpretation for game screens |
| `src/cli` | Command language, structured protocol, console windows and multi-client seat routing |
| `src/audio` | Bank decoding, synthesis, playback and cues, without authority to change gameplay |
| `src/launch` | Locating user data, archive extraction, edition normalisation and file selection |
| `src/import` | Standalone legacy-to-OBW conversion; no game-state ownership or OBW engine integration |
| `src/launch` | Native launcher, portable mod library, child processes and legacy installation discovery |
| `src/content` | Sealed OBW content, native career containers and personal preferences |
| `src/import` | Legacy installation and save-layout conversion; original readers are used here |
`bmhcore` contains the format and game layers. `bmhui`, `openbmh_audio` and the application session provide reusable pieces above it. Frontends should translate actions and display results; they should not introduce independent transfer, calendar or financial rules.
@@ -38,3 +39,17 @@ Legacy saves serialize blocks in a fixed order and store name pools separately.
The [console reference](CLI_CONCEPT/README.md) documents window commands. [protocol.md](protocol.md) describes structured requests, and [CONSOLE_CLIENTS.md](CONSOLE_CLIENTS.md) explains safe client ownership and batching. Prefer shared projections/actions when adding another frontend.
Use synthetic data for public tests and locally supplied installations only for data-dependent checks. Renderer tests, simulation tests and target-platform runtime checks answer different questions; document what each validates. See [CONTRIBUTING.md](../CONTRIBUTING.md).
## 0.2 content boundary
Normal GUI and console entrypoints accept sealed Classic OBW packages. `content::Mount`
owns a shared immutable decoded store; existing path-shaped UI aliases identify resources
inside it, without creating VGA/FNT/EXE files or falling back to an installation on disk.
The only mutable mount setting is the presentation year of the selected career. Native
`.obs` checkpoints serialize named fields, compatibility memory blocks, both random
streams, Reality residues and the manager-desk driver. No host object, pointer or callback
is dumped. The session reconstructs content pointers and callbacks when loading.
The native launcher remains the parent process. Each game starts in a fresh child process
of `OpenBMH`, keeping edition-specific process globals isolated. Portable mod content and
personal files have independent lifetimes. See [runtime-0.2](formats/obw/runtime-0.2.md).
+1 -1
View File
@@ -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
+100
View File
@@ -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
}