Files
Dreierpack-Manager/docs/formats/FBM.md
T
2026-11-01 19:39:44 +01:00

70 lines
4.7 KiB
Markdown

# Savegame container: `.FBM`
`src/formats/fbm.cpp` reads the outer container. `src/formats/savestate.cpp` splits the decoded state; `src/game/save.cpp` writes the normal save representation. Saving goes through `CareerSession` so the manager, phase and committed state are validated.
## Container layout
| Part | Size | Meaning |
|---|---|---|
| Plain header | Variable | Manager/date information for the load list |
| Signature area | 10 bytes | Eight-byte `KRON_FBM` signature and two following bytes |
| First ID | u32 | Container identifier |
| Version | 6 bytes | NUL-terminated version field, `V2.24` or the verified Diamond `V3.7` marker for this state layout |
| Second ID | u32 | Save identifier |
| Random byte | u8 | Header value |
| Initial key | u8 | Rolling-cipher seed |
| Stream | Remaining bytes except checksum | Encrypted state and name pools |
| Checksum | u8 | Initial key plus all decoded stream bytes, modulo 256 |
The loader searches for the signature after the plain header and checks the fixed fields fit. A bad checksum is represented by `Savegame::checksum_ok`; callers must decide whether to accept the save. Neither the cipher nor this checksum provides security or authenticity.
For each byte, decrypt with `plain = (encrypted - key) XOR key`, or encrypt with `encrypted = (plain XOR key) + key`. Reduce all byte arithmetic modulo 256, then subtract `0x29` from the key before the next byte.
## Decoded stream
The supported layout contains a fixed ordered block table, followed by four name pools. Blocks have no tags or encoded lengths. Their sizes depend on the layout and database counts; `kBlocks` in `src/formats/savestate.cpp` is the authoritative order. Some blocks describe fixed arrays and others hold the contents of legacy dynamically allocated tables. The final optional team-record block is present only when its saved presence field is nonzero.
Each name pool has a u16 byte length followed by that many bytes, in club, player, referee and stadium order. These pools preserve renamed entities. The splitter rejects missing/truncated blocks or pools and requires exact stream consumption. See [STATE](STATE.md) for interpreted records and [M3D](M3D.md) for pool references.
## Optional OpenBMH state
After the four name pools, OpenBMH can append `OBMHEXT1`, a u16 block count,
then each block as a u32 identifier, u32 byte length and payload. There is at
most one such container and the decoder requires exact consumption of it.
Original saves have no container. The entire extension is included in the outer
rolling cipher and checksum.
Known OpenBMH-owned sections include:
| Identifier | Payload | Purpose |
|---|---|---|
| `OBLC` (`0x4f424c43`) | Versioned variable-length archive | [Long-career player counters and title winners](LONG_CAREER.md) |
| `BRM1` (`0x314d5242`) | Four little-endian u32 month-start keys (16 bytes) | Per-manager monthly high-cash robbery guard |
A robbery key is the absolute first day of the last blocked source-calendar
month. `UINT32_MAX` means unknown. An unknown high-cash history receives a
first qualifying grace month; later deductions can occur at most once per
calendar month. Managers have independent keys. A truncated or duplicate BRM1
section is rejected before game state is published.
These identifiers describe OpenBMH-owned payloads, not original executable
addresses. The container can also hold explicitly supported compatibility blocks,
such as edition-specific cup state. Unrecognized payloads are not a general
persistence API. Original programs and older OpenBMH writers may reject or
discard optional information: keep a backup before opening a new save with them.
## Edition compatibility
Diamond 3.7 uses the `V3.7` container label with the verified German V2.24 state
layout. Career loading, saved-desktop/preparation import and browser information
accept that exact label as well as `V2.24`. The checksum, full block/pool structure
and installed edition's database dimensions are still required. An accepted
version label cannot make a malformed or mismatched state valid. Ordinary
OpenBMH native saves continue to use the canonical `V2.24` output marker.
Unknown labels are rejected separately from checksum failures.
Original Football Limited V2.20 saves use a different state block list despite sharing the signature and rolling cipher. They are not interchangeable with the V2.24 layout. Reading an English installation and importing its original saves are separate features; do not edit a version string to bypass the distinction. OpenBMH's own English careers use the session's supported save representation.
Keep a backup before using a save with another engine version. Unknown bytes retained for compatibility are not safe targets for direct client manipulation.