Restore direct-installation Classic baseline for OpenBMH 1.0 (by Codex)
This commit is contained in:
1 parent
c8f04d0099
commit
c3704878d6
255 files changed
+311
-21131
No files matched your search
+7
-103
@@ -1,31 +1,6 @@
|
||||
# OBW: OpenBMH world, save and pack format
|
||||
# OBW: OpenBMH world, save and pack format (concept, format version 1.0)
|
||||
|
||||
## Implemented profiles
|
||||
|
||||
| Profile | Format | Reader/writer | Playable |
|
||||
|---|---|---|---|
|
||||
| `classic-installation-v1` | OBW 1.0, `runtime:classic-v1` | Complete BMH/FLTD converter; OpenBMH 0.2 launcher, GUI and console | Yes, sealed Classic content |
|
||||
| `editor-world-v1` | OBW 1.1, `editor:world-v1` | OpenBMH Editor 0.5: OBW/unpacked worlds and legacy import, OBW-only saving | No; editable start database |
|
||||
| `legacy-database-v1` | OBW 1.0 development export | Converter's explicit `--database-only` option | No; partial legacy export |
|
||||
|
||||
`openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds including
|
||||
startup inputs, media and frozen portrait recipes. The
|
||||
[import guide](obw/import.md) distinguishes them from the partial development
|
||||
export. OpenBMH 0.2 reads the sealed content without the original installation
|
||||
and writes separate native career checkpoints; see the
|
||||
[runtime contract](obw/runtime-0.2.md).
|
||||
|
||||
The [1.1 editor profile](obw/editor-v1.md) adds editable worlds without relaxing
|
||||
Classic seals. Opening Classic content in the editor preserves its sources;
|
||||
saving creates an editor world rather than a newly sealed Classic world.
|
||||
Names such as “Modern” are display names, not proof of runtime compatibility.
|
||||
A modern-season data package can be structurally valid and fully editable while
|
||||
its competition/season engine is still pending. See [the editor guide](../EDITOR.md).
|
||||
|
||||
The sections below define the general format and distinguish implemented
|
||||
profiles from future capabilities. Generic calendar/rule authoring, modern
|
||||
season simulation, network play and generic world-to-career generation are
|
||||
not implemented merely because their data structures are documented here.
|
||||
Status: **concept** for roadmap 0.2 (open data and typed state) with preparation for 0.4 (scalable interface, content packs). Nothing here is implemented yet; the legacy formats in this directory remain authoritative for the current engine.
|
||||
|
||||
## 1. Goals and non-goals
|
||||
|
||||
@@ -41,15 +16,14 @@ Goals:
|
||||
Non-goals of version 1.0:
|
||||
|
||||
- The match engine and its parameters (reserved namespace `x-matchengine`, see §3.3).
|
||||
- Network play and a binary encoding (reserved, see §2.4). The separate editor
|
||||
uses the additive 1.1 profile described above.
|
||||
- Network play, an editor application and a binary encoding (reserved, see §2.4).
|
||||
- Layout or screen data. Interfaces are themes (§9.6), not part of a world.
|
||||
|
||||
## 2. Container and files
|
||||
|
||||
### 2.1 Container
|
||||
|
||||
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents and referenced binary assets. The 1.1 editor reader also supports ZIP64, with its own documented size limits. The versioned Classic extension additionally permits data-only compatibility regions and startup input records; it does not permit executable code or save state in a world. The readers use miniz for the container; the editor additionally uses its declared JSON/image dependencies. Generic editor JSON remains editable by hand or script; sealed Classic packages must retain their original bytes and seals.
|
||||
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents. The project already links miniz (`bmh_miniz`) and has a JSON reader/writer (`src/cli/json.cpp`), so the format needs no new dependency. JSON keeps worlds diffable and editable by hand or by script.
|
||||
|
||||
| Extension | `kind` | Contents |
|
||||
|---|---|---|
|
||||
@@ -76,7 +50,7 @@ world/calendar.json season calendar, §7
|
||||
world/rules.json rule values (training camps, interest rates, ...)
|
||||
state/... save only, §5.9
|
||||
locale/<lang>/*.po texts, §9.3
|
||||
assets/... local Classic worlds, packs and themes, §9
|
||||
assets/... packs and themes only, §9
|
||||
x-<name>/... extensions, §3.3
|
||||
```
|
||||
|
||||
@@ -138,8 +112,6 @@ Fields and directories whose name starts with `x-` belong to extensions (`x-matc
|
||||
|
||||
Each format version is published as JSON Schema (draft 2020-12) under `docs/formats/obw/schema/<major>.<minor>/`, one file per table. The schemas are the machine-readable specification and the basis of the validator (§10).
|
||||
|
||||
The schemas describe the intermediate `legacy-database-v1` profile and the completed `classic-installation-v1` content profile. The latter requires `runtime:classic-v1`: it contains initialization policies and data-region compatibility fields in addition to typed projections. A generic OBW reader cannot execute those fields without the Classic adapter. Save, pack, theme and fully generic playable-world schemas remain future work. Optional fields and unknown extensions remain allowed.
|
||||
|
||||
## 4. Identifiers and names
|
||||
|
||||
- Every entity has a stable string id `<type>:<key>`, e.g. `nation:de`, `club:0042`, `player:01873`, `comp:de-1`, `stadium:0042`. Keys are opaque: they never encode a real name, so a world and a pack can be published independently.
|
||||
@@ -189,8 +161,7 @@ Teams without a squad (`foreign`, or `national` in a world that does not simulat
|
||||
|---|---|---|---|
|
||||
| `id` | string | R | |
|
||||
| `name` | object | R | `{"first": "...", "last": "...", "known_as": "..."}`, each a plain string; `known_as` optional |
|
||||
| `born` | date | R unless `age_at_start` | Age is derived from the in-game date |
|
||||
| `age_at_start` | object | Alternative to `born` | `{"years": 22, "on": "2026-07-01"}` when a legacy database gives an age but no exact birth date. Never invent a birthday. A consumer must explicitly support this precision. |
|
||||
| `born` | date | R | Age is derived from the in-game date |
|
||||
| `nationalities` | array | R | Nation ids, first entry is the sporting nationality (national-team eligibility) |
|
||||
| `positions` | array | R | `gk`, `def`, `mid`, `fwd` in the classic set; finer positions in later attribute sets |
|
||||
| `foot` | enum | O | `left`, `right`, `both` |
|
||||
@@ -201,18 +172,6 @@ Teams without a squad (`foreign`, or `national` in a world that does not simulat
|
||||
| `squad_number` | integer | O | |
|
||||
| `status` | object | O | Injury, suspension and card counters per competition (save only) |
|
||||
| `photo` | string | O | Default `asset:player/<key>/photo` |
|
||||
| `appearance` | object | O | Recipe of a composed portrait, see below |
|
||||
|
||||
**Composed portraits.** The original game stores no picture per player: it seeds a small random generator from the player's name and picks one of four backgrounds and one part for each of five layers from a parts sheet of the installation. OBW stores the outcome as a recipe instead of an image:
|
||||
|
||||
```json
|
||||
"appearance": {"set": "bmh-classic@1", "background": 2, "layers": [5, 0, 3, 7, 1]}
|
||||
```
|
||||
|
||||
- `set` names a portrait part set; it defines the number of backgrounds, the layers, the number of parts per layer and their placement. `bmh-classic@1` is the set of the original game.
|
||||
- The importer computes the recipe once from the legacy name and **freezes** it. A later rename (for example by a name pack) keeps the face; the legacy name-derived generator is never re-run.
|
||||
- Players created in OpenBMH (youth, generated players) receive a random recipe of the world's default set.
|
||||
- The recipe holds indices only. The part graphics come from the user's installation or from a pack that provides the same set, possibly in higher resolution (§9.2), so a recipe does not embed a composed face. A local Classic import may include the original part set as local-only assets; distributable worlds need separately licensed artwork.
|
||||
|
||||
An attribute set is declared once in `world/rules.json` with its fields, scales and meaning, so a later, finer model can sit next to the classic one without breaking the format:
|
||||
|
||||
@@ -273,7 +232,6 @@ A competition is an ordered list of **stages**. Each stage takes teams from **sl
|
||||
"type": "league",
|
||||
"nation": "nation:de",
|
||||
"tier": 2,
|
||||
"trophy": "asset:comp/de-2/trophy",
|
||||
"season_cycle": 1,
|
||||
"stages": [{
|
||||
"id": "regular",
|
||||
@@ -390,7 +348,7 @@ Edition detection is the one the launcher already performs (`src/launch/game_dat
|
||||
|
||||
### 8.2 Mapping per edition
|
||||
|
||||
The standalone converter and its Classic contract are documented in [the edition mapping](obw/import.md) and [Classic v1](obw/classic-v1.md). The core league mapping is:
|
||||
Every edition has a mapping table in the importer (to be published with it as `docs/formats/obw/import.md`):
|
||||
|
||||
| Legacy league | German editions | Football Limited | OBW |
|
||||
|---|---|---|---|
|
||||
@@ -405,8 +363,6 @@ Cups, European cups, the indoor tournament, the English FA Cup with its qualifyi
|
||||
|
||||
### 8.3 Fidelity
|
||||
|
||||
The complete `classic-installation-v1` importer preserves all installation content without starting a career. Typed projections are complemented by the versioned `x-classic` startup contract and data-only regions, including original and effective rules. Installation tests reconstruct from OBW and compare first-season initialization bytes and both RNG streams with the existing loader. They do not establish a released OBW frontend or save continuation. The optional `--database-only` intermediate profile remains explicitly non-playable. `state/x-legacy.json` is reserved for converted saves.
|
||||
|
||||
- A new career imported from an installation must produce the same first season in the engine as the legacy start (same fixtures, same participants), verified by the regression runs.
|
||||
- A converted `.FBM` must continue with the same results as the legacy save for a fixed number of turns.
|
||||
- Values the typed model does not yet understand go to `state/x-legacy.json` with their legacy name, so nothing is lost while the model grows area by area.
|
||||
@@ -432,30 +388,6 @@ Data never refers to file paths. It uses logical keys:
|
||||
| `asset:stadium/<key>/image` | Stadium picture |
|
||||
| `asset:icon/<name>` | Interface icon |
|
||||
|
||||
**Competition trophies.** Every competition type may set the optional string
|
||||
`trophy` to a logical key `asset:comp/<key>/trophy`. The key is stable and opaque;
|
||||
it may be shared by several competitions, and never embeds a season, localized
|
||||
name, file path, URL or runtime index. `<key>` is a nonempty sequence of ASCII
|
||||
letters, digits, `.`, `_` or `-`, excluding `.` and `..`. A competition without
|
||||
the field uses `asset:comp/<competition key>/trophy`, where the competition key is
|
||||
its `id` without `comp:`. This also applies to additional foreign leagues and
|
||||
international competitions; a fixed competition list is not part of the format.
|
||||
|
||||
Resolve that key from active packs by priority, then the world. If unavailable,
|
||||
resolve `asset:comp/generic/trophy` through the same sources, then use the
|
||||
client's built-in neutral trophy icon. The generic key is reserved for this
|
||||
fallback. A missing trophy never prevents a competition from being played.
|
||||
An invalid explicitly supplied key is an input error, not a request to guess a
|
||||
file path. File presence is not mandatory because a pack or theme may supply
|
||||
the image later. Asset-index metadata and rights requirements still apply.
|
||||
Trophies are presentation only; they do not identify competition rules, stages
|
||||
or historical winners.
|
||||
|
||||
This optional-field clarification remains compatible with 1.0 worlds: old
|
||||
documents omit it, older readers ignore it, and no new `requires` feature is
|
||||
needed. Classic converters emit the conventional per-competition key without
|
||||
fabricating a trophy image or changing the original local media inventory.
|
||||
|
||||
### 9.2 Resolution and image formats
|
||||
|
||||
A resolver looks a key up in the active packs by priority (§9.5), then in the world, then falls back: original low-resolution graphics of the installation where one exists, a crest generated from `colors`, a silhouette for photos, a neutral icon.
|
||||
@@ -463,37 +395,9 @@ A resolver looks a key up in the active packs by priority (§9.5), then in the w
|
||||
- **Crests, logos, flags, icons:** SVG preferred (scales to every resolution). Otherwise PNG with alpha in size steps 64, 128, 256 and 512 px (`crest@128.png`). The resolver picks the smallest step not below the requested size.
|
||||
- **Photos:** PNG, JPEG or WebP, aspect 3:4, reference size 300×400 px, larger allowed. Faces centred; the interface crops, it never stretches.
|
||||
- **Pictures** (stadiums, backgrounds): PNG, JPEG or WebP, 16:9 reference 1920×1080.
|
||||
- **Trophies:** SVG or PNG/WebP with alpha, preserving the full object and native
|
||||
aspect ratio. A transparent generic trophy may be provided under the reserved
|
||||
fallback key. No real trophy artwork is bundled by the format specification.
|
||||
|
||||
Asset metadata sits next to the files in `assets/index.json`: key, files per size, author, source and licence (required).
|
||||
|
||||
**Optional visual defaults (1.1).** A world may set
|
||||
`manifest.presentation: "assets/presentation.json"`. The referenced document has
|
||||
`schema: "asset-presentation@1"`, an optional `player_photo_fallback` asset key,
|
||||
`trophy_fallback` (normally `asset:comp/generic/trophy`), and
|
||||
`youth_photos: {assets: [<photo keys>], selection: "random-on-creation",
|
||||
fallback: <photo key>}`. All keys resolve through the normal asset index. A
|
||||
client supporting youth creation chooses once using its saved game RNG and
|
||||
persists the selected key; it does not reroll a face on display or rename. This
|
||||
document supplies pictures, never player records, ratings or generation rules.
|
||||
Readers without this optional feature retain it and use their existing visual
|
||||
fallbacks. The current editor preserves it without generating youth players.
|
||||
An explicitly indexed player `photo` is displayed before composing a retained
|
||||
`appearance` recipe. A visual overlay can therefore keep Classic appearance and
|
||||
all game data intact while displaying a supplied photo or silhouette. Sealed
|
||||
Classic rendering and runtime capabilities are unaffected.
|
||||
|
||||
**Player pictures** (`asset:player/<key>/photo`) resolve in this order:
|
||||
|
||||
1. A photo from an active pack.
|
||||
2. The player's `appearance` recipe composed from a high-resolution part set (`assets/portrait-sets/<set>/` in a pack, same indices and layer order as the original set, with its own placement table for the larger size).
|
||||
3. The same recipe composed from the original parts of the installation, scaled up.
|
||||
4. A neutral silhouette.
|
||||
|
||||
Composed pictures may be cached in the user's cache directory; they are never written into a world, save or pack.
|
||||
|
||||
### 9.3 Languages
|
||||
|
||||
- Interface texts use gettext `.po` files under `locale/<lang>/openbmh.po` (`msgctxt` for context, plural forms, mature translator tools such as Poedit and Weblate). Message ids are stable English keys.
|
||||
|
||||
@@ -19,7 +19,7 @@ Unless a page says otherwise, integer fields are little endian. Legacy strings u
|
||||
| Audio containers | `S/2000` through `S/2003` | [SOUND](SOUND.md) | `src/audio/container.cpp`, `original.cpp` |
|
||||
| Executable data | German LE and English X-32 images | [LE](LE.md), [executable layout](EXECUTABLE_LAYOUT.md) | `src/formats/le.cpp`, `src/launch/fltd.cpp` |
|
||||
| IFF crest template | `WAPPEN.LBM` | [WAPPEN](WAPPEN.md) | Not loaded by OpenBMH |
|
||||
| OpenBMH world, save and pack | `*.obw`, `*.obs`, `*.obp`, `*.obt` | [OBW](OBW.md), [initial importer](obw/import.md) | `src/import` converts installation data; game integration/save support planned for 0.2 |
|
||||
| OpenBMH world, save and pack (concept) | `*.obw`, `*.obs`, `*.obp`, `*.obt` | [OBW](OBW.md) | Planned for 0.2 |
|
||||
|
||||
German and English editions can share a physical format while differing in text, league contents, executable layout and currency. Select the edition through the supplied installation; do not rename files or patch a save header to simulate another version. Original English V2.20 save import is a separate compatibility limitation from English installation support.
|
||||
|
||||
|
||||
@@ -1,206 +0,0 @@
|
||||
# Classic installation content contract, version 1
|
||||
|
||||
This contract completes the installation import for the two supported Classic
|
||||
mods without making the 0.1 engine consume OBW. It is an additive OBW 1.0
|
||||
extension, guarded by **`requires: ["runtime:classic-v1"]`**. Readers which do not
|
||||
implement it must reject it. The mod IDs are `BMH-classic` and `FLTD-classic`.
|
||||
|
||||
The contract is a bridge for the 0.2 adapter. Core JSON gives stable identities
|
||||
and useful typed projections; `x-classic` retains every remaining content byte
|
||||
and binds initialization semantics to a version. It does not make a legacy cup
|
||||
table into the generic competition engine planned for 0.4. Neither a DOS
|
||||
executable nor an installed game is needed to reconstruct the imported content.
|
||||
|
||||
## Content and precedence
|
||||
|
||||
| Path | Contract |
|
||||
|---|---|
|
||||
| `manifest.json` | Profile `classic-installation-v1`, canonical mod ID, content ownership, season reference and required runtime |
|
||||
| `world/*.json` | Core entities, source squad identities, initialization policies, league/cup projections and rule/calendar projections |
|
||||
| `x-legacy/source-database.json` | Exact master database as hex, with `legacy-source@1.0`; preserves spare slots and packed fields |
|
||||
| `x-legacy/database.json` | Named auxiliary tables and name pools |
|
||||
| `x-legacy/texts.json` | Original text indices, decoded strings and raw bytes |
|
||||
| `x-classic/startup.json` | `classic-startup@1.0`, edition, layout version, initializers, inputs and resource references |
|
||||
| `x-classic/{source,effective}/*.bin` | Original and supported-profile DATA regions, never program code |
|
||||
| `x-classic/{desktop,formation}-seed.bin` | The 864-byte desktop and 1,408-byte formation input records |
|
||||
| `x-classic/text-blob.bin` | Exact text block after its seven-byte source header, including following bytes used by bounded legacy text reads; startup metadata preserves the header |
|
||||
| `assets/classic/resources.json` | Image dimensions/indices/PNG paths, bitmap-font metrics, audio-container chunks and optional artwork |
|
||||
| `assets/classic/palette.json` | All 256 ARGB colors, using the existing verified VGA-DAC expansion |
|
||||
| `assets/index.json` | Logical keys, paths, kind, source and rights metadata |
|
||||
| `assets/portrait-sets/bmh-classic@1/set.json` | Four backgrounds, five ordered layers, individual part keys and placement |
|
||||
| `x-classic/inventory.json` | Every other entry's path, byte count and CRC32 |
|
||||
|
||||
`content_complete: true` means that all content needed by this particular runtime
|
||||
is present. It does not identify a running game, an OBW-capable released client,
|
||||
or a completely generic typed simulation. The adapter must preserve legacy
|
||||
fields it does not otherwise use. Names/appearance/assets in the core projection
|
||||
are the presentation values; original byte names and offsets remain available
|
||||
for Classic initialization and compatibility. An adapter which supports editing
|
||||
ratings, membership or competitions must explicitly apply those changes to its
|
||||
initialization model; blindly replaying the preserved database would ignore them.
|
||||
|
||||
## Data regions
|
||||
|
||||
`openbmh-classic-layout@1` fixes the address layout already documented in
|
||||
`src/formats/executable_layout.hpp` at the introduction of this contract:
|
||||
|
||||
- Common German-layout data: `[0xA0000, 0xC1000)`.
|
||||
- Football Limited only, native English data: `[0x6B000, 0x776A8)`.
|
||||
|
||||
Only these allowlisted regions and four bounded text literals can be reconstructed.
|
||||
The literals are the free-kick, penalty, corner and automatic-taker labels at
|
||||
`0x80CC9`, `0x80CD2`, `0x80CDB`, `0x80CE3`, with bounds 9/9/8/5 bytes including
|
||||
the terminator. They share a German LE code object, so they are extracted as
|
||||
individual strings, never as the containing object. English normalized images
|
||||
retain their existing values (empty where untranslated). All other locations of
|
||||
the compatibility image are zero. DOS headers, program instructions and relocation
|
||||
instructions are excluded. Pointer-valued data remain numbers; they are never executed.
|
||||
|
||||
`effective` is the existing loader's output with `openbmh-supported@1` rules.
|
||||
`source` is the same loaded/translated data before applying that rule profile.
|
||||
English translation still maps the edition's content into the common layout and
|
||||
also retains its native data region. The two copies prevent shared rule
|
||||
normalization from destroying source values. The current supported rule profile
|
||||
is the default for both Classic mods; selecting unpatched rules requires a
|
||||
separately versioned runtime/profile, not a silent behavioral change.
|
||||
|
||||
Raw regions include all content read through the current executable-data API:
|
||||
cup/qualification tables, ladder, prices, training and credit data, stadium
|
||||
configuration, player-generation settings, match parameters, embedded strings,
|
||||
interface atlases/coordinates and audio tables. Some of these remain byte-based
|
||||
compatibility fields rather than final generic rule objects. They are fully
|
||||
preserved, not left to a future re-import from the executable.
|
||||
|
||||
## New-game initialization
|
||||
|
||||
The importer does **not** choose a manager, start a career, simulate a season,
|
||||
consume either game RNG or import an FBM. The adapter receives two seeds, manager
|
||||
choices, level, mode and competition options when starting a new game. It applies
|
||||
these operations in order, retaining the existing engine's arithmetic, packed
|
||||
field behavior and draw sequence:
|
||||
|
||||
| Initializer | Existing semantic operation |
|
||||
|---|---|
|
||||
| `classic-load-seeds@1` | `startup_state`: database/pools, saved static blocks, desktop/formation input, competition pointers and nationality transforms |
|
||||
| `classic-player-ratings@1` | `startup_players`, with edition league structure and original extra-player slots |
|
||||
| `classic-pending-offers@1` | Clear the four pending-offer words to their empty sentinel, as `new_career_before_dialog` |
|
||||
| `classic-markets-and-moods@1` | `new_career_markets_and_moods`: funds/shares, provisional computer-manager names, market history and club moods |
|
||||
| `classic-free-agents@1` | `new_career_players`: ages/skills and release of extra players |
|
||||
| `classic-setup-options@1` | Apply level, mode, duration, manager count, competition/calendar masks, then `career_managers_begin` |
|
||||
| `classic-confirm-managers@1` | `career_add_manager`: name/portrait, identity swaps, ratings, financial/contractual, lineup, stadium and sponsor initialization; then `career_managers_end` |
|
||||
| `classic-season-setup@1` | `career_season_setup` and `career_first_steps`: entrants, international cycle, calendar, tickets, club accounts, player season and shuffled draw positions |
|
||||
|
||||
Extra runtime configuration mirrors `CareerSession`: currency suffix, training-camp
|
||||
data, credit tables/divisor, edition scheduling, message strings and runtime
|
||||
options all come from the imported content/current versioned Classic algorithm.
|
||||
|
||||
The adapter maps `manifest.start_date` to its calendar's season origin. The
|
||||
current 0.1 engine uses a 2026 date label internally; the importer does not change
|
||||
that engine. The installation equivalence test uses the same 2026 origin and
|
||||
identical options/seeds on both paths. Other requested start years are retained
|
||||
as world input for the 0.2 calendar adapter.
|
||||
|
||||
`classic-manager-finance@1`, `classic-player-contract@1` and
|
||||
`classic-stadium@1` are **initialization policies**, not existing contracts,
|
||||
balances or owned stadiums. Finance policies cover 138 league clubs; actual
|
||||
human-manager accounts are created when a manager is assigned. Contract seeds
|
||||
bind every assigned player to the source team with the packed source values.
|
||||
Referees are staff entities; managers and other generated staff get identities
|
||||
when a new game creates them. Stadium entities form the complete name pool.
|
||||
No invented birth date, contract term or zero-capacity stadium fills a gap.
|
||||
|
||||
## Competition and calendar projections
|
||||
|
||||
All nine leagues use the edition's sizes, members and fixture draw-position
|
||||
tables. German regional third divisions remain parallel. The English ten-club
|
||||
fifth tier remains unplayed, with no invented fixture generator.
|
||||
|
||||
All 36 source cup entries remain in the data regions. Entries with a valid
|
||||
competition ID 0–26 are also represented as stages grouped by competition ID;
|
||||
sentinel entries remain data only. Their Classic fields record source entry,
|
||||
flags, next/parallel links, round counts, qualification quota and group number.
|
||||
Slots with `resolver: classic-entry@1` are dynamic fields populated by
|
||||
`classic-season-entrants@1`, not explicit team lists. `teams` records the source
|
||||
stage size and can be zero before initialization. The resolver must implement
|
||||
the current edition's selection and qualification algorithm, including FA Cup
|
||||
qualifying/proper rounds and League Cup for English data, or indoor/Masters for
|
||||
German data. The generic `format` field alone is insufficient to execute a stage.
|
||||
|
||||
For inspection, `classic-season-entrants@1` assigns each first-division champion
|
||||
to the Champions League. A holder in that league also qualifies (or the
|
||||
runner-up if already champion). Domestic cup winners, with finalists as
|
||||
replacements, enter the Cup Winners' Cup. Title-holder overlap affects the
|
||||
remaining allocation. The regular UEFA-Cup quotas are `[4,4,4,4,3]` for source
|
||||
league indices `[0,5,6,7,8]`, taking the next unqualified clubs by rank. Foreign
|
||||
cup representatives follow the Classic selection procedure. The historical
|
||||
`x-legacy.europe_places` field is a prediction/colouring value, not that quota.
|
||||
|
||||
The versioned Classic ladder uses its first four domestic groups. Relegation
|
||||
counts come from each league's `x-legacy.relegation_places`. A single lower
|
||||
league supplies the corresponding top-ranked clubs; parallel lower leagues
|
||||
supply champions plus winners of the Classic playoffs. Without that playoff
|
||||
result only the champions are exchanged. The last domestic group draws from
|
||||
the newcomer pool, never a foreign league named by an unused `below` entry.
|
||||
License withdrawals and the Classic protection of a human manager at the
|
||||
bottom tier can affect the actual result. Foreign Classic leagues have no
|
||||
regular promotion/relegation. These are compatibility policy summaries, not
|
||||
independent typed modern rule declarations or permission to simulate them in
|
||||
the editor.
|
||||
|
||||
`classic-calendar@1` retains the complete source day table and bindings.
|
||||
`classic-season-calendar@1` applies options, season cycle, weekday alignment and
|
||||
leap-year behavior using the Classic calendar algorithm at runtime. Cup series
|
||||
bind calendar bit `competition_id + 5`; league series retain the edition's
|
||||
calendar-group binding. Dated fixtures cannot be exported before manager/options
|
||||
selection without changing the original start semantics.
|
||||
|
||||
## Artwork, portraits, fonts and audio
|
||||
|
||||
Every imported image has an indexed PNG for standard consumers plus a `.pixels`
|
||||
payload for the Classic adapter's exact palette-index operations. Dimensions and
|
||||
palette are explicit. The source VGA files themselves are not required. Crest
|
||||
keys bind stable club identities; the original generic crest is used where the
|
||||
Classic interface deliberately uses a fallback. Kit selectors and the complete
|
||||
relevant sprite sheets remain available.
|
||||
|
||||
`appearance` contains the source-name-derived result, computed with the same
|
||||
signed-byte/unsigned-seed arithmetic as `PlayerCardScreen::draw_portrait`, including
|
||||
its discarded initial draw. It never consumes the game's RNG streams. A rename
|
||||
changes the name, not the recipe. The set stores each part separately, preserving
|
||||
linear source-stride wrap at row edges, transparent index zero, layer order and
|
||||
offsets relative to the 38×38 background. It never stores composed faces.
|
||||
|
||||
Bitmap fonts store glyph locations, widths, advances, original alphabet bounds,
|
||||
baseline and exact bitmap bytes. The zero-width replacement glyph may point
|
||||
beyond the bitmap because it is never dereferenced. These fonts use the Classic
|
||||
byte encoding; new modern interface fonts remain a separate theme concern.
|
||||
|
||||
The four original ALPTRAUM audio containers are local binary assets with chunk
|
||||
metadata, consumed by the already implemented audio decoder. Music keeps its
|
||||
instrument/sequence data rather than being destructively flattened to a recording.
|
||||
Source frequency/operator tables remain in the Classic data regions. Optional
|
||||
FLI/FLC and editor artwork is retained as identified local artwork, without
|
||||
importing editor programs, user settings or saves.
|
||||
|
||||
## Reader, writer and checks
|
||||
|
||||
`bmh::obw::read` accepts ZIP/directory content and validates it. `load_classic`
|
||||
returns the read-only input model (`Database`, data-only `LeImage`, full `TextDb`,
|
||||
desktop/formation seeds, indexed images, palette, fonts and audio) independently
|
||||
of either game frontend. It does not create `GameState` or `CareerSession`.
|
||||
|
||||
Binary payloads are byte strings, not UTF-8 JSON strings. Paths are authored
|
||||
relative forward-slash paths. The reader rejects traversal, duplicate entries,
|
||||
symlinks in a directory, excessive sizes and unknown required profiles. The
|
||||
validator checks cross-references, complete stage/contract bindings, resource
|
||||
shapes, portrait indices and inventory. CRC32 detects accidental damage, not
|
||||
malicious modification. An editor deliberately changing a world must update its
|
||||
inventory (`refresh_classic_inventory`) and validate it before writing.
|
||||
|
||||
The installation test reconstructs from an OBW ZIP, then compares a complete
|
||||
first-season initialization in RAM against the existing legacy-load path:
|
||||
native state bytes and both RNG seeds/counts. It also compares every exported
|
||||
data-region byte and original atlas pixels, palette, fonts and audio. This proves
|
||||
content/startup preservation for the supplied installation and chosen test start;
|
||||
it does not claim an implemented 0.2 adapter, native-platform testing, a fully
|
||||
played season or savegame conversion.
|
||||
@@ -1,160 +0,0 @@
|
||||
# OBW 1.1 editor-world-v1
|
||||
|
||||
This additive profile is a native editing interchange. It does **not** change
|
||||
`classic-installation-v1`, its seals, the Classic runtime or save files.
|
||||
It is implemented by OpenBMH Editor 0.5.x, whose application version is separate
|
||||
from the OBW format version and the OpenBMH 0.2.0 game version.
|
||||
|
||||
## Identification
|
||||
|
||||
```json
|
||||
{
|
||||
"format": "openbmh-world",
|
||||
"format_version": "1.1",
|
||||
"min_reader": "1.1",
|
||||
"kind": "world",
|
||||
"title": {"default": "My world"},
|
||||
"start_date": "2026-07-01",
|
||||
"currency": {"code": "EUR", "minor_units": 2},
|
||||
"requires": ["editor:world-v1"],
|
||||
"extensions": [{"id": "x-editor", "version": "1"}],
|
||||
"x-editor": {"profile": "editor-world-v1", "playable": false}
|
||||
}
|
||||
```
|
||||
|
||||
The required editor capability is deliberately different from
|
||||
`runtime:classic-v1`. An edited world must not be resealed as a Classic world.
|
||||
The display title and a label such as Modern do not grant a runtime capability.
|
||||
On import the editor keeps the original manifest under
|
||||
`x-editor.original_manifest`, leaves compatibility/source regions intact, and
|
||||
requires Save As. An original Classic seal is historical evidence only in this
|
||||
profile. The existing Classic reader/validator is not broadened to accept it.
|
||||
|
||||
## Tables and values
|
||||
|
||||
The existing `world/*.json` and `assets/index.json` structure remains. Each table
|
||||
is an object with `schema` and `items`. Stable `id` identifiers (asset `key`)
|
||||
are references, never array positions. Existing identifiers and unknown fields
|
||||
are preserved. New identifiers have a namespace and opaque suffix.
|
||||
|
||||
The editor adds explicit club `competition`, competition `members` (club IDs),
|
||||
and player `squad_order`. These are the editable projections of Classic league
|
||||
slots/squad rows. Moving a club updates league membership in the same
|
||||
transaction. The historical Classic slots stay source evidence; a future
|
||||
playable format adapter must choose and implement its own generation rules.
|
||||
|
||||
Player `born` can be `null`; an imported `age_at_start` object remains an age,
|
||||
not an invented birth date. `team: null` is an unassigned projection; an
|
||||
`x-editor.membership_unresolved` or `membership_unassigned` marker distinguishes
|
||||
missing/contradictory source facts from a verified free agent. Reported
|
||||
nationalities and sporting eligibility remain separate. No full roster is
|
||||
cut down to the 24 rows of a Classic compatibility view.
|
||||
|
||||
Attribute sets declare their actual numeric ranges in `world/rules.json`:
|
||||
`type: "attribute_set"`, optional `attribute_set` alias, and `fields` mapping
|
||||
attribute names to `{min,max,...}`. The Classic importer declares strength
|
||||
0–99, form/condition/technique/bonus 0–127, skills 0–3. An FC set remains a
|
||||
separate 0–99 system. Missing values are null/absent; `unrated@1` with empty
|
||||
attributes does not invent a rating.
|
||||
|
||||
Competition `trophy` and optional fallback remain logical asset references;
|
||||
images are indexed just like crests and portraits. Arbitrary new competitions
|
||||
can use their own trophy or a package-supplied generic trophy.
|
||||
|
||||
### Read-only comparisons (Editor 0.5.1)
|
||||
|
||||
The editor's `compare` command / `editor_compare` MCP tool projects ratings and
|
||||
salaries without writing an additional OBW table. Player attributes retain their
|
||||
set and range. Club and league attributes are player-weighted means of known
|
||||
values within one set; mixed sets require a filter. Full rosters include reserves,
|
||||
except source evidence explicitly marked
|
||||
`x-simulation.squad_role: "source-only-duplicate"`. League membership uses a club's
|
||||
explicit league, or an unambiguous league `members` reference as fallback.
|
||||
|
||||
`contracts.salary` is per season, in integer `manifest.currency` minor units.
|
||||
Only contracts active on `manifest.start_date` and matching the player's current
|
||||
team count; absent bounds are open and explicit date bounds are inclusive.
|
||||
Multiple matching active contracts are ambiguous, not summed. Missing or invalid
|
||||
salary remains null, independently of an explicit zero. Club/league payrolls
|
||||
exclude staff and use known player salaries only. `salary_known`,
|
||||
`salary_unknown`, `salary_ambiguous`, `salary_complete` and `salary_overflow`
|
||||
describe coverage; a missing/empty/overflowed sum is null. Means of known salaries
|
||||
round to the nearest minor unit. Attribute means separately report their sample
|
||||
sizes in `attribute_counts`. No current date, invented contract or foreign-club
|
||||
strength-band interpretation is substituted for missing data.
|
||||
|
||||
### Read-only regulations (Editor 0.5.2)
|
||||
|
||||
The `regulations` command / `editor_regulations` MCP tool exposes the same
|
||||
read-only projection as the Regulations page. It accepts `language` (de/en),
|
||||
`search`, `nation` and `competition`. It returns `items`, all preserved `rules`,
|
||||
the world date, `read_only: true` and the session revision. It creates no table,
|
||||
edits, undo entries or runtime entrants.
|
||||
|
||||
Each item retains its full `record` and `stages`. Explicit `movement` entries
|
||||
retain rank ranges and destination references; tier comparisons label promotion
|
||||
and relegation, participant roles label playoffs. Competition/stage `slots`
|
||||
retain their full selector, fallback, explicit destination and phase; they are
|
||||
visible on both the source and destination competition. Fixed participant lists
|
||||
are not reinterpreted as qualification rules.
|
||||
|
||||
Imported `classic_runtime.qualifications: classic-season-entrants@1` and
|
||||
`legacy_ladder` records permit a labelled presentation of the existing Classic
|
||||
policy, documented in [classic-v1](classic-v1.md). Explicit declared rules take
|
||||
precedence. Unknown rules stay unspecified; the editor never substitutes modern
|
||||
UEFA quotas or infers qualification from historical colouring fields. This
|
||||
presentation registry does not implement a new season engine.
|
||||
|
||||
Optional `manifest.presentation` references the `asset-presentation@1` visual
|
||||
defaults described in [OBW §9.2](../OBW.md#92-resolution-and-image-formats).
|
||||
Youth pools, silhouette and generic trophy keys remain indexed assets. They are
|
||||
preserved across editor saves, independent of Classic source recipes or seals.
|
||||
|
||||
## Sources, conflicts and images
|
||||
|
||||
- `x-source/` can contain unchanged or losslessly gzipped normalized source
|
||||
tables, input hashes, source-to-projection identifiers and identity evidence.
|
||||
References include package-local file paths and JSON pointers. Sources do
|
||||
not become authoritative merely by being present.
|
||||
- `x-editor/review.json` has `items` with `id`, `reason`, `resolved`, optional
|
||||
`table`, `entity`, `field` (JSON pointer), and `alternatives` with `value` and
|
||||
source descriptions. Choosing a value updates its target plus the review
|
||||
record in one undoable transaction. Original alternatives remain.
|
||||
- Raster and SVG sources are stored unchanged. Identity imports preserve exact
|
||||
bytes. Edits use a normalized recipe: `angle` degrees, `flip_x`, `flip_y`,
|
||||
`crop: {x,y,width,height}`. Mirroring precedes clockwise rotation; rotation
|
||||
expands the canvas; crop coordinates refer to that expanded canvas. Values
|
||||
are finite, crop dimensions positive and inside [0,1]. JSON floating-point
|
||||
values must survive round trips.
|
||||
- An edited asset's `x-editor` stores `original`, `original_sha256` and
|
||||
`transform`. Originals live in `x-editor/originals/`, rendered files in
|
||||
`assets/edited/`, addressed by SHA-256. Raster edits are PNG with transparent
|
||||
expanded edges, SVG edits remain vectors. Import does not upscale portraits.
|
||||
Referenced external SVG resources are refused. Originals and source recipes
|
||||
remain available on re-edit; no repeated destructive resampling is needed.
|
||||
- Portrait part sets and frozen `appearance` recipes remain valid. The editor
|
||||
composes those layers for display; a rename never regenerates the recipe.
|
||||
|
||||
## Container, validation and saving
|
||||
|
||||
ZIP/ZIP64, stored or deflated entries; UTF-8 JSON; package-local paths without
|
||||
absolute paths, `..`, backslashes or symlinks. The editor limits are 100,000
|
||||
entries, 64 MiB per uncompressed entry and 2 GiB total uncompressed bytes. This
|
||||
is independent of the smaller Classic 1.0 reader limits.
|
||||
|
||||
The editor checks identifier uniqueness, typed references, valid dates,
|
||||
declared attribute ranges and assets. Missing facts/source questions are
|
||||
warnings; structural errors block saving. A transaction either validates and
|
||||
commits or is rolled back. `revision` increases monotonically, including
|
||||
undo/redo. Undoing to the saved state clears the dirty flag.
|
||||
|
||||
Unknown entries, extensions, binary assets and untouched table bytes are
|
||||
retained. Large assets remain lazily read from an immutable source snapshot.
|
||||
Saving streams a temporary ZIP and atomically replaces the destination only
|
||||
after finalization. Modified-on-disk sources require Save As. The editor never
|
||||
writes legacy files or a running save.
|
||||
|
||||
The [1.1 editor schema](schema/1.1/editor-world.json) documents structural
|
||||
constraints. Runtime validation additionally resolves cross-table references
|
||||
and rule-declared scales. This is not a claim that the generic world can yet
|
||||
be played by a game engine.
|
||||
@@ -1,158 +0,0 @@
|
||||
# BMH and Football Limited installation converter
|
||||
|
||||
`openbmh_import` imports the content of a supported, locally supplied installation
|
||||
as **BMH-classic** or **FLTD-classic**. Football Limited's executable is named
|
||||
`FLTD.EXE`; the spellings `FTDL-classic` and `FTLD-classic` are accepted as CLI
|
||||
aliases and written as `FLTD-classic`.
|
||||
|
||||
The output is an `.obw` ZIP, or an equivalent directory. It contains the complete
|
||||
**Classic installation content**, including graphics, portrait parts, fonts,
|
||||
audio and the original data tables. It contains no running career or executable.
|
||||
The existing 0.1 game does not read OBW. The 0.2 development branch implements the
|
||||
versioned [Classic contract](classic-v1.md) through its
|
||||
[native runtime and launcher](runtime-0.2.md). This remains separate from
|
||||
migrating every engine rule to the future generic model.
|
||||
|
||||
## Build and use
|
||||
|
||||
Configure as described in [BUILDING](../../BUILDING.md), then:
|
||||
|
||||
```sh
|
||||
cmake --build build --config Release --target openbmh_import
|
||||
./build/openbmh_import --data "path/to/BMH" --output "BMH-classic.obw" \
|
||||
--start-date 2026-07-01 --mod BMH-classic
|
||||
./build/openbmh_import --data "path/to/FLTD.EXE" --output "FLTD-classic.obw" \
|
||||
--start-date 1995-07-01 --mod FLTD-classic
|
||||
./build/openbmh_import --validate "BMH-classic.obw"
|
||||
```
|
||||
|
||||
On a Visual Studio multi-configuration build use
|
||||
`build\Release\openbmh_import.exe`. `--mod` is optional: the tool detects the
|
||||
edition. A mismatching explicit mod is an error. `--title TEXT` changes the
|
||||
world's display title. `--directory` writes an unpacked world, which `--validate`
|
||||
can read too. The source may be an installation directory, its executable, or a
|
||||
parent with exactly one installation. File discovery ignores case. If both game
|
||||
executables exist, select the intended executable explicitly.
|
||||
|
||||
A full import requires the same installation resources as the current launcher:
|
||||
master database, text database, executable, `M3.MEN`, `M3.DAT`, palette, required
|
||||
`KB`/`W` pictures, two fonts and four sound banks. A missing resource is an error.
|
||||
Supported inputs are the German CD-family editions and Football Limited; the
|
||||
1994 floppy `M3.EXE`/`M3PC.MAN` family and Amiga installations are not supported.
|
||||
Source ZIP/7z and `.FBM` files are not input formats for this tool.
|
||||
|
||||
The date must be July 1 of an explicit year (1900–9998). Master data contain
|
||||
ages without an unambiguous season year; the converter never uses today's date
|
||||
or invents birth dates. Player age is recorded as `age_at_start`. Calendar setup
|
||||
remains a Classic runtime operation using the selected season/options.
|
||||
|
||||
Existing destinations, including symlinks, are refused. The parent directory
|
||||
must exist. The tool stages and validates output before publishing by rename;
|
||||
source files are read only. Do not run competing writers for one destination.
|
||||
|
||||
## What a Classic world contains
|
||||
|
||||
The manifest names `mod: BMH-classic` or `FLTD-classic`, profile
|
||||
`classic-installation-v1`, `requires: ["runtime:classic-v1"]` and
|
||||
`content_license: local-import-only`. `content_complete: true` means all inputs
|
||||
for that **specific Classic runtime** are present. It does not claim that the
|
||||
0.1 client can load OBW or that every rule has already been migrated to a generic
|
||||
0.2/0.4 schema. A reader without `runtime:classic-v1` must refuse the world.
|
||||
|
||||
| Area | Contents |
|
||||
|---|---|
|
||||
| Nations and teams | All named clubs/national teams, nine leagues, amateur pool, foreign nation blocks, encoded strength band/style, crest and kit selectors |
|
||||
| Players | All 2,574 identities, squads, raw words/flags, attributes, age reference, nationality and frozen portrait recipe |
|
||||
| Staff | Referee names, properties and strictness; human/computer manager setup is a runtime initializer |
|
||||
| Contracts and finance | Contract seeds per assigned player and finance policies for all 138 league clubs; actual values are created by the same manager/season initialization as today |
|
||||
| Stadiums | Entire name pool and stadium initializer, with all building, capacity, price and facility tables retained in Classic data regions |
|
||||
| Competitions | Nine league definitions and fixture generators, plus every configured cup-table stage with links, flags, group/qualifying information and runtime participant resolvers |
|
||||
| Calendar and rules | Day table, league bindings, cup series, ladder, training camps, credit factors, initialization sequence and all remaining data-region content |
|
||||
| Text | UTF-8 original gettext layer, indexed strings, raw text blob and embedded executable-data texts |
|
||||
| Artwork | Every numeric `KB/*.VGA` and `W/*.VGA` decoded as indexed PNG plus exact pixel indices; crest crops, original palette, portrait parts, bitmap fonts |
|
||||
| Audio and optional art | Four original audio containers with chunk descriptors; optional FLI/FLC animation and WAPPEN.LBM when present |
|
||||
| Preservation | Exact master-database bytes, named auxiliary tables/pools, original and effective data regions, resource metadata and CRC32 inventory |
|
||||
|
||||
A source database does **not** contain ready-made human-manager finances,
|
||||
contracts or stadium capacities. Those depend on the selected club, game level,
|
||||
mode and random seeds. The world specifies their initialization rather than
|
||||
inventing a balance, contract term or stadium owner. Imported player attributes
|
||||
are the master seeds; the existing Classic initialization changes ratings and
|
||||
ages and can shuffle club draw positions. This consumes no RNG during import.
|
||||
|
||||
Player `appearance` is computed from the **raw legacy byte name**, before Unicode
|
||||
conversion. It freezes the background and five layer indices once. Name overlays
|
||||
must retain this field. The imported set stores individual transparent parts and
|
||||
placement metadata; composed player faces are never stored. Packed atlas parts
|
||||
which cross a source row boundary retain their original pixels.
|
||||
|
||||
The effective data use OpenBMH's existing supported rule profile. Unpatched
|
||||
source data are preserved separately, including Football Limited's native data
|
||||
segment. Neither copy includes a DOS header, executable code or relocation
|
||||
instructions. `x-classic` is a documented compatibility bridge, not a claim that
|
||||
the current address-based engine has already been replaced.
|
||||
|
||||
## Stable identities and original encodings
|
||||
|
||||
IDs derive from master identity slots: `club:00000`, `player:00000`,
|
||||
`stadium:00000`; national teams use `nt:<nation-key>`. Recognized countries get
|
||||
ISO keys, with private association keys for England/Scotland/Wales/Northern
|
||||
Ireland. Unrecognized/duplicate country labels retain `nation:x-legacy-<index>`
|
||||
and a report warning, preserving modded or historical identities.
|
||||
|
||||
Foreign club indices 168–356 form 27 blocks of seven teams corresponding to
|
||||
nation slots 5–31. The nine league ranges retain their edition-specific sizes:
|
||||
German 18/18/18/18/18 and four 12-team leagues; English 20/20/20/20/10 and four
|
||||
12-team leagues. The English fifth division is an unplayed pool; no ten-team
|
||||
fixture generator is invented. Unnamed English amateur slots remain in the
|
||||
preserved source rather than becoming fabricated clubs.
|
||||
|
||||
Text follows ISO 646-DE substitutions and preserves extended bytes as Latin-1
|
||||
Unicode code points; raw bytes remain available. Player names are kept whole in
|
||||
`name.last`, without guessing first/last-name splits. Fixture tables describe
|
||||
draw positions; qualified participants and final fixtures are resolved at the
|
||||
same initialization phase as in the Classic engine.
|
||||
|
||||
## Validation and verification
|
||||
|
||||
`--validate` checks the profile, versions, safe paths, unique entity/asset IDs,
|
||||
core references, squad/stage counts, complete cup bindings, contract ownership,
|
||||
initialization contract, media shapes, portrait indices, resource files and the
|
||||
inventory before accepting a world. Complete imports also carry a SHA-256 seal,
|
||||
verified by this tool when present and required by the 0.2 Classic runtime.
|
||||
ZIP and directory readers enforce size
|
||||
limits; directory symlinks and injected `state/` content are rejected. CRC32
|
||||
catches accidental damage; it is not a signature or proof of trustworthy content.
|
||||
This is the Classic profile validator, not a general competition engine or a full
|
||||
JSON Schema implementation. Draft 2020-12 schemas are provided for external tools.
|
||||
|
||||
`obw_import_tests` uses synthetic data to cover both editions, binary round trips,
|
||||
frozen appearances, malformed input and damaged payloads. With `BMH_DATA`,
|
||||
`obw_classic_installation_tests` imports an installation, writes/reopens its ZIP,
|
||||
reconstructs the startup inputs without reading the source again, and compares
|
||||
first-season initialization bytes and both RNG streams. It also compares data
|
||||
regions, atlas pixels, palette, fonts and audio against the source. The same test
|
||||
can be run with a Football Limited directory as its argument. It does not test
|
||||
OBW integration in a released client or a complete played season.
|
||||
|
||||
## Partial development export
|
||||
|
||||
`--database-only` deliberately retains the previous `legacy-database-v1` export
|
||||
for database investigations without media. Its manifest remains
|
||||
`playable: false`, requires `import:legacy-database-v1`, and its report lists gaps.
|
||||
It is **not** one of the completed Classic mods. Default imports never silently
|
||||
fall back to this mode.
|
||||
|
||||
## Rights and excluded data
|
||||
|
||||
All imported content remains local and retains its original ownership. Do not
|
||||
publish generated worlds or assets without appropriate rights. Public tests and
|
||||
schemas contain only independently authored implementation and synthetic data.
|
||||
|
||||
The standalone installation converter does not migrate careers or personal
|
||||
settings. The 0.2 launcher separately migrates supported `.FBM`, `.EIN` and `.MEN`
|
||||
files into native personal files; see its [migration contract](runtime-0.2.md).
|
||||
`SOUND.CFG`, high scores, backups, editor/program executables and external manuals
|
||||
are not imported. In-game readme content is retained when available. Manager
|
||||
choices and career RNG state belong to a new game or `.obs` save, not to this
|
||||
installation conversion.
|
||||
@@ -1,107 +0,0 @@
|
||||
<!-- 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
|
||||
RmlUI 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]
|
||||
assets/launcher/*
|
||||
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.
|
||||
|
||||
RML/RCSS define the launcher and its import, rename, delete and progress dialogs.
|
||||
Only folder selection uses an OS dialog. The SDL2/OpenGL view keeps UI resources
|
||||
relative to the executable, supports resizing and HiDPI input, and sleeps between
|
||||
input or scheduled UI updates. The running child's match engine does not depend on
|
||||
RmlUI. OpenGL 3.3 is required for the launcher (4.1 on macOS).
|
||||
|
||||
## 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.
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/asset-index.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "asset-index@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"pattern": "^asset:"
|
||||
},
|
||||
"files": {
|
||||
"type": "object",
|
||||
"minProperties": 1,
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"source": {
|
||||
"type": "string"
|
||||
},
|
||||
"author": {
|
||||
"type": "string"
|
||||
},
|
||||
"license": {
|
||||
"const": "local-import-only"
|
||||
},
|
||||
"kind": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key",
|
||||
"files",
|
||||
"source",
|
||||
"author",
|
||||
"license",
|
||||
"kind"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -1,58 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/calendar.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "calendar@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^calendar:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"season_start": {
|
||||
"const": "07-01"
|
||||
},
|
||||
"series": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"legacy_calendar_bit": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 31
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"legacy_calendar_bit"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"season_start",
|
||||
"series"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,402 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-inventory.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-inventory@1.0"
|
||||
},
|
||||
"entries": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"type": "string"
|
||||
},
|
||||
"bytes": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"crc32": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"path",
|
||||
"bytes",
|
||||
"crc32"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"entries"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-palette.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-palette@1.0"
|
||||
},
|
||||
"argb": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 256,
|
||||
"maxItems": 256
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"argb"
|
||||
]
|
||||
}
|
||||
@@ -1,200 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-resources.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-resources@1.0"
|
||||
},
|
||||
"images": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
},
|
||||
"height": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
},
|
||||
"pixels": {
|
||||
"type": "string"
|
||||
},
|
||||
"png": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"width",
|
||||
"height",
|
||||
"pixels",
|
||||
"png"
|
||||
]
|
||||
}
|
||||
},
|
||||
"fonts": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"baseline": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"nominal_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"flags": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"lo_char": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hi_char": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"modulo": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"bitmap": {
|
||||
"type": "string"
|
||||
},
|
||||
"glyphs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"bit_offset": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"bit_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"advance": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"bit_offset",
|
||||
"bit_width",
|
||||
"advance"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"height",
|
||||
"baseline",
|
||||
"nominal_width",
|
||||
"flags",
|
||||
"lo_char",
|
||||
"hi_char",
|
||||
"modulo",
|
||||
"glyphs",
|
||||
"bitmap"
|
||||
]
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"audio": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
},
|
||||
"codec": {
|
||||
"const": "original-alptraum@1"
|
||||
},
|
||||
"chunks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"offset": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"offset",
|
||||
"size"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"path",
|
||||
"codec",
|
||||
"chunks"
|
||||
]
|
||||
},
|
||||
"minItems": 4,
|
||||
"maxItems": 4
|
||||
},
|
||||
"optional": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"path"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"images",
|
||||
"fonts",
|
||||
"audio",
|
||||
"optional"
|
||||
]
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,72 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,189 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-startup.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-startup@1.0"
|
||||
},
|
||||
"layout": {
|
||||
"const": "openbmh-classic-layout@1"
|
||||
},
|
||||
"mod": {
|
||||
"enum": [
|
||||
"BMH-classic",
|
||||
"FLTD-classic"
|
||||
]
|
||||
},
|
||||
"english": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported@1"
|
||||
},
|
||||
"data_regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"base": {
|
||||
"type": "integer"
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"base",
|
||||
"size",
|
||||
"path"
|
||||
]
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 2
|
||||
},
|
||||
"source_regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"base": {
|
||||
"type": "integer"
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"base",
|
||||
"size",
|
||||
"path"
|
||||
]
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 2
|
||||
},
|
||||
"desktop_seed": {
|
||||
"type": "string"
|
||||
},
|
||||
"formation_seed": {
|
||||
"type": "string"
|
||||
},
|
||||
"text_blob": {
|
||||
"type": "string"
|
||||
},
|
||||
"initializers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"minItems": 8,
|
||||
"maxItems": 8
|
||||
},
|
||||
"runtime_inputs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"rng": {
|
||||
"type": "object"
|
||||
},
|
||||
"embedded_literals": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"address": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bytes_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})+$"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"address",
|
||||
"bytes_hex"
|
||||
]
|
||||
}
|
||||
},
|
||||
"source_literals": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"address": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bytes_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})+$"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"address",
|
||||
"bytes_hex"
|
||||
]
|
||||
}
|
||||
},
|
||||
"text_header": {
|
||||
"type": "array",
|
||||
"minItems": 7,
|
||||
"maxItems": 7,
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"layout",
|
||||
"mod",
|
||||
"english",
|
||||
"rule_profile",
|
||||
"data_regions",
|
||||
"source_regions",
|
||||
"desktop_seed",
|
||||
"formation_seed",
|
||||
"text_blob",
|
||||
"initializers",
|
||||
"runtime_inputs",
|
||||
"rng",
|
||||
"embedded_literals",
|
||||
"source_literals",
|
||||
"text_header"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -1,542 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/clubs.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "clubs@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"type": {
|
||||
"enum": [
|
||||
"club",
|
||||
"national",
|
||||
"amateur",
|
||||
"foreign"
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"nation": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"stadium": {
|
||||
"type": "string",
|
||||
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"strength": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"name",
|
||||
"nation"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/common.json",
|
||||
"$defs": {
|
||||
"localized": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"default"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"nation_id": {
|
||||
"type": "string",
|
||||
"pattern": "^nation:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"team_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(club|nt):[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"person_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(player|staff):[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"date": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
|
||||
},
|
||||
"attributes": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,171 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/competitions.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "competitions@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^comp:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"type": {
|
||||
"enum": [
|
||||
"league",
|
||||
"cup",
|
||||
"club_international",
|
||||
"national_team",
|
||||
"friendly",
|
||||
"indoor"
|
||||
]
|
||||
},
|
||||
"nation": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"tier": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"played": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"stages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"format": {
|
||||
"enum": [
|
||||
"league",
|
||||
"groups",
|
||||
"knockout",
|
||||
"final",
|
||||
"playoff"
|
||||
]
|
||||
},
|
||||
"teams": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"legs": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"generator": {
|
||||
"type": "string"
|
||||
},
|
||||
"matchdays": {
|
||||
"type": "string"
|
||||
},
|
||||
"slots": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"teams": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"uniqueItems": true
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"teams"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"resolver": {
|
||||
"const": "classic-entry@1"
|
||||
},
|
||||
"entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 35
|
||||
},
|
||||
"count": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"resolver",
|
||||
"entry",
|
||||
"count"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"format",
|
||||
"teams",
|
||||
"legs",
|
||||
"slots"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"trophy": {
|
||||
"type": "string",
|
||||
"pattern": "^asset:comp/(?!\\.{1,2}/)[a-zA-Z0-9._-]+/trophy$",
|
||||
"description": "Optional presentation key; default is asset:comp/<competition key>/trophy. Missing artwork resolves to asset:comp/generic/trophy and then a built-in neutral trophy icon."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"type",
|
||||
"played",
|
||||
"stages"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"type": {
|
||||
"const": "league"
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"nation",
|
||||
"tier"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/contracts.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "contracts@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^contract:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"person": {
|
||||
"$ref": "common.json#/$defs/person_id"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"salary": {
|
||||
"type": "integer"
|
||||
},
|
||||
"start": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"end": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"person",
|
||||
"team"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/finance.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "finance@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^finance:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"balance": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"team"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,235 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/manifest.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"const": "openbmh-world"
|
||||
},
|
||||
"format_version": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"kind": {
|
||||
"const": "world"
|
||||
},
|
||||
"min_reader": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"title": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"generator": {
|
||||
"type": "string"
|
||||
},
|
||||
"provenance": {
|
||||
"enum": [
|
||||
"import:bmh-de",
|
||||
"import:fltd"
|
||||
]
|
||||
},
|
||||
"content_license": {
|
||||
"const": "local-import-only"
|
||||
},
|
||||
"currency": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string"
|
||||
},
|
||||
"minor_units": {
|
||||
"const": 0
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"code",
|
||||
"minor_units"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"start_date": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"languages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"limits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"leagues": {
|
||||
"const": 32
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"leagues"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"requires": {
|
||||
"oneOf": [
|
||||
{
|
||||
"const": [
|
||||
"import:legacy-database-v1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"const": [
|
||||
"runtime:classic-v1"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"extensions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"version"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"x-import": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "legacy-database-v1"
|
||||
},
|
||||
"playable": {
|
||||
"const": false
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported"
|
||||
},
|
||||
"default_attribute_set": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"profile",
|
||||
"playable",
|
||||
"rule_profile"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "classic-installation-v1"
|
||||
},
|
||||
"content_complete": {
|
||||
"const": true
|
||||
},
|
||||
"runtime": {
|
||||
"const": "runtime:classic-v1"
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported@1"
|
||||
},
|
||||
"source_rules_preserved": {
|
||||
"const": true
|
||||
},
|
||||
"default_attribute_set": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"default_portrait_set": {
|
||||
"const": "bmh-classic@1"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"profile",
|
||||
"content_complete",
|
||||
"runtime",
|
||||
"rule_profile",
|
||||
"source_rules_preserved",
|
||||
"default_attribute_set",
|
||||
"default_portrait_set"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"mod": {
|
||||
"enum": [
|
||||
"BMH-classic",
|
||||
"FLTD-classic"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"format",
|
||||
"format_version",
|
||||
"kind",
|
||||
"min_reader",
|
||||
"title",
|
||||
"generator",
|
||||
"provenance",
|
||||
"content_license",
|
||||
"currency",
|
||||
"start_date",
|
||||
"languages",
|
||||
"limits",
|
||||
"requires",
|
||||
"extensions",
|
||||
"x-import"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles.",
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"requires": {
|
||||
"const": [
|
||||
"runtime:classic-v1"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"id",
|
||||
"mod"
|
||||
],
|
||||
"properties": {
|
||||
"x-import": {
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "classic-installation-v1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"else": {
|
||||
"properties": {
|
||||
"x-import": {
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "legacy-database-v1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/nations.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "nations@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^nation:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"confederation": {
|
||||
"enum": [
|
||||
"uefa",
|
||||
"conmebol",
|
||||
"caf",
|
||||
"afc",
|
||||
"concacaf",
|
||||
"ofc",
|
||||
"other"
|
||||
]
|
||||
},
|
||||
"national_team": {
|
||||
"type": "string",
|
||||
"pattern": "^nt:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"playable": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"confederation"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,153 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/players.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "players@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^player:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"first": {
|
||||
"type": "string"
|
||||
},
|
||||
"last": {
|
||||
"type": "string"
|
||||
},
|
||||
"known_as": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"first",
|
||||
"last"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"born": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"age_at_start": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"years": {
|
||||
"type": "integer",
|
||||
"minimum": 16,
|
||||
"maximum": 47
|
||||
},
|
||||
"on": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"years",
|
||||
"on"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"nationalities": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"positions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"enum": [
|
||||
"gk",
|
||||
"def",
|
||||
"mid",
|
||||
"fwd"
|
||||
]
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"attribute_set": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"attributes": {
|
||||
"$ref": "common.json#/$defs/attributes"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"appearance": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"set": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z][a-z0-9-]*@[0-9]+$"
|
||||
},
|
||||
"background": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"layers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"set",
|
||||
"background",
|
||||
"layers"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"nationalities",
|
||||
"positions",
|
||||
"attribute_set",
|
||||
"attributes"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"oneOf": [
|
||||
{
|
||||
"required": [
|
||||
"born"
|
||||
],
|
||||
"not": {
|
||||
"required": [
|
||||
"age_at_start"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"required": [
|
||||
"age_at_start"
|
||||
],
|
||||
"not": {
|
||||
"required": [
|
||||
"born"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/portrait-set.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "portrait-set@1.0"
|
||||
},
|
||||
"id": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"width": {
|
||||
"const": 38
|
||||
},
|
||||
"height": {
|
||||
"const": 38
|
||||
},
|
||||
"transparent_index": {
|
||||
"const": 0
|
||||
},
|
||||
"backgrounds": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"asset": {
|
||||
"type": "string"
|
||||
},
|
||||
"x": {
|
||||
"type": "integer"
|
||||
},
|
||||
"y": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"asset",
|
||||
"x",
|
||||
"y"
|
||||
]
|
||||
}
|
||||
},
|
||||
"layers": {
|
||||
"type": "array",
|
||||
"minItems": 5,
|
||||
"maxItems": 5,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"x": {
|
||||
"type": "integer"
|
||||
},
|
||||
"y": {
|
||||
"type": "integer"
|
||||
},
|
||||
"parts": {
|
||||
"type": "array",
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"x",
|
||||
"y",
|
||||
"parts"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"id",
|
||||
"width",
|
||||
"height",
|
||||
"backgrounds",
|
||||
"layers",
|
||||
"transparent_index"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/rules.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "rules@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
{
|
||||
"$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
|
||||
}
|
||||
@@ -1,52 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/stadiums.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "stadiums@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"owner": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
},
|
||||
"capacity": {
|
||||
"type": "object"
|
||||
},
|
||||
"facilities": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/staff.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "staff@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^staff:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"role": {
|
||||
"type": "string"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"role"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://openbmh.org/schema/1.1/editor-world.json",
|
||||
"title": "OBW 1.1 editor-world-v1 manifest",
|
||||
"type": "object",
|
||||
"required": ["format", "format_version", "min_reader", "kind", "title", "requires", "x-editor"],
|
||||
"properties": {
|
||||
"format": {"const": "openbmh-world"},
|
||||
"format_version": {"const": "1.1"},
|
||||
"min_reader": {"const": "1.1"},
|
||||
"kind": {"const": "world"},
|
||||
"title": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": {"type": "string"}}]},
|
||||
"start_date": {"type": "string", "format": "date"},
|
||||
"requires": {"type": "array", "contains": {"const": "editor:world-v1"}, "items": {"type": "string"}},
|
||||
"x-editor": {
|
||||
"type": "object", "required": ["profile", "playable"],
|
||||
"properties": {"profile": {"const": "editor-world-v1"}, "playable": {"const": false}},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true,
|
||||
"$defs": {
|
||||
"table": {"type": "object", "required": ["schema", "items"], "properties": {"schema": {"type": "string"}, "items": {"type": "array", "items": {"type": "object"}}}, "additionalProperties": true},
|
||||
"transform": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"angle": {"type": "number", "minimum": -360, "maximum": 360},
|
||||
"flip_x": {"type": "boolean"}, "flip_y": {"type": "boolean"},
|
||||
"crop": {"type": "object", "properties": {
|
||||
"x": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "number", "minimum": 0, "maximum": 1},
|
||||
"width": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}, "height": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}
|
||||
}, "additionalProperties": true}
|
||||
}, "additionalProperties": true
|
||||
},
|
||||
"review": {"type": "object", "required": ["id", "reason", "resolved", "alternatives"], "properties": {
|
||||
"id": {"type": "string", "minLength": 1}, "reason": {"type": "string"}, "resolved": {"type": "boolean"},
|
||||
"table": {"type": "string"}, "entity": {"type": "string"}, "field": {"type": "string", "pattern": "^/"},
|
||||
"alternatives": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": true}}
|
||||
}, "additionalProperties": true}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user