Import the secured game, modern interface and editor history (by Codex)
This commit is contained in:
commit
a4187191dc
1377 files changed
+324133
-1
No files matched your search
@@ -0,0 +1,54 @@
|
||||
# Building OpenBMH
|
||||
|
||||
Requirements: a C++20 compiler, CMake 3.24 or newer, Git and a supported build tool such as Ninja. The CMake project fetches pinned SDL2, miniz, 7-Zip C decoder, nativefiledialog-extended, RmlUi and FreeType sources. Network access is needed on the first configure unless these dependencies are supplied locally. Nuked OPL3 is included in the source tree.
|
||||
|
||||
```sh
|
||||
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build build
|
||||
ctest --test-dir build --output-on-failure
|
||||
```
|
||||
|
||||
The public checkout does not include game data. Tests that require a game installation are conditional; configure with `-DBMH_DATA="path/to/game"` to make locally available data eligible. Private saved-game fixtures are not supplied by the project. Read the test output to distinguish executed and skipped checks.
|
||||
|
||||
Main programs are `OpenBMH` (native launcher and graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
|
||||
|
||||
## Windows
|
||||
|
||||
Use an MSVC environment with C++20 support and its Windows SDK, or another toolchain explicitly supported by the project's build configuration. From a Developer PowerShell with CMake and Ninja available:
|
||||
|
||||
```powershell
|
||||
cmake -S . -B build-windows -G Ninja -DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build build-windows
|
||||
ctest --test-dir build-windows --output-on-failure
|
||||
```
|
||||
|
||||
With a Visual Studio generator, choose one actually provided by your installed CMake and add `--config Release` / `-C Release` to build and test commands. Native file dialogs and runtime-library deployment require the platform SDK and package-specific checks.
|
||||
|
||||
## Linux
|
||||
|
||||
Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the folder-dialog backend. The RmlUI launcher uses SDL2/OpenGL; its native folder picker uses GTK3 on Linux. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config`, `libgl1-mesa-dev` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries. RmlUI and FreeType are built from pinned sources without installing them separately. Keep the generated `assets/launcher` directory alongside OpenBMH when copying a development build.
|
||||
|
||||
The common commands above build the bundled SDL2. To use an installed SDL2 CMake package instead, configure with `-DBMH_USE_SYSTEM_SDL2=ON`. Its version and backend configuration then come from the installed package.
|
||||
|
||||
## macOS
|
||||
|
||||
Apple's **Command Line Tools are sufficient** for the compiler and SDK; the full Xcode application is not a prerequisite for a command-line build. Install the tools with `xcode-select --install`, and install CMake and Ninja separately. On an Apple Silicon machine:
|
||||
|
||||
```sh
|
||||
cmake -S . -B build-macos -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=arm64
|
||||
cmake --build build-macos
|
||||
ctest --test-dir build-macos --output-on-failure
|
||||
```
|
||||
|
||||
Use native toolchain/dependency architectures consistently. A terminal executable and a Finder-launchable, signed `.app` package are different deliverables. The commands describe the build procedure, not a claim that a particular Windows or macOS binary has passed native acceptance.
|
||||
|
||||
## Import and run your data
|
||||
|
||||
Start the native launcher, choose **Add**, and select your original installation. Content and personal files are portable beside the executable. The original installation is needed only for import. See the [0.2 contract](formats/obw/runtime-0.2.md).
|
||||
|
||||
```sh
|
||||
build/OpenBMH
|
||||
build/openbmh_cli --console --mod "build/mods/BMH-classic/content.obw" --seed 1
|
||||
```
|
||||
|
||||
For redistribution, include [LICENSE](../LICENSE), [THIRD_PARTY_NOTICES.md](../THIRD_PARTY_NOTICES.md), the full texts in [licenses/](licenses/README.md), and the corresponding source and build information required by the applicable licenses. Inspect the actual libraries in each platform package; static SDL2 alone does not establish that every dependency is static.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Platform notes
|
||||
|
||||
[BUILDING.md](BUILDING.md) contains Windows, Linux and macOS build commands. C++20, CMake and platform SDKs are required. macOS command-line builds need Apple's Command Line Tools, not the complete Xcode application.
|
||||
|
||||
A successful cross-build, source review or Linux run does not establish a native Windows/macOS result. Release notes must state which packaged platforms were actually validated. Packaging is separate from compilation: check runtime dependencies, writable save directories, file dialogs, Unicode paths, display scaling and audio on the target platform.
|
||||
|
||||
On macOS an unsigned terminal executable does not automatically provide Finder integration, an application bundle or notarisation. On Windows a statically built SDL2 does not remove the need to check compiler runtimes. System-library builds inherit the versions and backend choices of their installed dependencies.
|
||||
|
||||
All packages require the user's game data. No platform package may include original executables or extracted resources. See [third-party notices](../THIRD_PARTY_NOTICES.md) for distribution material.
|
||||
@@ -0,0 +1,53 @@
|
||||
# Console syntax and responses
|
||||
|
||||
The console runs command blocks against one career session. Start it with `openbmh_cli --console --data "path/to/game" --saves "path/to/saves"`. This language is distinct from the narrower JSON request protocol used without `--console`.
|
||||
|
||||
## Input
|
||||
|
||||
Put one command on each line and finish the block with `go.` on a line of its own. `clear.` discards an unexecuted block. Blank lines and lines beginning with `//` are ignored. Commands execute in order; a failure stops the remaining commands. Earlier successful actions remain committed: a block is not one transaction.
|
||||
|
||||
Command syntax is `[@player] Name(argument, name=value)`. The player prefix uses seats 1–4. Names ignore case, dots and underscores. Arguments can be positional, followed by named arguments; quote strings containing spaces, commas or punctuation. Escape a literal quote or backslash with a backslash. Integer values can use underscores as separators. Boolean values include `true`/`false` and `on`/`off`. Parameter types and accepted enum values are checked before an action is dispatched.
|
||||
|
||||
Use `id:n` for a player ID where accepted, `slot:n` for a current squad position, and `club:n` for a master club reference. Rows and slots are temporary references. Player IDs, master club indices, runtime team IDs and name-pool identity keys are different domains. Obtain the appropriate reference from the current list or state view.
|
||||
|
||||
## Responses
|
||||
|
||||
Text lines carry a leading class: `#` status, `>` command option, `|` table row, `+` success, `!` error, `?` question, `i` information, `~` match event and `c` chat. Status headers are emitted when needed; absence of a new header does not imply that the window or match has ended. Read the final status and all intervening question/error lines.
|
||||
|
||||
`--json` in console mode emits structured line records with `class`, `window`, `player`, `text` and optional `data`. This is the structured representation of console output, not the standalone request protocol. Prefer it over parsing translated prose. Legacy game strings can still expose encoding limitations; retain raw bytes if reporting a decoder problem.
|
||||
|
||||
## Questions and ownership
|
||||
|
||||
A question has an ID, a recipient and listed options. Answer with `Answer(id, option)`, using the actual ID and option from the response. Only its owner can decide it. A question can occur during another manager's turn or while advancing the shared match clock. `GoBack` can select a question's default or cancel an editor; it is not a harmless substitute for an explicit answer.
|
||||
|
||||
`ListOptions` and `Help` describe the current build. Common failures include `E_BAD_ARGUMENT`, `E_NOT_IN_WINDOW`, `E_NOT_YOUR_TURN`, `E_PENDING_QUESTION`, `E_RULE`, `E_MODE_LOCKED`, `E_PHASE_LOCKED`, `E_IO` and `E_ENGINE_GAP`. A recognised name does not guarantee that every mode or path is implemented. Preserve an unexpected error and inspect state before deciding whether to retry.
|
||||
|
||||
The [client introduction](../CONSOLE_CLIENTS.md) covers transport, turn ownership, safe batching and replay.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `*`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListOptions` | [command:string \| all] | commands possible here; ListOptions(all) also shows locked ones |
|
||||
| `GoBack` | – | right mouse button: one level back, otherwise nothing |
|
||||
| `Chat` | [to:int], text:string | message to all, or to one player (0 = only the log) |
|
||||
| `ChatLog` | [count:int=20] | the last chat messages |
|
||||
| `Answer` | id:int, option:enum | answer the open question |
|
||||
| `Status` | – | window, player and a short overview |
|
||||
| `State` | view:enum(Desk,Table,Lineup,Mailbox,Bank,Market,Advertising,Contracts,Stadium,Toto,Training,Camp) | the full projection of a view as structured (JSON) data |
|
||||
| `Advice` | – | situations that need a decision now: form, squad, contracts, advertising, money |
|
||||
| `Scoreboard` | – | all human managers: league, place, points, balance, strength of the best eleven |
|
||||
| `Help` | [command:string] | command reference (all windows) |
|
||||
| `Quit` | [force:bool=false] | end the session (asks first during a game) |
|
||||
| `HarnessState` | [path:string] | Harness State. See current Help for behaviour and bounds. |
|
||||
| `HarnessHash` | – | Harness Hash. See current Help for behaviour and bounds. |
|
||||
| `HarnessInvariants` | – | Harness Invariants. See current Help for behaviour and bounds. |
|
||||
| `HarnessAutopilot` | player:int(1..4), policy:enum(Default,Saver,Spender,Random,Off) | Harness Autopilot. See current Help for behaviour and bounds. |
|
||||
| `HarnessFast` | matchdays:int, [until:enum(Matchday,Season,GameEnd)] | Harness Fast. See current Help for behaviour and bounds. |
|
||||
| `HarnessCoverage` | – | Harness Coverage. See current Help for behaviour and bounds. |
|
||||
| `HarnessSeed` | – | Harness Seed. See current Help for behaviour and bounds. |
|
||||
| `HarnessExpect` | text:string | Harness Expect. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,67 @@
|
||||
# Windows and navigation
|
||||
|
||||
A console window is a session context, not a separate game process. `Open(window)` enters an available window from the desktop. Nested editors and information cards return to their parent through `GoBack`. Pending questions and staged engine operations can restrict navigation.
|
||||
|
||||
A dot in a window name denotes a specialised context, for example `Transfer.Negotiate`. It does not imply that a client can open it directly without selecting a player. Global commands use `*` in the catalogue. `ListOptions` is the reliable guide to the current context; an operation allowed on the desktop may be forbidden during a live match or another manager's turn.
|
||||
|
||||
The following identifiers occur in the command catalogue. Some are reserved or only available in particular modes. They are API names, not a guarantee of complete support for every original screen.
|
||||
|
||||
| Window | Reference |
|
||||
|---|---|
|
||||
| `NewGame` | [Commands](03-start.md) |
|
||||
| `NewGame.Select` | [Commands](03-start.md) |
|
||||
| `NewGame.Select.Confirm` | [Commands](03-start.md) |
|
||||
| `NewPlayer` | [Commands](03-start.md) |
|
||||
| `Desktop` | [Commands](04-schreibtisch.md) |
|
||||
| `Mailbox` | [Commands](04-schreibtisch.md) |
|
||||
| `Desktop.Drawer` | [Commands](04-schreibtisch.md) |
|
||||
| `Calendar` | [Commands](04-schreibtisch.md) |
|
||||
| `LoadGame` | [Commands](04-schreibtisch.md) |
|
||||
| `SaveGame` | [Commands](04-schreibtisch.md) |
|
||||
| `NewGame.LoadGame` | [Commands](04-schreibtisch.md) |
|
||||
| `LeagueTable` | [Commands](05-information.md) |
|
||||
| `Fixtures` | [Commands](05-information.md) |
|
||||
| `Strengths` | [Commands](05-information.md) |
|
||||
| `TeamInfo` | [Commands](05-information.md) |
|
||||
| `Achievements` | [Commands](05-information.md) |
|
||||
| `OtherGames` | [Commands](05-information.md) |
|
||||
| `IndoorTable` | [Commands](05-information.md) |
|
||||
| `TopScorers` | [Commands](05-information.md) |
|
||||
| `FairPlay` | [Commands](05-information.md) |
|
||||
| `HighScore` | [Commands](05-information.md) |
|
||||
| `Statistics` | [Commands](05-information.md) |
|
||||
| `Lineup` | [Commands](06-verein.md) |
|
||||
| `Lineup.Pitch` | [Commands](06-verein.md) |
|
||||
| `Lineup.Order` | [Commands](06-verein.md) |
|
||||
| `Lineup.Marking` | [Commands](06-verein.md) |
|
||||
| `Lineup.SetPieces` | [Commands](06-verein.md) |
|
||||
| `PlayerCard` | [Commands](06-verein.md) |
|
||||
| `PlayerCard.Statistics` | [Commands](06-verein.md) |
|
||||
| `Tactics` | [Commands](06-verein.md) |
|
||||
| `Training` | [Commands](06-verein.md) |
|
||||
| `TrainingCamp` | [Commands](06-verein.md) |
|
||||
| `Transfer` | [Commands](06-verein.md) |
|
||||
| `Transfer.Negotiate` | [Commands](06-verein.md) |
|
||||
| `Transfer.Search` | [Commands](06-verein.md) |
|
||||
| `Transfer.Poach` | [Commands](06-verein.md) |
|
||||
| `Transfer.Offers` | [Commands](06-verein.md) |
|
||||
| `Contracts` | [Commands](06-verein.md) |
|
||||
| `Contracts.Negotiate` | [Commands](06-verein.md) |
|
||||
| `Bank` | [Commands](06-verein.md) |
|
||||
| `Bank.Account` | [Commands](06-verein.md) |
|
||||
| `Bank.Savings` | [Commands](06-verein.md) |
|
||||
| `Bank.Shares` | [Commands](06-verein.md) |
|
||||
| `Bank.RealEstate` | [Commands](06-verein.md) |
|
||||
| `Bank.Credit` | [Commands](06-verein.md) |
|
||||
| `Stadium` | [Commands](06-verein.md) |
|
||||
| `Stadium.Periphery` | [Commands](06-verein.md) |
|
||||
| `Stadium.Data` | [Commands](06-verein.md) |
|
||||
| `Advertising` | [Commands](06-verein.md) |
|
||||
| `Environment` | [Commands](06-verein.md) |
|
||||
| `Balance` | [Commands](06-verein.md) |
|
||||
| `Toto` | [Commands](06-verein.md) |
|
||||
| `Friendlies` | [Commands](06-verein.md) |
|
||||
| `Reschedule` | [Commands](06-verein.md) |
|
||||
| `Match` | [Commands](07-spieltag.md) |
|
||||
| `GameEnd` | [Commands](07-spieltag.md) |
|
||||
| `Settings` | [Commands](08-einstellungen.md) |
|
||||
@@ -0,0 +1,57 @@
|
||||
# Starting or loading a career
|
||||
|
||||
Startup moves from `NewGame` to `NewGame.Select`, then asks each selected manager to confirm their choices. Use `ShowOptions` and `ListTeams` to obtain the current values and master club references. Do not assume that the same numeric club identifies the same content in German and English installations.
|
||||
|
||||
`NewGame` sets the duration, difficulty, manager count, mode and league/world choices. Team selection records a manager name, club, starting league, strength band and portrait. `Confirm` opens a question; answer its actual ID explicitly. With several managers, finish each selection before the first desktop appears.
|
||||
|
||||
`OpenLoadBrowser` / `LoadGame` enter normal save loading. Paths are resolved against the configured save browser. The loader validates format/version compatibility; renaming an unsupported save or altering its header does not make it supported. Adding a manager later uses `NewPlayer` and remains subject to the running career's rules.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `NewGame`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowOptions` | – | show the options with their current values |
|
||||
| `NewGame` | duration:int(1..5), difficulty:int(1..10), managers:int(1..4), mode:int(1..3), league:bool, world:bool | set all options and continue (= right mouse) |
|
||||
| `SetDuration` | duration:int(1..5) | 1-4 seasons, 5 = endless |
|
||||
| `SetDifficulty` | difficulty:int(1..10) | number of balls |
|
||||
| `SetManagers` | managers:int(1..4) | human managers |
|
||||
| `SetMode` | mode:int(1..3) | range of desk functions |
|
||||
| `SetLeagueMode` | on:bool | league mode on/off |
|
||||
| `SetWorldMode` | on:bool | world cup mode on/off |
|
||||
| `OpenLoadBrowser` | – | open the load browser |
|
||||
| `LoadGame` | filename:string | load a saved game |
|
||||
|
||||
### `NewGame.Select`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListTeams` | [league:int \| tab:enum] | clubs of a picker tab (Bundesliga ... AdditionalB) |
|
||||
| `ListPortraits` | – | the twelve portraits and who took them |
|
||||
| `ListStrengths` | – | the three club strengths |
|
||||
| `ShowSelection` | – | the choices of this player |
|
||||
| `SetManagerName` | name:string(1..20) | the manager's name (1-20 characters) |
|
||||
| `SetClub` | club:Club | the club: club:<n> from ListTeams or "name" |
|
||||
| `SetStartLeague` | league:enum(Bundesliga,SecondLeague,RegionalA,RegionalB,Oberliga) | the league to start in |
|
||||
| `SetStrength` | strength:enum(Upper,Middle,Lower) | the club's strength |
|
||||
| `SetPortrait` | portrait:int(0..11) | the manager's portrait |
|
||||
| `SelectTeam` | managerName:string, club:Club, startLeague:enum, strength:enum, portrait:int | set all five and ask for confirmation |
|
||||
| `Confirm` | – | show the summary and ask "all details correct?" |
|
||||
|
||||
### `NewGame.Select.Confirm`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSummary` | – | the choices of this player |
|
||||
|
||||
### `NewPlayer`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowNewPlayerOptions` | – | Show New Player Options. See current Help for behaviour and bounds. |
|
||||
| `SetManagers` | managers:int(current..4) | Set Managers. See current Help for behaviour and bounds. |
|
||||
| `SetDifficulty` | difficulty:int(1..10) | Set Difficulty. See current Help for behaviour and bounds. |
|
||||
| `Confirm` | – | Confirm. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,77 @@
|
||||
# Desktop, calendar and saved games
|
||||
|
||||
`Desktop` is the management turn. Read `ShowDesk`, `ShowDate`, `ShowFinance`, `ShowOpponent` or `State(Desk)` before making decisions. `Open(window)` navigates to an available management window. Restrictions depend on game mode, manager role, phase and pending questions.
|
||||
|
||||
`Kickoff` hands control to the next manager or starts calendar processing once all required managers have finished. It can produce information, questions, a match window, a season boundary or the next desktop. Put it last in a batch and inspect its complete response.
|
||||
|
||||
`Calendar` reads the current schedule. `Mailbox` lists messages and supports normal keep/delete actions. Message rows are snapshot references; refresh them after a mutation. `LoadGame`, `SaveGame` and `NewGame.LoadGame` share browser commands. Select a file and use the normal `Save` action; resolve overwrite/delete questions explicitly. Save only a committed state accepted by the session.
|
||||
|
||||
Desktop layout commands are listed for discoverability. Some legacy layout operations can return `E_ENGINE_GAP`; appearance in this index is not a claim that every editor function is available.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `Desktop`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowDesk` | – | all displays of the desk |
|
||||
| `ShowDate` | – | date, weekday, season day, league round |
|
||||
| `ShowFinance` | – | balance, savings, ticket price |
|
||||
| `ShowFanStanding` | – | standing with the fans |
|
||||
| `ShowLamps` | – | the ten warning lamps |
|
||||
| `ShowLastGames` | – | the last six games |
|
||||
| `ShowOpponent` | – | the next game and opponent |
|
||||
| `ShowPositionCurves` | [own\|opponent] | table positions per matchday |
|
||||
| `ShowAutomation` | – | the five automations |
|
||||
| `Open` | window:enum \| menu:int | open a window (click on its icon); see the lines below |
|
||||
| `Key` | letter:enum(A..Z) | a key on the desk (G = Kickoff) |
|
||||
| `SetTicketPrice` | price:int(8..25) | the ticket price (price scale) |
|
||||
| `SetAutomation` | feature:enum(Lineup,Substitution,Tactics,Marking,Training), on:bool | switch one of the five automations (Lineup: a saved formation 1-8) |
|
||||
| `Kickoff` | – | hand over to the next player or start the day |
|
||||
| `OpenMailbox` | – | open the mailbox (Kicker) |
|
||||
| `OpenDrawer` | – | open the menu bar |
|
||||
| `PullPlug` | – | the plug: quit after a question |
|
||||
|
||||
### `Mailbox`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListMessages` | – | the messages of this manager (msg numbers for Keep/Delete) |
|
||||
| `KeepMessage` | msg:int | keep a message / let it go (at most five) |
|
||||
| `DeleteMessage` | msg:int | throw a message away |
|
||||
|
||||
### `Desktop.Drawer`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListIcons` | – | List Icons. See current Help for behaviour and bounds. |
|
||||
| `MoveIcon` | window:enum, x:int, y:int | Move Icon. See current Help for behaviour and bounds. |
|
||||
| `OpenFolder` | folder:int(1..3) | Open Folder. See current Help for behaviour and bounds. |
|
||||
| `OpenTrash` | – | Open Trash. See current Help for behaviour and bounds. |
|
||||
| `StoreIcon` | window:enum, folder:int(1..3) | Store Icon. See current Help for behaviour and bounds. |
|
||||
| `RetrieveIcon` | window:enum | Retrieve Icon. See current Help for behaviour and bounds. |
|
||||
| `SaveMenuDesign` | file:string | Save Menu Design. See current Help for behaviour and bounds. |
|
||||
| `LoadMenuDesign` | file:string | Load Menu Design. See current Help for behaviour and bounds. |
|
||||
| `SetTransparent` | window:enum, on:bool | Set Transparent. See current Help for behaviour and bounds. |
|
||||
| `CloseDrawer` | – | Close Drawer. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Calendar`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowCalendar` | [month:int(1..12)] | Show Calendar. See current Help for behaviour and bounds. |
|
||||
|
||||
### `LoadGame|SaveGame|NewGame.LoadGame`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListFiles` | – | List Files. See current Help for behaviour and bounds. |
|
||||
| `ChangeDirectory` | name:string | Change Directory. See current Help for behaviour and bounds. |
|
||||
| `ParentDirectory` | – | Parent Directory. See current Help for behaviour and bounds. |
|
||||
| `SelectFile` | name:string | Select File. See current Help for behaviour and bounds. |
|
||||
| `FileInfo` | name:string | File Info. See current Help for behaviour and bounds. |
|
||||
| `Load` | [name:string] | Load. See current Help for behaviour and bounds. |
|
||||
| `Save` | [name:string], [overwrite:bool=false] | Save. See current Help for behaviour and bounds. |
|
||||
| `DeleteFile` | name:string | Delete File. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,139 @@
|
||||
# Tables and information windows
|
||||
|
||||
Information windows expose league tables, fixtures, strengths, player cards, honours, other competitions, calendars and statistics. Choose a league or competition using the current view's options; avoid assuming that all editions have the same names or tournament structure.
|
||||
|
||||
A club's master identity and current runtime position differ. Use the identity returned for the intended action rather than reusing a row from another table. Sorting, range and home/away filters affect the current view; they do not rewrite the competition's saved result history.
|
||||
|
||||
`OpenPlayer` and `OpenTeamInfo` can create nested windows. `GoBack` closes the current level, subject to pending questions. Read-only reports can still be unavailable outside their supported mode or phase. Use `State(Table)` when a client needs an owned structured league table.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `LeagueTable`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowTable` | [league:int(0..8)] | the table (without league: the one shown) |
|
||||
| `SetLeague` | league:int(0..8) | show another league |
|
||||
| `ToggleEurope` | – | Toggle Europe. See current Help for behaviour and bounds. |
|
||||
| `SetView` | view:enum(Total,Home,Away) | Set View. See current Help for behaviour and bounds. |
|
||||
| `SetCriteria` | points:bool, goals:bool, goalsAgainst:bool | Set Criteria. See current Help for behaviour and bounds. |
|
||||
| `SetRange` | all \| from:int, to:int | Set Range. See current Help for behaviour and bounds. |
|
||||
| `SetPointsMode` | mode:enum(Normal,English) | Set Points Mode. See current Help for behaviour and bounds. |
|
||||
| `ComputerTip` | – | Computer Tip. See current Help for behaviour and bounds. |
|
||||
| `OpenFixtures` | – | the fixtures of this league |
|
||||
| `OpenStrengths` | – | Open Strengths. See current Help for behaviour and bounds. |
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Fixtures`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowFixtures` | [league:int, matchday:int] | the page shown (optionally another league / matchday first) |
|
||||
| `SetLeague` | league:int(0..8) | another league |
|
||||
| `SetMatchday` | matchday:int | go to a matchday |
|
||||
| `NextMatchday` | – | the next matchday (arrow) |
|
||||
| `PreviousMatchday` | – | the previous matchday (arrow) |
|
||||
| `FindGame` | home:Club, away:Club | Find Game. See current Help for behaviour and bounds. |
|
||||
| `GamesOf` | club:Club | Games Of. See current Help for behaviour and bounds. |
|
||||
| `Page` | n:int | Page. See current Help for behaviour and bounds. |
|
||||
| `ShowPostponed` | – | the postponed games |
|
||||
| `ComputerTip` | – | the computer's forecast for this page |
|
||||
| `OpenTable` | – | the league table |
|
||||
| `OpenStrengths` | – | Open Strengths. See current Help for behaviour and bounds. |
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Strengths`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowStrengths` | [league:int] | Show Strengths. See current Help for behaviour and bounds. |
|
||||
| `SetLeague` | league:int(0..8) | Set League. See current Help for behaviour and bounds. |
|
||||
| `SetCriteria` | fitness:bool, skill:bool, form:bool, morale:bool | Set Criteria. See current Help for behaviour and bounds. |
|
||||
| `SetLines` | goalkeeper:bool, defence:bool, midfield:bool, attack:bool | Set Lines. See current Help for behaviour and bounds. |
|
||||
| `SetZeroValue` | – | Set Zero Value. See current Help for behaviour and bounds. |
|
||||
| `SortByAge` | on:bool | Sort By Age. See current Help for behaviour and bounds. |
|
||||
| `SetPlayerFilter` | filter:enum(All,OnPitchOnly) | Set Player Filter. See current Help for behaviour and bounds. |
|
||||
| `OpenFixtures` | – | Open Fixtures. See current Help for behaviour and bounds. |
|
||||
| `OpenTable` | – | Open Table. See current Help for behaviour and bounds. |
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `TeamInfo`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
| `ShowTeamSquad` | [view:enum(A,B)] | the club's squad |
|
||||
| `ShowTeamStatistics` | [scope:enum(Home,Away,Total)] | Show Team Statistics. See current Help for behaviour and bounds. |
|
||||
| `SetBroadcast` | club:Club, mode:enum(Dots,Headphones,Camera) | Set Broadcast. See current Help for behaviour and bounds. |
|
||||
| `ShowPlayer` | player:Player | a player of this club |
|
||||
| `CloseTeamInfo` | – | back to where it was opened |
|
||||
|
||||
### `Achievements`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowAchievements` | – | Show Achievements. See current Help for behaviour and bounds. |
|
||||
| `ShowCompetitionSeason` | competition:enum(League,DfbCup,European) | Show Competition Season. See current Help for behaviour and bounds. |
|
||||
|
||||
### `OtherGames`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowCompetition` | [competition:enum, round:enum, matchday:int] | Show Competition. See current Help for behaviour and bounds. |
|
||||
| `SetCompetition` | competition:enum(DfbCup,UefaCup,ChampionsLeague,CupWinners,World,SuperCup) | Set Competition. See current Help for behaviour and bounds. |
|
||||
| `SetRound` | round:string | Set Round. See current Help for behaviour and bounds. |
|
||||
| `NextMatchday` | – | Next Matchday. See current Help for behaviour and bounds. |
|
||||
| `PreviousMatchday` | – | Previous Matchday. See current Help for behaviour and bounds. |
|
||||
| `CompleteView` | – | Complete View. See current Help for behaviour and bounds. |
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `IndoorTable`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowIndoorTable` | – | Show Indoor Table. See current Help for behaviour and bounds. |
|
||||
| `OpenTeamInfo` | club:Club | Open Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `TopScorers`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowScorers` | [list:enum(Goals,Assists,Score), scope:enum(League,Managers)] | the best ten: goals, assists or both; whole league or managers' clubs |
|
||||
| `SetList` | list:enum(Goals,Assists,Score) | TORSCHÜTZEN / VORLAGEN / SCORER |
|
||||
| `SetScope` | scope:enum(League,Managers) | GESAMTE LIGA / NUR MANAGER |
|
||||
|
||||
### `FairPlay`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowFairPlay` | – | Show Fair Play. See current Help for behaviour and bounds. |
|
||||
|
||||
### `HighScore`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowHighScore` | – | the high score list and your current score |
|
||||
|
||||
### `Statistics`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `OpenView` | view:enum(Opportunities,AllTimeTable,SeriesRecords,Transfers,WorldCup,Winners,Charts,Finances,MinuteStats) | Open View. See current Help for behaviour and bounds. |
|
||||
| `ShowOpportunities` | [mode:enum(A,B,C,D)] | Show Opportunities. See current Help for behaviour and bounds. |
|
||||
| `ShowAllTimeTable` | [country:enum(Bundesliga,France,England,Spain,Italy)], [mode:enum(Absolute,Relative)] | Show All Time Table. See current Help for behaviour and bounds. |
|
||||
| `ShowSeriesRecords` | – | Show Series Records. See current Help for behaviour and bounds. |
|
||||
| `ShowTransferHistory` | – | Show Transfer History. See current Help for behaviour and bounds. |
|
||||
| `ShowWorldCupStats` | [nation:string] | Show World Cup Stats. See current Help for behaviour and bounds. |
|
||||
| `ShowWinners` | [competition:enum(League,DfbCup,ChampionsLeague,CupWinners,WorldCup,EuroCup,IndoorMasters,SuperCup)] | Show Winners. See current Help for behaviour and bounds. |
|
||||
| `ShowCharts` | kind:enum(TablePosition,GateIncome,Balance,Strength,AdvertisingIncome,Assets), [mode:enum(Absolute,Relative)] | Show Charts. See current Help for behaviour and bounds. |
|
||||
| `ShowFinances` | – | Show Finances. See current Help for behaviour and bounds. |
|
||||
| `ShowMinuteStats` | – | Show Minute Stats. See current Help for behaviour and bounds. |
|
||||
|
||||
### `*`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListLeagues` | – | leagues with number and size |
|
||||
| `ListClubs` | [league:int] | List Clubs. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,352 @@
|
||||
# Club management
|
||||
|
||||
Club windows share the same session actions as the graphical client. Read a projection, choose current identifiers, apply an action and inspect its result before using a stale row or price again.
|
||||
|
||||
## Squad, tactics and training
|
||||
|
||||
`Lineup` lists squad members and positions; use explicit player references for moves and orders. The engine checks availability, formation and substitution rules. `Tactics` changes preparation values, while automation flags can delegate selected decisions. `Training` has types, areas, intensity and focus; opening or initialising a plan is an action distinct from merely reading it. A legal starting eleven takes priority over speculative transfers.
|
||||
|
||||
## Transfers and contracts
|
||||
|
||||
`Transfer` provides market filters, players and purchase/loan actions. `HirePlayer` requests an ordinary loan for a supported duration; free agents must be bought rather than borrowed. `Transfer.Negotiate` holds a staged offer: change fields with `SetOffer` or `SetOfferField`, submit with `SubmitOffer`, or cancel through `GoBack`. The engine applies qualification, squad capacity, wages, fees and acceptance rules; an opened editor is not an accepted purchase.
|
||||
|
||||
A loan expiry can suspend calendar processing for a return question addressed to the borrowing manager. The manager chooses the displayed No or Yes option. Yes opens the normal staged buyback negotiation; cancelling that editor follows the ordinary return path. Only the owning manager can edit or close it. Do not start another calendar operation while a modal question or editor owns the suspended operation.
|
||||
|
||||
`Contracts.Negotiate` is a separate contract editor. Player IDs remain distinct from squad positions and temporary offer rows. Refresh demand and offer views after changes; neither a displayed demand nor a pending offer guarantees final acceptance.
|
||||
|
||||
## Finance and facilities
|
||||
|
||||
`Bank`, `Advertising`, `Stadium`, `Toto` and related subwindows expose normal financial actions. Quotes and offer rows belong to their current projection. Advertising slots can be empty, active or require renewal; reading a general budget does not itself secure a sponsor. Training camps use edition-provided resort tables and the displayed currency conversion. Read the actual quote instead of hardcoding a price from another edition.
|
||||
|
||||
Loans, deposits, shares, facilities and campaigns all have rule and budget checks. A cash balance alone does not establish affordability when wages, credit or a pending obligation also matter.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `Lineup`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSquad` | [view:enum(A,B)] | the squad: values, strength, place |
|
||||
| `SetSquadView` | view:enum(A,B) | DATEN-A / DATEN-B |
|
||||
| `SwapPlayers` | first:Player, second:Player | exchange two players' places |
|
||||
| `OpenPlayer` | player:Player | the player card (PlayerCard) |
|
||||
| `OpenPitch` | – | the pitch (Lineup.Pitch) |
|
||||
| `OpenTeamList` | – | Open Team List. See current Help for behaviour and bounds. |
|
||||
| `ShowForeigners` | – | Show Foreigners. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Lineup.Pitch`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowPitch` | – | the eleven with depth/lane, formations, automatic weights |
|
||||
| `SetFormation` | slot:int(1..8) | one of the eight formations (1-4 given, 5-8 own); the automatic line-up takes over |
|
||||
| `SaveFormation` | slot:int(5..8) | save the current positions in an own formation slot (long press) |
|
||||
| `MovePlayer` | player:Player, depth:int, lane:int | place a starter freely (switches the automatic line-up off) |
|
||||
| `SwapPitch` | first:Player, second:Player | exchange two players on the pitch / bench |
|
||||
| `SetAutoWeights` | kind:enum(Position,SideAndRole,Fatigue), value:int(0..3) | an automatic line-up weight (the cup is clicked until the value); then SetFormation again |
|
||||
| `ShowAutoWeights` | – | the three automatic line-up weights |
|
||||
| `ScrollList` | direction:enum(Up,Down) | Scroll List. See current Help for behaviour and bounds. |
|
||||
| `SetSquadView` | view:enum(A,B) | DATEN-A / DATEN-B |
|
||||
| `OpenTeamList` | – | Open Team List. See current Help for behaviour and bounds. |
|
||||
| `OpenOrder` | – | ORDER: the instructions of the starters (Lineup.Order) |
|
||||
| `OpenMarking` | – | Open Marking. See current Help for behaviour and bounds. |
|
||||
| `ShowZoneCoverage` | – | Show Zone Coverage. See current Help for behaviour and bounds. |
|
||||
| `OpenSetPieces` | – | Open Set Pieces. See current Help for behaviour and bounds. |
|
||||
| `ShowPairs` | – | the Hall partners stored on the tactics board |
|
||||
| `PairPlayers` | first:Player, second:Player, depth:int(0..19), lane:int(0..8) | place the first Hall starter beside the second at the explicit target coordinates |
|
||||
|
||||
### `Lineup.Order`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowOrders` | – | offense, running, commitment, fighting of every starter |
|
||||
| `SetOrder` | player:Player, aspect:enum(Offense,Run,Commitment,Fighting), value:int | one instruction of a starter (as a click in its bar) |
|
||||
|
||||
### `Lineup.Marking`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowOpponentSquad` | – | Show Opponent Squad. See current Help for behaviour and bounds. |
|
||||
| `SetMarking` | own:Player, opponent:Player | Set Marking. See current Help for behaviour and bounds. |
|
||||
| `ClearMarking` | opponent:Player | Clear Marking. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Lineup.SetPieces`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSetPieces` | – | Show Set Pieces. See current Help for behaviour and bounds. |
|
||||
| `SetSetPieceTaker` | kind:enum(FreeKick,Penalty,Corner), player:Player | Set Set Piece Taker. See current Help for behaviour and bounds. |
|
||||
| `SetSetPieceAuto` | [kind:enum(FreeKick,Penalty,Corner)] | Set Set Piece Auto. See current Help for behaviour and bounds. |
|
||||
|
||||
### `PlayerCard`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowPlayer` | [player:Player] | the card (another player of the squad by name) |
|
||||
| `OpenPlayer` | player:Player | another player's card |
|
||||
| `OpenPlayerStatistics` | – | the development charts (own players) |
|
||||
| `Negotiate` | – | Negotiate. See current Help for behaviour and bounds. |
|
||||
| `NationalSquadAdd` | – | National Squad Add. See current Help for behaviour and bounds. |
|
||||
| `NationalSquadRemove` | – | National Squad Remove. See current Help for behaviour and bounds. |
|
||||
|
||||
### `PlayerCard.Statistics`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowPlayerStatistics` | [chart:enum(Value,Form,Strength,Total), mode:enum(Absolute,Relative)] | a development chart as a series |
|
||||
| `SetChart` | chart:enum(Value,Form,Strength,Total) | SPIELER-WERT / FORM / STÄRKE / GESAMT |
|
||||
| `SetMode` | mode:enum(Absolute,Relative) | ABS / REL |
|
||||
| `BackToPlayerInfo` | – | back to the card |
|
||||
|
||||
### `Tactics`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowTactics` | – | the eight settings with value and maximum |
|
||||
| `SetTactic` | item:int(0..7), value:int | set a value directly (item 0 ends the assistant's D/O control) |
|
||||
| `CycleTactic` | item:int(0..6) | a click: value + 1, after the maximum 0 |
|
||||
|
||||
### `Training`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowTraining` | – | types, areas, sums, players, automation |
|
||||
| `SetTrainingType` | type:enum(TOR,ABW,MIT,STU), balls:int(0..3) | balls of a player type (sum <= 8) |
|
||||
| `SetTrainingArea` | area:enum(Fitness,Skill,Corner,FreeKick,Tackling,Pass,Shot,Speed,Game), balls:int(0..3) | balls of a training area (F+S <= 4, rest <= 18) |
|
||||
| `SetPlayerIntensity` | player:Player, intensity:int(1..3) | training intensity of a player |
|
||||
| `CyclePlayerFocus` | player:Player | the player's focus symbol: next focus |
|
||||
| `SetTrainingAutomation` | index:int(0..4), on:bool | one automation bit (D p. 109) |
|
||||
| `InitializeTraining` | – | the original initialization (only when needed) |
|
||||
|
||||
### `TrainingCamp`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListResorts` | – | the eight sports schools with stars and price |
|
||||
| `ShowCamp` | – | sliders, recuperation, visits |
|
||||
| `SetCampFocus` | fitness:int(0..15), skill:int(0..15), game:int(0..15) | the three sliders; recuperation follows |
|
||||
| `BookCamp` | resort:int(0..7) | MACH ICH: book the sports school |
|
||||
|
||||
### `Transfer`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowMarket` | [page:int] | the offered players (20 per page) |
|
||||
| `SetMarketFilter` | positions:list(TOR,ABW,MIT,STU) \| All | ALLE / TOR / ABW / MIT / STU |
|
||||
| `SetSquadView` | view:enum(Active,Team) | Set Squad View. See current Help for behaviour and bounds. |
|
||||
| `SetSquadSheet` | sheet:enum(A,B) | Set Squad Sheet. See current Help for behaviour and bounds. |
|
||||
| `SetMarketVisible` | on:bool | Set Market Visible. See current Help for behaviour and bounds. |
|
||||
| `ShowPlayer` | player:Player | Show Player. See current Help for behaviour and bounds. |
|
||||
| `SellPlayer` | player:Player | VER-KAUFEN: put an own player on the list |
|
||||
| `LoanOutPlayer` | player:Player, months:int(12\|24) | VER-LEIHEN: offer an own player for loan |
|
||||
| `BuyPlayer` | player:Player | VER-KAUFEN on a market player: the offer editor |
|
||||
| `HirePlayer` | player:Player, months:int(12\|24) | VER-LEIHEN on a market player: the loan offer |
|
||||
| `OpenOffers` | player:Player | Open Offers. See current Help for behaviour and bounds. |
|
||||
| `OpenSearch` | – | Open Search. See current Help for behaviour and bounds. |
|
||||
| `OpenPoach` | – | ABWERBEN: pick a player of another club (Transfer.Poach) |
|
||||
| `ShowTransferNews` | [count:int] | Show Transfer News. See current Help for behaviour and bounds. |
|
||||
| `ShowTeamInfo` | – | Show Team Info. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Transfer.Negotiate`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowNegotiation` | – | demand, quote and your offer |
|
||||
| `SetOffer` | fee:money, salary:money, years:int(1..4), bonusGoal:int, bonusPoints:int, bonusAppearance:int, bonusChampion:int, bonus2to5:int, bonus6to10:int, bonusAvoidRelegation:int | all ten fields |
|
||||
| `SetOfferField` | field:enum(Fee,Salary,Years,BonusGoal,BonusPoints,BonusAppearance,BonusChampion,Bonus2to5,Bonus6to10,BonusAvoidRelegation), value:int | change one field (a fresh quote follows) |
|
||||
| `SubmitOffer` | – | ANGEBOT: hand in the offer |
|
||||
| `ShowTeamInfo` | – | TEAM-INFO: your club's squad, as the editor shows it |
|
||||
| `ShowPlayerInfo` | – | SPIELER-INFO: the player's card with his market value |
|
||||
|
||||
### `Transfer.Search`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSearchProfile` | – | Show Search Profile. See current Help for behaviour and bounds. |
|
||||
| `SuggestProfile` | – | Suggest Profile. See current Help for behaviour and bounds. |
|
||||
| `SetSearchProfile` | types:list(TOR,ABW,MIT,STU), age:range, strength:range, focus:list(Fitness,Skill,Form), side:enum(Left,Right,Both), style:enum(Defensive,Offensive,Both), price:enum(Min,Normal,Max) | Set Search Profile. See current Help for behaviour and bounds. |
|
||||
| `StartSearch` | – | Start Search. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Transfer.Poach`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListPoachClubs` | [league:int] | the clubs of a league (default: own) |
|
||||
| `ListClubPlayers` | club:Club | the players of the club |
|
||||
| `PoachPlayer` | player:Player | the offer to a player of another club (decided at once) |
|
||||
|
||||
### `Transfer.Offers`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListOffers` | [player:Player] | List Offers. See current Help for behaviour and bounds. |
|
||||
| `AcceptOffer` | offer:int | Accept Offer. See current Help for behaviour and bounds. |
|
||||
| `RejectOffer` | offer:int | Reject Offer. See current Help for behaviour and bounds. |
|
||||
| `NegotiateOffer` | offer:int | Negotiate Offer. See current Help for behaviour and bounds. |
|
||||
| `ChooseBuyer` | player:Player, offer:int | Choose Buyer. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Contracts`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowContracts` | [sheet:enum(A,B)] | the squad with salaries and contract months |
|
||||
| `ShowTeamBonuses` | – | the seven team bonuses (percent of the salary) |
|
||||
| `SetTeamBonus` | kind:enum(Goal,Points,Appearance,Champion,Place2to5,Place6to10,AvoidRelegation), percent:int | a team bonus; it can only be raised |
|
||||
| `OpenNegotiation` | player:Player | the player's demands (Contracts.Negotiate) |
|
||||
|
||||
### `Contracts.Negotiate`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowDemands` | – | the demands for 1-4 years |
|
||||
| `SetContractOffer` | years:int(1..4), salary:money | the salary offer (monthly) |
|
||||
| `SetInsurance` | form:enum(A,B,C,D), months:int | insure the player (no question) |
|
||||
| `SetPlayerBonus` | kind:enum(Goal,Points,Appearance,Champion,Place2to5,Place6to10,AvoidRelegation), percent:int | a bonus for this player (PRÄMIEN) |
|
||||
| `MakeOffer` | – | ANGEBOT MACHEN: the player decides |
|
||||
|
||||
### `Bank`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowBank` | – | balance, savings, credit line, season base |
|
||||
| `OpenAccount` | – | the finance overview (Bank.Account) |
|
||||
| `OpenSavings` | – | the fixed deposit (Bank.Savings) |
|
||||
| `OpenCredit` | [lender:enum(Bank,Manager1,Manager2,Manager3,Manager4)] | the credit view (Bank.Credit) |
|
||||
| `OpenRealEstate` | – | real estate funds (Bank.RealEstate) |
|
||||
| `OpenShares` | – | the stock market (Bank.Shares) |
|
||||
|
||||
### `Bank.Account`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowFinanceOverview` | – | assets, debts and net worth |
|
||||
| `ShowAssetProfitLoss` | asset:int(0..11) | profit/loss of a share |
|
||||
|
||||
### `Bank.Savings`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSavings` | – | account and fixed deposit |
|
||||
| `Deposit` | amount:money(>0) | account -> fixed deposit |
|
||||
| `Withdraw` | amount:money(>0) | fixed deposit -> account |
|
||||
|
||||
### `Bank.Shares`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListShares` | – | the twelve shares |
|
||||
| `ShowShare` | asset:int(0..11) | one share with its last 30 prices |
|
||||
| `ShareAdvice` | asset:int(0..11) | the bank's tip for a share |
|
||||
| `BuyShares` | asset:int(0..11), count:int(>0) | buy shares |
|
||||
| `SellShares` | asset:int(0..11), count:int(>0) | sell shares |
|
||||
|
||||
### `Bank.RealEstate`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListRealEstate` | – | the six real estate funds |
|
||||
| `BuyRealEstate` | type:int(0..5), units:int(>0) | buy units |
|
||||
| `SellRealEstate` | type:int(0..5), units:int(>0) | sell units |
|
||||
|
||||
### `Bank.Credit`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowCredit` | [lender:enum(Bank,Manager1..4)] | the credit rows with the editable ranges |
|
||||
| `SetCreditAmount` | amount:money | AUSGEZAHLTER BETRAG: the credit |
|
||||
| `SetCreditPayment` | monthly:money | the monthly payment: within 20 % of the annuity for a credit from a manager |
|
||||
| `SetCreditTerm` | months:int | LAUFZEIT in months |
|
||||
| `RepayCredit` | amount:money \| All | RÜCKZAHLUNG: pay back (All = as much as possible) |
|
||||
| `ConfirmCredit` | – | book the changes (asks about fees) |
|
||||
| `CancelCredit` | – | discard the changes |
|
||||
|
||||
### `Stadium`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowStadium` | – | facilities, maintenance and blocks |
|
||||
| `ShowFutureExpansion` | – | Show Future Expansion. See current Help for behaviour and bounds. |
|
||||
| `QuoteBlockExpansion` | block:enum(A..H), seats:int, seated:bool, roofed:bool | Quote Block Expansion. See current Help for behaviour and bounds. |
|
||||
| `ConfirmBlockExpansion` | [tip:bool=false] | Confirm Block Expansion. See current Help for behaviour and bounds. |
|
||||
| `DeclineBlockExpansion` | – | Decline Block Expansion. See current Help for behaviour and bounds. |
|
||||
| `BuildFacility` | facility:enum(Floodlights,Scoreboard,PitchHeating,VipLounge) | technical expansion (AUSBAUEN): tier and tip questions |
|
||||
| `Maintain` | item:enum(Pitch,Comfort,Condition,Safety) | maintenance: tier and tip questions |
|
||||
| `SetTicketPrice` | price:int(8..25) | the ticket price (as on the desk) |
|
||||
| `OpenPeriphery` | – | SICHT: PANORAMA (Stadium.Periphery) |
|
||||
| `OpenData` | – | Open Data. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Stadium.Periphery`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListPeriphery` | – | the 14 objects: built (traffic access: stage 1-3), building, days |
|
||||
| `QuotePeriphery` | object:int(0..13) | the building firm's current offer (question) |
|
||||
| `BuildPeriphery` | object:int(0..13), price:money | accept the offer |
|
||||
| `DeclinePeriphery` | object:int(0..13), price:money | decline the offer |
|
||||
| `OpenInterior` | – | SICHT: INNEN (back to Stadium) |
|
||||
|
||||
### `Stadium.Data`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowStadiumData` | [chart:enum(Spectators,Admission,StadiumValue,ExtraIncome,Income,Costs), mode:enum(Absolute,Relative)] | Show Stadium Data. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Advertising`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowAdvertising` | – | all boards, shirt, TV and the spending |
|
||||
| `ListAdOffers` | slot:enum(Board1..Board14,Shirt,Tv) | the offers for a board, the shirt or TV (an expired contract: renewal first) |
|
||||
| `AcceptAdOffer` | slot:enum, offer:int | ANNEHMEN |
|
||||
| `DeclineAdOffer` | – | ABBRECHEN |
|
||||
| `SetSpending` | kind:enum(PublicRelations,FanCare), amount:money | monthly budget for press work or fan care |
|
||||
| `BuyFanItems` | amount:money | buy fan articles (sold in 6-9 weeks) |
|
||||
|
||||
### `Environment`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowEnvironment` | – | six monthly budgets and three youth tables |
|
||||
| `SetStaffLevel` | role:enum(AssistantCoach,Doctor,Physio), level:int(0..6) | click a staff tile: level 0..6, 5 000 a month each |
|
||||
| `SetYouthLevel` | team:enum(Youngest,Academy,Oldest), level:int(0..6) | set a youth team’s monthly budget |
|
||||
| `SetYouthAcademy` | state:enum(On,Off) | compatibility alias: middle youth budget at level 6 or 0 |
|
||||
|
||||
### `Balance`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowBalance` | – | all items, the view and the planned profit or loss |
|
||||
| `SetBalanceView` | view:enum(SoFar,Real,Future) | left button: so far / real / future |
|
||||
| `SetBalanceItem` | item:enum(IncomeShirt,IncomeBoards,IncomeTv,IncomePeriphery,IncomeRentInterest,IncomeMisc,ExpenseSalaries,ExpenseStadium,ExpenseYouth,ExpenseCoTrainer,ExpenseDoctor,ExpensePhysio,ExpenseTrainingCamp,ExpenseFanCare,ExpensePr,ExpenseInterest,ExpenseMisc,OtherHomeGames,AverageGate,TicketPrice), value:int | change a planned value (views Real and Future) |
|
||||
| `TakeActuals` | – | "Werte akt.": drop the own changes, back to the game's figures |
|
||||
|
||||
### `Toto`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowToto` | – | the eleven matches with your tips |
|
||||
| `SetTip` | match:int(1..11), tip:enum(1,0,2) | the tip for one match |
|
||||
| `SetStake` | amount:money(>=0) | the stake |
|
||||
| `SubmitToto` | [stake:money, tips:list(11)] | MACH ICH: hand in the coupon |
|
||||
| `ClearToto` | – | all tips back to 1, stake 0 |
|
||||
|
||||
### `Friendlies`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListFriendlyOpponents` | [league:int(0..8)] | the clubs of a league (default: own) |
|
||||
| `ProposeFriendly` | club:Club, venue:enum(Home,Away) | the offer: costs and who pays |
|
||||
| `ListFreeDates` | – | the days the friendly can be played |
|
||||
| `SetFriendlyDate` | date:date | book the friendly on a free date (YYYY-MM-DD) |
|
||||
|
||||
### `Reschedule`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ListRescheduleGames` | – | own home league matches that can be moved |
|
||||
| `ListRescheduleDates` | game:date | the days the match can be moved to |
|
||||
| `MoveGame` | game:date, to:date | move the match to a free day |
|
||||
| `ListMovedGames` | – | moved matches that can still be taken back (new date) |
|
||||
| `UndoMove` | game:date | take a move back (game = the new date); the match is played on its matchday again |
|
||||
@@ -0,0 +1,57 @@
|
||||
# Matches and season boundaries
|
||||
|
||||
The console's stepped clock allows managers to inspect a live match and intervene through the normal tactics and substitution actions. Start with the current status, own pairing and statistics; a global match window can exist on a cup day when a particular manager has no fixture.
|
||||
|
||||
`Step(minutes)` advances a requested interval. `Run(Halftime)` requests the half-time boundary, and `Run(End)` requests completion. These are shared clock commands: with multiple seats, every required seat must submit readiness. Place the clock command last in the block. Read the returned minute and phase before the next request; never ask for half-time after it has already passed. If another seat advances to an intermediate stop, inspect that actual state rather than assuming the previous request's target was reached.
|
||||
|
||||
Only intervene in a match that actually includes the manager's team. A manager without a fixture still participates in the shared clock barrier. Do not manufacture substitutions or tactical mutations merely because another team's match is running.
|
||||
|
||||
Status can report `matchday running, minute N` without a new `# Window: Match` header. Questions can interrupt a clock request and belong to another manager. Follow the question ownership rules in [syntax](01-grundlagen.md) and the [client introduction](../CONSOLE_CLIENTS.md).
|
||||
|
||||
At a season-end desktop, inspect the completed table and financial/squad position before continuing. A historical final table is not itself a new year transition. `State(Desk)` supplies the phase and season index for clients that need to track the boundary. Finite careers can terminate in `GameEnd`; do not keep submitting advance commands after completion.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `Match`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `Step` | [minutes:int=1] | let the clock run n minutes (default 1) |
|
||||
| `Run` | [until:enum(Halftime,End)=End] | run to half time or to the end of the day |
|
||||
| `Pause` | – | Pause. See current Help for behaviour and bounds. |
|
||||
| `Resume` | – | Resume. See current Help for behaviour and bounds. |
|
||||
| `ShowMatchStats` | [match:int] | the scoreboard: score, chances, cards, spectators, weather |
|
||||
| `Watch` | match:int | Watch. See current Help for behaviour and bounds. |
|
||||
| `Substitute` | out:Player, in:Player | a substitution: a player leaves, a bench player comes on |
|
||||
| `SetFormation` | slot:int(1..8) | not during a match (move single players with MovePlayer) |
|
||||
| `MovePlayer` | player:Player, depth:int, lane:int | place a starter on another position for the rest of the match (from minute 3) |
|
||||
| `SetTactic` | item:int(0..7), value:int | change a tactic setting during the match (item 0 ends the assistant's D/O control) |
|
||||
| `ShowTactics` | – | the eight tactic settings of your team in this match |
|
||||
| `SetMarking` | own:Player, opponent:Player | Set Marking. See current Help for behaviour and bounds. |
|
||||
| `SetOrder` | player:Player, aspect:enum, value:int | Set Order. See current Help for behaviour and bounds. |
|
||||
| `Open` | window:enum(Lineup,Tactics,Table,Fixtures,Settings) | Open. See current Help for behaviour and bounds. |
|
||||
| `ShowSquad` | – | your team on the pitch and on the bench |
|
||||
|
||||
### `Desktop|Lineup|Friendlies`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowNationalSquad` | – | Show National Squad. See current Help for behaviour and bounds. |
|
||||
| `NationalSquadAdd` | player:Player | National Squad Add. See current Help for behaviour and bounds. |
|
||||
| `NationalSquadRemove` | player:Player | National Squad Remove. See current Help for behaviour and bounds. |
|
||||
|
||||
### `GameEnd`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowHighScore` | – | Show High Score. See current Help for behaviour and bounds. |
|
||||
| `NewGame` | duration:int(1..5), difficulty:int(1..10), managers:int(1..4), mode:int(1..3), league:bool, world:bool | New Game. See current Help for behaviour and bounds. |
|
||||
| `LoadGame` | filename:string | Load Game. See current Help for behaviour and bounds. |
|
||||
|
||||
### `Desktop`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSportschau` | [part:enum(Results,TimeBar,BestEleven,MatchdayOverview)] | Show Sportschau. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,24 @@
|
||||
# Settings
|
||||
|
||||
`Settings` operates on the career's normal switch settings. Supported boolean switches, numeric values and ranges are defined by the current projection and command help. The [settings format](../formats/EIN.md) includes reserved and multivalued cells; clients should not replace the raw matrix with their own boolean array.
|
||||
|
||||
Frontend capabilities can lock unavailable audio controls. Music preference, effects preference and actual playback-device readiness are different states. Use the projected availability and normal actions. Graphical process options such as `--mute`, `--no-music` or `--volume` are launch options, not new console commands or save fields.
|
||||
|
||||
Availability also depends on mode and manager role. A setting rejected by the engine should remain unchanged; do not bypass the rejection by patching a save.
|
||||
|
||||
## Command index
|
||||
|
||||
This index includes registered and reserved names. `ListOptions` and `Help` from the running build determine current signatures and availability. An indexed command may reject an unsupported context with `E_ENGINE_GAP`. Parameters retain the console notation; `—` means none.
|
||||
|
||||
### `Settings`
|
||||
|
||||
| Command | Parameters | Purpose |
|
||||
|---|---|---|
|
||||
| `ShowSettings` | [group:enum(Results,Sound,Game,Limits,MenuEdit,Functions,Sportschau,Display,Values,Delays)] | the switch field A1-T9 |
|
||||
| `ShowSwitch` | key:string | one switch |
|
||||
| `SetSwitch` | key:string, value:int | set a switch (on/off or a number) |
|
||||
| `IncreaseSwitch` | key:string | the plus field (columns 8, 9) |
|
||||
| `DecreaseSwitch` | key:string | the minus field (columns 8, 9) |
|
||||
| `LoadSettings` | file:string | Load Settings. See current Help for behaviour and bounds. |
|
||||
| `SaveSettings` | file:string | Save Settings. See current Help for behaviour and bounds. |
|
||||
| `ShowReadme` | – | Show Readme. See current Help for behaviour and bounds. |
|
||||
@@ -0,0 +1,9 @@
|
||||
# Text, encoding and editions
|
||||
|
||||
The installation supplies game text and names. The command vocabulary stays stable across editions; it is not translated into the selected game's display language. German and English installation data can have different text, league contents, executable layouts and currency presentation. English support remains experimental as described in the [release notes](../release/0.1/RELEASE_NOTES.md).
|
||||
|
||||
Legacy bytes are decoded at the display boundary. Client-facing text is intended to be UTF-8, while save and database offsets refer to legacy byte pools. Avoid using a displayed name as a persistent identifier: names may be edited, ambiguous or rendered differently. Prefer the ID domain required by the current command.
|
||||
|
||||
Structured records separate data from prose. Clients should decide from IDs, enums, numeric fields, question options and error codes rather than searching for a translated sentence. Preserve raw response bytes when investigating an encoding problem, and avoid publishing proprietary text collections or full game logs containing original content.
|
||||
|
||||
[TEXTD](../formats/TEXTD.md) describes the text database's structure. Replacement text requires an independent redistribution license. No extracted text inventory is included in this repository.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Developing clients and tests
|
||||
|
||||
Start with the [client introduction](../CONSOLE_CLIENTS.md). A client should keep policy separate from transport: the transport submits one block, preserves the whole response and returns ownership, questions, errors and structured records to the policy. The policy then chooses a legal action for its own manager.
|
||||
|
||||
For automated checks, use independently created input and synthetic fixtures. Parser tests should exercise quoting, named arguments and block boundaries. Session tests should verify real outcomes such as a rejected stale action leaving state unchanged, a question being resolved by its actual owner, or a cancelled staged offer releasing its suspended operation. A printout matching a proposed answer is not evidence that the game state changed correctly.
|
||||
|
||||
Replay checks compare execution with the same binary, data and initial state; they do not prove universal compatibility with every original edition. Keep test outputs private when they contain game text or personal information. Public bug reports should contain minimal independently written steps, relevant version identifiers and the observed failure, without original executables, artwork, recordings or saved games.
|
||||
|
||||
Build/test setup is described in [BUILDING](../BUILDING.md). Original-data checks require a user-supplied installation and can be skipped when that input is absent. Do not report a skipped check as passed. New frontend code should reuse session actions rather than implementing another transfer, match or finance engine.
|
||||
@@ -0,0 +1,69 @@
|
||||
# Small console examples
|
||||
|
||||
These fragments illustrate the console syntax. They are not a recorded game session. Run each only in the indicated context and inspect the actual response before submitting a dependent block.
|
||||
|
||||
## Discover commands
|
||||
|
||||
```text
|
||||
ListOptions
|
||||
Help
|
||||
Status
|
||||
go.
|
||||
```
|
||||
|
||||
## Inspect a running career
|
||||
|
||||
```text
|
||||
State(Desk)
|
||||
State(Lineup)
|
||||
Advice
|
||||
go.
|
||||
```
|
||||
|
||||
`State` requires a running career. A manager client can only inspect its permitted owned views. Read returned IDs before constructing actions that refer to a player or club.
|
||||
|
||||
## Open a management window
|
||||
|
||||
From the active manager's desktop:
|
||||
|
||||
```text
|
||||
Open(Tactics)
|
||||
ListOptions
|
||||
go.
|
||||
```
|
||||
|
||||
Choose a supported setting using the returned help, then close the window before ending the turn. A command executed earlier in a failed batch is not undone.
|
||||
|
||||
## Resolve a question
|
||||
|
||||
If the current response addresses question ID 42 to this manager and lists `No` as an option, this block selects it:
|
||||
|
||||
```text
|
||||
Answer(42, No)
|
||||
go.
|
||||
```
|
||||
|
||||
The number 42 is illustrative. Always use the actual ID, owner and options. Do not repeat a previous answer against a new question.
|
||||
|
||||
## Finish a turn or advance a match
|
||||
|
||||
From the desktop, after completing management decisions:
|
||||
|
||||
```text
|
||||
Kickoff
|
||||
go.
|
||||
```
|
||||
|
||||
From an active match before half-time:
|
||||
|
||||
```text
|
||||
ShowMatchStats
|
||||
Run(Halftime)
|
||||
go.
|
||||
```
|
||||
|
||||
Check the returned minute and current phase before advancing again. Use `Run(End)` after half-time. With multiple managers, the shared clock waits for every required seat. Questions can interrupt these requests.
|
||||
|
||||
## Ask a mailbox client to wait
|
||||
|
||||
After starting a multi-seat server as described in the [client introduction](../CONSOLE_CLIENTS.md), send `WaitTurn` followed by `go.` to that seat using `--send`. Keep that one request pending until its response arrives. Do not start a second client for the same seat merely because the server has not answered yet.
|
||||
@@ -0,0 +1,13 @@
|
||||
# Alternative frontends
|
||||
|
||||
A frontend can use the console without duplicating gameplay rules. Start `openbmh_cli --console` with standard input/output, a directory mailbox or a loopback socket. All three reach the same session. See the [client introduction](../CONSOLE_CLIENTS.md) for framing and ownership.
|
||||
|
||||
`--json` emits one JSON object per output line. Each has a line class, window, player and text; structured information is carried in `data`. Table records include both displayed cells and named values where available. Question records include their ID, recipient, options and default. Inspect these fields instead of parsing translated labels.
|
||||
|
||||
`State(view)` returns an owned projection. Supported views include `Desk`, `Table`, `Lineup`, `Mailbox`, `Bank`, `Market`, `Advertising`, `Contracts`, `Stadium`, `Toto`, `Training` and `Camp`. Mutations still use the current window's commands and the session's normal validation. A state snapshot does not grant permission to act for another manager.
|
||||
|
||||
Semantic fields such as `plain_background`, `solid_panel_background`, `compact_dialog_frame`, `replay_progression_mode` and `replay_chance_mode` describe projected behaviour. Their names are independent of executable table locations. Presence flags such as `has_replay_progression_mode` describe whether the corresponding value is available; they are not extra gameplay switches.
|
||||
|
||||
Rendering should retain the revision and identifiers associated with a projection. Refresh after successful mutation, manager handoff or a season transition. Modal editors have their own lifetime: update their staged fields or cancel through their owning action, and do not keep rendering pointers into a mutable session object.
|
||||
|
||||
The transport is a local integration interface, not an authenticated public game service. A network-facing application needs its own access control and deployment design; changing the socket bind address is not a complete service architecture.
|
||||
@@ -0,0 +1,26 @@
|
||||
# Console reference
|
||||
|
||||
`openbmh_cli --console` provides a window-oriented command language over the same career session used by the graphical game. It supports interactive use, scripts, independent manager clients and alternative frontends. It is separate from the smaller [JSON request protocol](../protocol.md) selected without `--console`.
|
||||
|
||||
```sh
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --seed 1
|
||||
```
|
||||
|
||||
Enter `ListOptions`, then `go.` on its own line to see the current commands. Use `Help` for signatures. Commands execute as a block when `go.` is read; they are not executed merely by entering a line.
|
||||
|
||||
- [Syntax, output, errors and questions](01-grundlagen.md)
|
||||
- [Windows and navigation](02-fenster.md)
|
||||
- [Starting and loading careers](03-start.md)
|
||||
- [Desktop, calendar and saved games](04-schreibtisch.md)
|
||||
- [Tables and information](05-information.md)
|
||||
- [Club management](06-verein.md)
|
||||
- [Matches and season boundaries](07-spieltag.md)
|
||||
- [Settings](08-einstellungen.md)
|
||||
- [Text and edition handling](09-texte.md)
|
||||
- [Client development and tests](10-agenten-und-tests.md)
|
||||
- [Small examples](12-beispiele.md)
|
||||
- [Alternative frontends](15-frontends.md)
|
||||
|
||||
The [client and agent introduction](../CONSOLE_CLIENTS.md) explains mailbox/socket transport and safe ownership rules. [commands.csv](commands.csv) is a machine-readable command/window index. Its nine-column schema is retained for existing tooling; descriptive provenance columns may be empty, and implementation markers are not a runtime capability query. The running build's `ListOptions` and `Help` take precedence over this index. Recognised operations can still return `E_ENGINE_GAP` when a required engine path is unavailable.
|
||||
|
||||
Examples use independently written names and placeholder paths. The repository supplies no original game content, text catalogue or recorded game session.
|
||||
@@ -0,0 +1,349 @@
|
||||
"window";"command";"parameters";"effect";"errors";"engine";"c4";"status";"source"
|
||||
"*";"ListOptions";"[command:string | all]";"commands possible here; ListOptions(all) also shows locked ones";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"GoBack";"–";"right mouse button: one level back, otherwise nothing";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Chat";"[to:int], text:string";"message to all, or to one player (0 = only the log)";"E_BAD_ARGUMENT";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"ChatLog";"[count:int=20]";"the last chat messages";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Answer";"id:int, option:enum";"answer the open question";"E_NOT_YOUR_TURN, E_BAD_ARGUMENT";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Status";"–";"window, player and a short overview";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"State";"view:enum(Desk,Table,Lineup,Mailbox,Bank,Market,Advertising,Contracts,Stadium,Toto,Training,Camp)";"the full projection of a view as structured (JSON) data";"E_NOT_IN_WINDOW, E_MODE_LOCKED";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Advice";"–";"situations that need a decision now: form, squad, contracts, advertising, money";"E_NOT_IN_WINDOW";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Scoreboard";"–";"all human managers: league, place, points, balance, strength of the best eleven";"E_NOT_IN_WINDOW";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Help";"[command:string]";"command reference (all windows)";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"Quit";"[force:bool=false]";"end the session (asks first during a game)";"—";"";"";"ready";"01-grundlagen.md"
|
||||
"NewGame";"ShowOptions";"–";"show the options with their current values";"—";"";"";"partial";"03-start.md"
|
||||
"NewGame";"NewGame";"duration:int(1..5), difficulty:int(1..10), managers:int(1..4), mode:int(1..3), league:bool, world:bool";"set all options and continue (= right mouse)";"E_BAD_ARGUMENT";"";"";"partial";"03-start.md"
|
||||
"NewGame";"SetDuration";"duration:int(1..5)";"1-4 seasons, 5 = endless";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame";"SetDifficulty";"difficulty:int(1..10)";"number of balls";"E_BAD_ARGUMENT";"";"";"partial";"03-start.md"
|
||||
"NewGame";"SetManagers";"managers:int(1..4)";"human managers";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame";"SetMode";"mode:int(1..3)";"range of desk functions";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame";"SetLeagueMode";"on:bool";"league mode on/off";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame";"SetWorldMode";"on:bool";"world cup mode on/off";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame";"OpenLoadBrowser";"–";"open the load browser";"—";"";"";"ready";"03-start.md"
|
||||
"NewGame";"LoadGame";"filename:string";"load a saved game";"E_IO, E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"ListTeams";"[league:int | tab:enum]";"clubs of a picker tab (Bundesliga ... AdditionalB)";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"ListPortraits";"–";"the twelve portraits and who took them";"—";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"ListStrengths";"–";"the three club strengths";"—";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"ShowSelection";"–";"the choices of this player";"—";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SetManagerName";"name:string(1..20)";"the manager's name (1-20 characters)";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SetClub";"club:Club";"the club: club:<n> from ListTeams or ""name""";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SetStartLeague";"league:enum(Bundesliga,SecondLeague,RegionalA,RegionalB,Oberliga)";"the league to start in";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SetStrength";"strength:enum(Upper,Middle,Lower)";"the club's strength";"E_BAD_ARGUMENT";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SetPortrait";"portrait:int(0..11)";"the manager's portrait";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"SelectTeam";"managerName:string, club:Club, startLeague:enum, strength:enum, portrait:int";"set all five and ask for confirmation";"—";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select";"Confirm";"–";"show the summary and ask ""all details correct?""";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewGame.Select.Confirm";"ShowSummary";"–";"the choices of this player";"—";"";"";"ready";"03-start.md"
|
||||
"NewPlayer";"ShowNewPlayerOptions";"–";"Show New Player Options. See current Help for behaviour and bounds.";"—";"";"";"ready";"03-start.md"
|
||||
"NewPlayer";"SetManagers";"managers:int(current..4)";"Set Managers. See current Help for behaviour and bounds.";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewPlayer";"SetDifficulty";"difficulty:int(1..10)";"Set Difficulty. See current Help for behaviour and bounds.";"E_RULE";"";"";"ready";"03-start.md"
|
||||
"NewPlayer";"Confirm";"–";"Confirm. See current Help for behaviour and bounds.";"—";"";"";"ready";"03-start.md"
|
||||
"Desktop";"ShowDesk";"–";"all displays of the desk";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"ShowDate";"–";"date, weekday, season day, league round";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"ShowFinance";"–";"balance, savings, ticket price";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"ShowFanStanding";"–";"standing with the fans";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"ShowLamps";"–";"the ten warning lamps";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"ShowLastGames";"–";"the last six games";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"ShowOpponent";"–";"the next game and opponent";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"ShowPositionCurves";"[own|opponent]";"table positions per matchday";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"ShowAutomation";"–";"the five automations";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"Open";"window:enum | menu:int";"open a window (click on its icon); see the lines below";"E_MODE_LOCKED, E_BAD_ARGUMENT";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"Key";"letter:enum(A..Z)";"a key on the desk (G = Kickoff)";"E_BAD_ARGUMENT";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"SetTicketPrice";"price:int(8..25)";"the ticket price (price scale)";"E_BAD_ARGUMENT, E_PHASE_LOCKED";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"SetAutomation";"feature:enum(Lineup,Substitution,Tactics,Marking,Training), on:bool";"switch one of the five automations (Lineup: a saved formation 1-8)";"E_RULE";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"Kickoff";"–";"hand over to the next player or start the day";"E_PENDING_QUESTION";"";"";"ready";"04-schreibtisch.md"
|
||||
"Desktop";"OpenMailbox";"–";"open the mailbox (Kicker)";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop";"OpenDrawer";"–";"open the menu bar";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop";"PullPlug";"–";"the plug: quit after a question";"—";"";"";"ready";"04-schreibtisch.md"
|
||||
"Mailbox";"ListMessages";"–";"the messages of this manager (msg numbers for Keep/Delete)";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"Mailbox";"KeepMessage";"msg:int";"keep a message / let it go (at most five)";"E_RULE";"";"";"partial";"04-schreibtisch.md"
|
||||
"Mailbox";"DeleteMessage";"msg:int";"throw a message away";"E_BAD_ARGUMENT";"";"";"partial";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"ListIcons";"–";"List Icons. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"MoveIcon";"window:enum, x:int, y:int";"Move Icon. See current Help for behaviour and bounds.";"E_RULE";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"OpenFolder";"folder:int(1..3)";"Open Folder. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"OpenTrash";"–";"Open Trash. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"StoreIcon";"window:enum, folder:int(1..3)";"Store Icon. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"RetrieveIcon";"window:enum";"Retrieve Icon. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"SaveMenuDesign";"file:string";"Save Menu Design. See current Help for behaviour and bounds.";"E_IO";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"LoadMenuDesign";"file:string";"Load Menu Design. See current Help for behaviour and bounds.";"E_IO";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"SetTransparent";"window:enum, on:bool";"Set Transparent. See current Help for behaviour and bounds.";"—";"";"";"gap";"04-schreibtisch.md"
|
||||
"Desktop.Drawer";"CloseDrawer";"–";"Close Drawer. See current Help for behaviour and bounds.";"E_RULE";"";"";"gap";"04-schreibtisch.md"
|
||||
"Calendar";"ShowCalendar";"[month:int(1..12)]";"Show Calendar. See current Help for behaviour and bounds.";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"ListFiles";"–";"List Files. See current Help for behaviour and bounds.";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"ChangeDirectory";"name:string";"Change Directory. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"ParentDirectory";"–";"Parent Directory. See current Help for behaviour and bounds.";"—";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"SelectFile";"name:string";"Select File. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"FileInfo";"name:string";"File Info. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"Load";"[name:string]";"Load. See current Help for behaviour and bounds.";"E_IO, E_RULE";"";"";"partial";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"Save";"[name:string], [overwrite:bool=false]";"Save. See current Help for behaviour and bounds.";"E_IO, E_RULE";"";"";"ready";"04-schreibtisch.md"
|
||||
"LoadGame|SaveGame|NewGame.LoadGame";"DeleteFile";"name:string";"Delete File. See current Help for behaviour and bounds.";"E_IO, E_ENGINE_GAP";"";"";"partial";"04-schreibtisch.md"
|
||||
"LeagueTable";"ShowTable";"[league:int(0..8)]";"the table (without league: the one shown)";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"SetLeague";"league:int(0..8)";"show another league";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"ToggleEurope";"–";"Toggle Europe. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"SetView";"view:enum(Total,Home,Away)";"Set View. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"SetCriteria";"points:bool, goals:bool, goalsAgainst:bool";"Set Criteria. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"SetRange";"all | from:int, to:int";"Set Range. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"SetPointsMode";"mode:enum(Normal,English)";"Set Points Mode. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"ComputerTip";"–";"Computer Tip. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"engine";"05-information.md"
|
||||
"LeagueTable";"OpenFixtures";"–";"the fixtures of this league";"—";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"OpenStrengths";"–";"Open Strengths. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"LeagueTable";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"ShowFixtures";"[league:int, matchday:int]";"the page shown (optionally another league / matchday first)";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"SetLeague";"league:int(0..8)";"another league";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"SetMatchday";"matchday:int";"go to a matchday";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"NextMatchday";"–";"the next matchday (arrow)";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"PreviousMatchday";"–";"the previous matchday (arrow)";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"FindGame";"home:Club, away:Club";"Find Game. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"GamesOf";"club:Club";"Games Of. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"Page";"n:int";"Page. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"ShowPostponed";"–";"the postponed games";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"ComputerTip";"–";"the computer's forecast for this page";"E_ENGINE_GAP";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"OpenTable";"–";"the league table";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"OpenStrengths";"–";"Open Strengths. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Fixtures";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"Strengths";"ShowStrengths";"[league:int]";"Show Strengths. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SetLeague";"league:int(0..8)";"Set League. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SetCriteria";"fitness:bool, skill:bool, form:bool, morale:bool";"Set Criteria. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SetLines";"goalkeeper:bool, defence:bool, midfield:bool, attack:bool";"Set Lines. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SetZeroValue";"–";"Set Zero Value. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SortByAge";"on:bool";"Sort By Age. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"SetPlayerFilter";"filter:enum(All,OnPitchOnly)";"Set Player Filter. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"OpenFixtures";"–";"Open Fixtures. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"OpenTable";"–";"Open Table. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Strengths";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"TeamInfo";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"TeamInfo";"ShowTeamSquad";"[view:enum(A,B)]";"the club's squad";"—";"";"";"partial";"05-information.md"
|
||||
"TeamInfo";"ShowTeamStatistics";"[scope:enum(Home,Away,Total)]";"Show Team Statistics. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"TeamInfo";"SetBroadcast";"club:Club, mode:enum(Dots,Headphones,Camera)";"Set Broadcast. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"TeamInfo";"ShowPlayer";"player:Player";"a player of this club";"—";"";"";"ready";"05-information.md"
|
||||
"TeamInfo";"CloseTeamInfo";"–";"back to where it was opened";"—";"";"";"partial";"05-information.md"
|
||||
"Achievements";"ShowAchievements";"–";"Show Achievements. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Achievements";"ShowCompetitionSeason";"competition:enum(League,DfbCup,European)";"Show Competition Season. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"ShowCompetition";"[competition:enum, round:enum, matchday:int]";"Show Competition. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT, E_RULE";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"SetCompetition";"competition:enum(DfbCup,UefaCup,ChampionsLeague,CupWinners,World,SuperCup)";"Set Competition. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"SetRound";"round:string";"Set Round. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"NextMatchday";"–";"Next Matchday. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"PreviousMatchday";"–";"Previous Matchday. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"CompleteView";"–";"Complete View. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"OtherGames";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"IndoorTable";"ShowIndoorTable";"–";"Show Indoor Table. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"IndoorTable";"OpenTeamInfo";"club:Club";"Open Team Info. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"05-information.md"
|
||||
"TopScorers";"ShowScorers";"[list:enum(Goals,Assists,Score), scope:enum(League,Managers)]";"the best ten: goals, assists or both; whole league or managers' clubs";"—";"";"";"ready";"05-information.md"
|
||||
"TopScorers";"SetList";"list:enum(Goals,Assists,Score)";"TORSCHÜTZEN / VORLAGEN / SCORER";"—";"";"";"ready";"05-information.md"
|
||||
"TopScorers";"SetScope";"scope:enum(League,Managers)";"GESAMTE LIGA / NUR MANAGER";"—";"";"";"ready";"05-information.md"
|
||||
"FairPlay";"ShowFairPlay";"–";"Show Fair Play. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"HighScore";"ShowHighScore";"–";"the high score list and your current score";"—";"";"";"ready";"05-information.md"
|
||||
"Statistics";"OpenView";"view:enum(Opportunities,AllTimeTable,SeriesRecords,Transfers,WorldCup,Winners,Charts,Finances,MinuteStats)";"Open View. See current Help for behaviour and bounds.";"—";"";"";"cli";"05-information.md"
|
||||
"Statistics";"ShowOpportunities";"[mode:enum(A,B,C,D)]";"Show Opportunities. See current Help for behaviour and bounds.";"—";"";"";"engine";"05-information.md"
|
||||
"Statistics";"ShowAllTimeTable";"[country:enum(Bundesliga,France,England,Spain,Italy)], [mode:enum(Absolute,Relative)]";"Show All Time Table. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowSeriesRecords";"–";"Show Series Records. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowTransferHistory";"–";"Show Transfer History. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowWorldCupStats";"[nation:string]";"Show World Cup Stats. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowWinners";"[competition:enum(League,DfbCup,ChampionsLeague,CupWinners,WorldCup,EuroCup,IndoorMasters,SuperCup)]";"Show Winners. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowCharts";"kind:enum(TablePosition,GateIncome,Balance,Strength,AdvertisingIncome,Assets), [mode:enum(Absolute,Relative)]";"Show Charts. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowFinances";"–";"Show Finances. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"Statistics";"ShowMinuteStats";"–";"Show Minute Stats. See current Help for behaviour and bounds.";"—";"";"";"partial";"05-information.md"
|
||||
"*";"ListLeagues";"–";"leagues with number and size";"—";"";"";"ready";"05-information.md"
|
||||
"*";"ListClubs";"[league:int]";"List Clubs. See current Help for behaviour and bounds.";"—";"";"";"cli";"05-information.md"
|
||||
"Lineup";"ShowSquad";"[view:enum(A,B)]";"the squad: values, strength, place";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup";"SetSquadView";"view:enum(A,B)";"DATEN-A / DATEN-B";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup";"SwapPlayers";"first:Player, second:Player";"exchange two players' places";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup";"OpenPlayer";"player:Player";"the player card (PlayerCard)";"—";"";"";"ready";"06-verein.md"
|
||||
"Lineup";"OpenPitch";"–";"the pitch (Lineup.Pitch)";"E_ENGINE_GAP";"";"";"partial";"06-verein.md"
|
||||
"Lineup";"OpenTeamList";"–";"Open Team List. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup";"ShowForeigners";"–";"Show Foreigners. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"ShowPitch";"–";"the eleven with depth/lane, formations, automatic weights";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"SetFormation";"slot:int(1..8)";"one of the eight formations (1-4 given, 5-8 own); the automatic line-up takes over";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Pitch";"SaveFormation";"slot:int(5..8)";"save the current positions in an own formation slot (long press)";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Pitch";"MovePlayer";"player:Player, depth:int, lane:int";"place a starter freely (switches the automatic line-up off)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Pitch";"SwapPitch";"first:Player, second:Player";"exchange two players on the pitch / bench";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"SetAutoWeights";"kind:enum(Position,SideAndRole,Fatigue), value:int(0..3)";"an automatic line-up weight (the cup is clicked until the value); then SetFormation again";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Pitch";"ShowAutoWeights";"–";"the three automatic line-up weights";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"ScrollList";"direction:enum(Up,Down)";"Scroll List. See current Help for behaviour and bounds.";"—";"";"";"cli";"06-verein.md"
|
||||
"Lineup.Pitch";"SetSquadView";"view:enum(A,B)";"DATEN-A / DATEN-B";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"OpenTeamList";"–";"Open Team List. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"OpenOrder";"–";"ORDER: the instructions of the starters (Lineup.Order)";"—";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Pitch";"OpenMarking";"–";"Open Marking. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"ShowZoneCoverage";"–";"Show Zone Coverage. See current Help for behaviour and bounds.";"E_RULE";"";"";"gap";"06-verein.md"
|
||||
"Lineup.Pitch";"OpenSetPieces";"–";"Open Set Pieces. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"ShowPairs";"–";"the Hall partners stored on the tactics board";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Pitch";"PairPlayers";"first:Player, second:Player, depth:int(0..19), lane:int(0..8)";"place the first Hall starter beside the second at the explicit target coordinates";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Order";"ShowOrders";"–";"offense, running, commitment, fighting of every starter";"—";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Order";"SetOrder";"player:Player, aspect:enum(Offense,Run,Commitment,Fighting), value:int";"one instruction of a starter (as a click in its bar)";"E_BAD_ARGUMENT, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Lineup.Marking";"ShowOpponentSquad";"–";"Show Opponent Squad. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Marking";"SetMarking";"own:Player, opponent:Player";"Set Marking. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Lineup.Marking";"ClearMarking";"opponent:Player";"Clear Marking. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.SetPieces";"ShowSetPieces";"–";"Show Set Pieces. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Lineup.SetPieces";"SetSetPieceTaker";"kind:enum(FreeKick,Penalty,Corner), player:Player";"Set Set Piece Taker. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Lineup.SetPieces";"SetSetPieceAuto";"[kind:enum(FreeKick,Penalty,Corner)]";"Set Set Piece Auto. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"PlayerCard";"ShowPlayer";"[player:Player]";"the card (another player of the squad by name)";"—";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard";"OpenPlayer";"player:Player";"another player's card";"—";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard";"OpenPlayerStatistics";"–";"the development charts (own players)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard";"Negotiate";"–";"Negotiate. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"PlayerCard";"NationalSquadAdd";"–";"National Squad Add. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"PlayerCard";"NationalSquadRemove";"–";"National Squad Remove. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"PlayerCard.Statistics";"ShowPlayerStatistics";"[chart:enum(Value,Form,Strength,Total), mode:enum(Absolute,Relative)]";"a development chart as a series";"—";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard.Statistics";"SetChart";"chart:enum(Value,Form,Strength,Total)";"SPIELER-WERT / FORM / STÄRKE / GESAMT";"—";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard.Statistics";"SetMode";"mode:enum(Absolute,Relative)";"ABS / REL";"—";"";"";"ready";"06-verein.md"
|
||||
"PlayerCard.Statistics";"BackToPlayerInfo";"–";"back to the card";"—";"";"";"ready";"06-verein.md"
|
||||
"Tactics";"ShowTactics";"–";"the eight settings with value and maximum";"—";"";"";"ready";"06-verein.md"
|
||||
"Tactics";"SetTactic";"item:int(0..7), value:int";"set a value directly (item 0 ends the assistant's D/O control)";"E_BAD_ARGUMENT, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Tactics";"CycleTactic";"item:int(0..6)";"a click: value + 1, after the maximum 0";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Training";"ShowTraining";"–";"types, areas, sums, players, automation";"—";"";"";"ready";"06-verein.md"
|
||||
"Training";"SetTrainingType";"type:enum(TOR,ABW,MIT,STU), balls:int(0..3)";"balls of a player type (sum <= 8)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Training";"SetTrainingArea";"area:enum(Fitness,Skill,Corner,FreeKick,Tackling,Pass,Shot,Speed,Game), balls:int(0..3)";"balls of a training area (F+S <= 4, rest <= 18)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Training";"SetPlayerIntensity";"player:Player, intensity:int(1..3)";"training intensity of a player";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Training";"CyclePlayerFocus";"player:Player";"the player's focus symbol: next focus";"—";"";"";"ready";"06-verein.md"
|
||||
"Training";"SetTrainingAutomation";"index:int(0..4), on:bool";"one automation bit (D p. 109)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Training";"InitializeTraining";"–";"the original initialization (only when needed)";"—";"";"";"ready";"06-verein.md"
|
||||
"TrainingCamp";"ListResorts";"–";"the eight sports schools with stars and price";"—";"";"";"ready";"06-verein.md"
|
||||
"TrainingCamp";"ShowCamp";"–";"sliders, recuperation, visits";"—";"";"";"ready";"06-verein.md"
|
||||
"TrainingCamp";"SetCampFocus";"fitness:int(0..15), skill:int(0..15), game:int(0..15)";"the three sliders; recuperation follows";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"TrainingCamp";"BookCamp";"resort:int(0..7)";"MACH ICH: book the sports school";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Transfer";"ShowMarket";"[page:int]";"the offered players (20 per page)";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"SetMarketFilter";"positions:list(TOR,ABW,MIT,STU) | All";"ALLE / TOR / ABW / MIT / STU";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"SetSquadView";"view:enum(Active,Team)";"Set Squad View. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"SetSquadSheet";"sheet:enum(A,B)";"Set Squad Sheet. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"SetMarketVisible";"on:bool";"Set Market Visible. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"ShowPlayer";"player:Player";"Show Player. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"SellPlayer";"player:Player";"VER-KAUFEN: put an own player on the list";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"LoanOutPlayer";"player:Player, months:int(12|24)";"VER-LEIHEN: offer an own player for loan";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Transfer";"BuyPlayer";"player:Player";"VER-KAUFEN on a market player: the offer editor";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"HirePlayer";"player:Player, months:int(12|24)";"VER-LEIHEN on a market player: the loan offer";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Transfer";"OpenOffers";"player:Player";"Open Offers. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"OpenSearch";"–";"Open Search. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"OpenPoach";"–";"ABWERBEN: pick a player of another club (Transfer.Poach)";"—";"";"";"ready";"06-verein.md"
|
||||
"Transfer";"ShowTransferNews";"[count:int]";"Show Transfer News. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer";"ShowTeamInfo";"–";"Show Team Info. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Negotiate";"ShowNegotiation";"–";"demand, quote and your offer";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Negotiate";"SetOffer";"fee:money, salary:money, years:int(1..4), bonusGoal:int, bonusPoints:int, bonusAppearance:int, bonusChampion:int, bonus2to5:int, bonus6to10:int, bonusAvoidRelegation:int";"all ten fields";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Negotiate";"SetOfferField";"field:enum(Fee,Salary,Years,BonusGoal,BonusPoints,BonusAppearance,BonusChampion,Bonus2to5,Bonus6to10,BonusAvoidRelegation), value:int";"change one field (a fresh quote follows)";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Negotiate";"SubmitOffer";"–";"ANGEBOT: hand in the offer";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Negotiate";"ShowTeamInfo";"–";"TEAM-INFO: your club's squad, as the editor shows it";"—";"";"";"ready";"06-verein.md"
|
||||
"Transfer.Negotiate";"ShowPlayerInfo";"–";"SPIELER-INFO: the player's card with his market value";"—";"";"";"ready";"06-verein.md"
|
||||
"Transfer.Search";"ShowSearchProfile";"–";"Show Search Profile. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Search";"SuggestProfile";"–";"Suggest Profile. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Search";"SetSearchProfile";"types:list(TOR,ABW,MIT,STU), age:range, strength:range, focus:list(Fitness,Skill,Form), side:enum(Left,Right,Both), style:enum(Defensive,Offensive,Both), price:enum(Min,Normal,Max)";"Set Search Profile. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Search";"StartSearch";"–";"Start Search. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Poach";"ListPoachClubs";"[league:int]";"the clubs of a league (default: own)";"—";"";"";"ready";"06-verein.md"
|
||||
"Transfer.Poach";"ListClubPlayers";"club:Club";"the players of the club";"—";"";"";"ready";"06-verein.md"
|
||||
"Transfer.Poach";"PoachPlayer";"player:Player";"the offer to a player of another club (decided at once)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Transfer.Offers";"ListOffers";"[player:Player]";"List Offers. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Offers";"AcceptOffer";"offer:int";"Accept Offer. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Offers";"RejectOffer";"offer:int";"Reject Offer. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Offers";"NegotiateOffer";"offer:int";"Negotiate Offer. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"partial";"06-verein.md"
|
||||
"Transfer.Offers";"ChooseBuyer";"player:Player, offer:int";"Choose Buyer. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Contracts";"ShowContracts";"[sheet:enum(A,B)]";"the squad with salaries and contract months";"—";"";"";"ready";"06-verein.md"
|
||||
"Contracts";"ShowTeamBonuses";"–";"the seven team bonuses (percent of the salary)";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Contracts";"SetTeamBonus";"kind:enum(Goal,Points,Appearance,Champion,Place2to5,Place6to10,AvoidRelegation), percent:int";"a team bonus; it can only be raised";"E_RULE, E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Contracts";"OpenNegotiation";"player:Player";"the player's demands (Contracts.Negotiate)";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Contracts.Negotiate";"ShowDemands";"–";"the demands for 1-4 years";"—";"";"";"partial";"06-verein.md"
|
||||
"Contracts.Negotiate";"SetContractOffer";"years:int(1..4), salary:money";"the salary offer (monthly)";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Contracts.Negotiate";"SetInsurance";"form:enum(A,B,C,D), months:int";"insure the player (no question)";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Contracts.Negotiate";"SetPlayerBonus";"kind:enum(Goal,Points,Appearance,Champion,Place2to5,Place6to10,AvoidRelegation), percent:int";"a bonus for this player (PRÄMIEN)";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Contracts.Negotiate";"MakeOffer";"–";"ANGEBOT MACHEN: the player decides";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Bank";"ShowBank";"–";"balance, savings, credit line, season base";"—";"";"";"partial";"06-verein.md"
|
||||
"Bank";"OpenAccount";"–";"the finance overview (Bank.Account)";"—";"";"";"partial";"06-verein.md"
|
||||
"Bank";"OpenSavings";"–";"the fixed deposit (Bank.Savings)";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank";"OpenCredit";"[lender:enum(Bank,Manager1,Manager2,Manager3,Manager4)]";"the credit view (Bank.Credit)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Bank";"OpenRealEstate";"–";"real estate funds (Bank.RealEstate)";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank";"OpenShares";"–";"the stock market (Bank.Shares)";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.Account";"ShowFinanceOverview";"–";"assets, debts and net worth";"—";"";"";"partial";"06-verein.md"
|
||||
"Bank.Account";"ShowAssetProfitLoss";"asset:int(0..11)";"profit/loss of a share";"E_ENGINE_GAP";"";"";"partial";"06-verein.md"
|
||||
"Bank.Savings";"ShowSavings";"–";"account and fixed deposit";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.Savings";"Deposit";"amount:money(>0)";"account -> fixed deposit";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Bank.Savings";"Withdraw";"amount:money(>0)";"fixed deposit -> account";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Bank.Shares";"ListShares";"–";"the twelve shares";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.Shares";"ShowShare";"asset:int(0..11)";"one share with its last 30 prices";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.Shares";"ShareAdvice";"asset:int(0..11)";"the bank's tip for a share";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Bank.Shares";"BuyShares";"asset:int(0..11), count:int(>0)";"buy shares";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Bank.Shares";"SellShares";"asset:int(0..11), count:int(>0)";"sell shares";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Bank.RealEstate";"ListRealEstate";"–";"the six real estate funds";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.RealEstate";"BuyRealEstate";"type:int(0..5), units:int(>0)";"buy units";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Bank.RealEstate";"SellRealEstate";"type:int(0..5), units:int(>0)";"sell units";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"ShowCredit";"[lender:enum(Bank,Manager1..4)]";"the credit rows with the editable ranges";"—";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"SetCreditAmount";"amount:money";"AUSGEZAHLTER BETRAG: the credit";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"SetCreditPayment";"monthly:money";"the monthly payment: within 20 % of the annuity for a credit from a manager";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"SetCreditTerm";"months:int";"LAUFZEIT in months";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"RepayCredit";"amount:money | All";"RÜCKZAHLUNG: pay back (All = as much as possible)";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"ConfirmCredit";"–";"book the changes (asks about fees)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Bank.Credit";"CancelCredit";"–";"discard the changes";"—";"";"";"ready";"06-verein.md"
|
||||
"Stadium";"ShowStadium";"–";"facilities, maintenance and blocks";"—";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"ShowFutureExpansion";"–";"Show Future Expansion. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"QuoteBlockExpansion";"block:enum(A..H), seats:int, seated:bool, roofed:bool";"Quote Block Expansion. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"ConfirmBlockExpansion";"[tip:bool=false]";"Confirm Block Expansion. See current Help for behaviour and bounds.";"E_INSUFFICIENT_FUNDS";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"DeclineBlockExpansion";"–";"Decline Block Expansion. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"BuildFacility";"facility:enum(Floodlights,Scoreboard,PitchHeating,VipLounge)";"technical expansion (AUSBAUEN): tier and tip questions";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Stadium";"Maintain";"item:enum(Pitch,Comfort,Condition,Safety)";"maintenance: tier and tip questions";"E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Stadium";"SetTicketPrice";"price:int(8..25)";"the ticket price (as on the desk)";"E_BAD_ARGUMENT";"";"";"partial";"06-verein.md"
|
||||
"Stadium";"OpenPeriphery";"–";"SICHT: PANORAMA (Stadium.Periphery)";"—";"";"";"ready";"06-verein.md"
|
||||
"Stadium";"OpenData";"–";"Open Data. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Stadium.Periphery";"ListPeriphery";"–";"the 14 objects: built (traffic access: stage 1-3), building, days";"—";"";"";"ready";"06-verein.md"
|
||||
"Stadium.Periphery";"QuotePeriphery";"object:int(0..13)";"the building firm's current offer (question)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Stadium.Periphery";"BuildPeriphery";"object:int(0..13), price:money";"accept the offer";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Stadium.Periphery";"DeclinePeriphery";"object:int(0..13), price:money";"decline the offer";"—";"";"";"ready";"06-verein.md"
|
||||
"Stadium.Periphery";"OpenInterior";"–";"SICHT: INNEN (back to Stadium)";"—";"";"";"partial";"06-verein.md"
|
||||
"Stadium.Data";"ShowStadiumData";"[chart:enum(Spectators,Admission,StadiumValue,ExtraIncome,Income,Costs), mode:enum(Absolute,Relative)]";"Show Stadium Data. See current Help for behaviour and bounds.";"—";"";"";"partial";"06-verein.md"
|
||||
"Advertising";"ShowAdvertising";"–";"all boards, shirt, TV and the spending";"—";"";"";"ready";"06-verein.md"
|
||||
"Advertising";"ListAdOffers";"slot:enum(Board1..Board14,Shirt,Tv)";"the offers for a board, the shirt or TV (an expired contract: renewal first)";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Advertising";"AcceptAdOffer";"slot:enum, offer:int";"ANNEHMEN";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Advertising";"DeclineAdOffer";"–";"ABBRECHEN";"—";"";"";"ready";"06-verein.md"
|
||||
"Advertising";"SetSpending";"kind:enum(PublicRelations,FanCare), amount:money";"monthly budget for press work or fan care";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Advertising";"BuyFanItems";"amount:money";"buy fan articles (sold in 6-9 weeks)";"E_INSUFFICIENT_FUNDS, E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Environment";"ShowEnvironment";"–";"staff levels and the youth academy";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Environment";"SetStaffLevel";"role:enum(AssistantCoach,Doctor,Physio), level:int(0..6)";"click a staff tile: level 0..6, 5 000 a month each";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Environment";"SetYouthAcademy";"state:enum(On,Off)";"start (July/August) or stop the youth academy";"—";"";"";"ready";"06-verein.md"
|
||||
"Balance";"ShowBalance";"–";"all items, the view and the planned profit or loss";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Balance";"SetBalanceView";"view:enum(SoFar,Real,Future)";"left button: so far / real / future";"—";"";"";"ready";"06-verein.md"
|
||||
"Balance";"SetBalanceItem";"item:enum(IncomeShirt,IncomeBoards,IncomeTv,IncomePeriphery,IncomeRentInterest,IncomeMisc,ExpenseSalaries,ExpenseStadium,ExpenseYouth,ExpenseCoTrainer,ExpenseDoctor,ExpensePhysio,ExpenseTrainingCamp,ExpenseFanCare,ExpensePr,ExpenseInterest,ExpenseMisc,OtherHomeGames,AverageGate,TicketPrice), value:int";"change a planned value (views Real and Future)";"E_RULE, E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Balance";"TakeActuals";"–";"""Werte akt."": drop the own changes, back to the game's figures";"—";"";"";"ready";"06-verein.md"
|
||||
"Toto";"ShowToto";"–";"the eleven matches with your tips";"—";"";"";"ready";"06-verein.md"
|
||||
"Toto";"SetTip";"match:int(1..11), tip:enum(1,0,2)";"the tip for one match";"E_BAD_ARGUMENT";"";"";"ready";"06-verein.md"
|
||||
"Toto";"SetStake";"amount:money(>=0)";"the stake";"E_BAD_ARGUMENT, E_INSUFFICIENT_FUNDS";"";"";"ready";"06-verein.md"
|
||||
"Toto";"SubmitToto";"[stake:money, tips:list(11)]";"MACH ICH: hand in the coupon";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Toto";"ClearToto";"–";"all tips back to 1, stake 0";"—";"";"";"ready";"06-verein.md"
|
||||
"Friendlies";"ListFriendlyOpponents";"[league:int(0..8)]";"the clubs of a league (default: own)";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Friendlies";"ProposeFriendly";"club:Club, venue:enum(Home,Away)";"the offer: costs and who pays";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Friendlies";"ListFreeDates";"–";"the days the friendly can be played";"—";"";"";"ready";"06-verein.md"
|
||||
"Friendlies";"SetFriendlyDate";"date:date";"book the friendly on a free date (YYYY-MM-DD)";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Reschedule";"ListRescheduleGames";"–";"own home league matches that can be moved";"E_MODE_LOCKED";"";"";"ready";"06-verein.md"
|
||||
"Reschedule";"ListRescheduleDates";"game:date";"the days the match can be moved to";"—";"";"";"ready";"06-verein.md"
|
||||
"Reschedule";"MoveGame";"game:date, to:date";"move the match to a free day";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Reschedule";"ListMovedGames";"–";"moved matches that can still be taken back (new date)";"—";"";"";"ready";"06-verein.md"
|
||||
"Reschedule";"UndoMove";"game:date";"take a move back (game = the new date); the match is played on its matchday again";"E_RULE";"";"";"ready";"06-verein.md"
|
||||
"Match";"Step";"[minutes:int=1]";"let the clock run n minutes (default 1)";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"Run";"[until:enum(Halftime,End)=End]";"run to half time or to the end of the day";"—";"";"";"ready";"07-spieltag.md"
|
||||
"Match";"Pause";"–";"Pause. See current Help for behaviour and bounds.";"—";"";"";"gap";"07-spieltag.md"
|
||||
"Match";"Resume";"–";"Resume. See current Help for behaviour and bounds.";"—";"";"";"gap";"07-spieltag.md"
|
||||
"Match";"ShowMatchStats";"[match:int]";"the scoreboard: score, chances, cards, spectators, weather";"—";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"Watch";"match:int";"Watch. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"Substitute";"out:Player, in:Player";"a substitution: a player leaves, a bench player comes on";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"SetFormation";"slot:int(1..8)";"not during a match (move single players with MovePlayer)";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"MovePlayer";"player:Player, depth:int, lane:int";"place a starter on another position for the rest of the match (from minute 3)";"E_RULE";"";"";"ready";"07-spieltag.md"
|
||||
"Match";"SetTactic";"item:int(0..7), value:int";"change a tactic setting during the match (item 0 ends the assistant's D/O control)";"E_RULE";"";"";"ready";"07-spieltag.md"
|
||||
"Match";"ShowTactics";"–";"the eight tactic settings of your team in this match";"E_RULE";"";"";"ready";"07-spieltag.md"
|
||||
"Match";"SetMarking";"own:Player, opponent:Player";"Set Marking. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"SetOrder";"player:Player, aspect:enum, value:int";"Set Order. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Match";"Open";"window:enum(Lineup,Tactics,Table,Fixtures,Settings)";"Open. See current Help for behaviour and bounds.";"—";"";"";"gap";"07-spieltag.md"
|
||||
"Match";"ShowSquad";"–";"your team on the pitch and on the bench";"—";"";"";"partial";"07-spieltag.md"
|
||||
"Desktop|Lineup|Friendlies";"ShowNationalSquad";"–";"Show National Squad. See current Help for behaviour and bounds.";"—";"";"";"partial";"07-spieltag.md"
|
||||
"Desktop|Lineup|Friendlies";"NationalSquadAdd";"player:Player";"National Squad Add. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"Desktop|Lineup|Friendlies";"NationalSquadRemove";"player:Player";"National Squad Remove. See current Help for behaviour and bounds.";"E_RULE";"";"";"partial";"07-spieltag.md"
|
||||
"GameEnd";"ShowHighScore";"–";"Show High Score. See current Help for behaviour and bounds.";"—";"";"";"ready";"07-spieltag.md"
|
||||
"GameEnd";"NewGame";"duration:int(1..5), difficulty:int(1..10), managers:int(1..4), mode:int(1..3), league:bool, world:bool";"New Game. See current Help for behaviour and bounds.";"E_BAD_ARGUMENT";"";"";"ready";"07-spieltag.md"
|
||||
"GameEnd";"LoadGame";"filename:string";"Load Game. See current Help for behaviour and bounds.";"E_IO";"";"";"ready";"07-spieltag.md"
|
||||
"Desktop";"ShowSportschau";"[part:enum(Results,TimeBar,BestEleven,MatchdayOverview)]";"Show Sportschau. See current Help for behaviour and bounds.";"E_ENGINE_GAP";"";"";"gap";"07-spieltag.md"
|
||||
"Settings";"ShowSettings";"[group:enum(Results,Sound,Game,Limits,MenuEdit,Functions,Sportschau,Display,Values,Delays)]";"the switch field A1-T9";"—";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"ShowSwitch";"key:string";"one switch";"E_BAD_ARGUMENT";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"SetSwitch";"key:string, value:int";"set a switch (on/off or a number)";"E_BAD_ARGUMENT, E_PHASE_LOCKED";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"IncreaseSwitch";"key:string";"the plus field (columns 8, 9)";"E_BAD_ARGUMENT";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"DecreaseSwitch";"key:string";"the minus field (columns 8, 9)";"E_BAD_ARGUMENT";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"LoadSettings";"file:string";"Load Settings. See current Help for behaviour and bounds.";"E_IO";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"SaveSettings";"file:string";"Save Settings. See current Help for behaviour and bounds.";"E_IO";"";"";"partial";"08-einstellungen.md"
|
||||
"Settings";"ShowReadme";"–";"Show Readme. See current Help for behaviour and bounds.";"E_IO";"";"";"partial";"08-einstellungen.md"
|
||||
"*";"HarnessState";"[path:string]";"Harness State. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessHash";"–";"Harness Hash. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessInvariants";"–";"Harness Invariants. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessAutopilot";"player:int(1..4), policy:enum(Default,Saver,Spender,Random,Off)";"Harness Autopilot. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessFast";"matchdays:int, [until:enum(Matchday,Season,GameEnd)]";"Harness Fast. See current Help for behaviour and bounds.";"E_RULE";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessCoverage";"–";"Harness Coverage. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessSeed";"–";"Harness Seed. See current Help for behaviour and bounds.";"—";"";"";"cli";"01-grundlagen.md"
|
||||
"*";"HarnessExpect";"text:string";"Harness Expect. See current Help for behaviour and bounds.";"E_RULE";"";"";"cli";"01-grundlagen.md"
|
||||
|
@@ -0,0 +1,65 @@
|
||||
# Compatibility decisions
|
||||
|
||||
OpenBMH aims to preserve the familiar game while handling malformed input and unsafe edge cases explicitly. A reconstruction can remain faithful without reproducing a crash or pretending to implement an unknown path.
|
||||
|
||||
- Content such as names, text, graphics and edition-specific tables is loaded from the user's installation. OpenBMH's shared rule base supplies simulation values; selecting another data edition does not select a separate engine.
|
||||
- Safety checks reject transactions that would exhaust required return capacity, use stale identities or lose a valid state. Unsupported operations report their limitation rather than inventing an outcome.
|
||||
- Calendar progression handles boundary days and seasonal transitions without relying on unsafe fixed-day assumptions.
|
||||
- Saves are written from the committed session state. Saving does not deliberately replay unrelated game actions.
|
||||
- The reconstruction uses two deterministic random generators with explicit integer semantics. This supports reproducible runs, but is not a promise of complete bit-for-bit equivalence to every original edition or across changed engine versions.
|
||||
|
||||
Intentional changes in code should use the marker `OpenBMH deviates from the original:` and explain their purpose. Adding a new behaviour or balance change requires a concrete description and relevant tests; this page is not permission to substitute guessed rules.
|
||||
|
||||
The [generated differences catalogue](DIFFERENCES.md) lists these markers with links to their source files.
|
||||
|
||||
## Application exit confirmation
|
||||
|
||||
Closing the window, exiting with Escape or confirming the desktop's exit control
|
||||
opens a native confirmation dialog. BMH data uses German text and Football
|
||||
Limited data uses English. Enter, Escape and closing the confirmation cancel the
|
||||
exit; only the explicit Quit/Beenden button permits normal shutdown. Cancelling
|
||||
keeps the current dialog or match owner alive without a turn or implicit save.
|
||||
An unavailable native message box also cancels the request. This applies to
|
||||
voluntary application exits, including quit events received during animations;
|
||||
normal completed-career handling remains separate.
|
||||
|
||||
## Environment and presentation in 0.1.2
|
||||
|
||||
The desktop environment provides three youth teams and three staff
|
||||
budgets, each set to zero through six stars. Youth budgets are monthly, can be
|
||||
changed throughout the season, and contribute to the finance preview, balance
|
||||
plan and booked expenses. Youth tables develop on first-division matchdays;
|
||||
promotion, relegation and age-group handover occur at the season change.
|
||||
The two previously hidden youth groups are available across data editions.
|
||||
Staff prices and the shared academy player-generation strength bands stay in
|
||||
effect. Recruitment needs an active middle youth budget and an oldest youth team
|
||||
within 25 strength points of the senior squad (the full-build mode bypasses the
|
||||
strength gate). This deliberately
|
||||
combines the six-budget environment with OpenBMH's existing player-generation rules.
|
||||
|
||||
Old saved academy lump sums remain payable once and retain their paid status.
|
||||
They are not multiplied into twelve monthly payments. Editing that tile replaces
|
||||
the old amount with the selected monthly budget. There is no new save field.
|
||||
|
||||
Live match minutes use the loaded original delay setting (A9), including zero,
|
||||
instead of an added fixed pause. A9 and the existing scene delays can be adjusted
|
||||
in Settings; loaded saves and EIN files retain their chosen speeds. VGA retrace
|
||||
animations use a 70-Hz reference instead of the host monitor's refresh rate.
|
||||
`--live-frame-ms` and `BMH_LIVE_FRAME_MS` remain explicit diagnostic overrides.
|
||||
|
||||
## Native data and saves in 0.2
|
||||
|
||||
Classic imports preserve the supported BMH and Football Limited structures in sealed OBW
|
||||
packages. The normal runtime no longer reads the original installation. Package integrity
|
||||
failures require reimport; Classic overlays and manual content editing are unsupported.
|
||||
|
||||
Native saving and autosaving consume no random numbers. The FBM writer previously drew
|
||||
four Watcom values for its encryption envelope, so future results after a legacy save
|
||||
operation can differ. A native save/load pair preserves both generators and their draw
|
||||
counts exactly. Original saves lack the clock-seeded Watcom state; migration derives its
|
||||
initial value reproducibly from the source file and records the full state thereafter.
|
||||
|
||||
The launcher start year affects displayed years only. Classic weekdays and season timing
|
||||
retain their existing cycle. Imported careers keep the valid year in their own save header.
|
||||
The launcher exits without confirmation; the running game's existing exit confirmation
|
||||
remains in effect and returns control to the launcher after a confirmed exit.
|
||||
@@ -0,0 +1,47 @@
|
||||
# Writing a console client or agent
|
||||
|
||||
The console is a local control interface for one running career. Human clients, bots and alternative frontends use the same actions and rule checks. Start with [the console reference](CLI_CONCEPT/README.md); use runtime `ListOptions` and `Help` rather than guessing a command from a graphical label.
|
||||
|
||||
## Choose a transport
|
||||
|
||||
For a single process, start `openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
|
||||
|
||||
For separate manager processes, start a local mailbox server:
|
||||
|
||||
```sh
|
||||
openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
|
||||
```
|
||||
|
||||
A client sends one block on stdin to:
|
||||
|
||||
```sh
|
||||
openbmh_cli --send mailbox/seat1 --timeout 3600
|
||||
```
|
||||
|
||||
The client still supplies a terminating `go.` line. Seats are numbered 1–4 and represent human manager slots, not runtime team IDs. Submit one request at a time for each seat. A long-running `WaitTurn` or match-clock request must finish before another client uses that seat. A timeout or interrupted shell client does not establish that the server cancelled the game action.
|
||||
|
||||
Alternatively, `--listen PORT --seats N` binds a local socket on `127.0.0.1`. A connection selects `SEAT k` when seats are enabled. Blocks end with `go.` and responses with a line containing only `.`. Keep one connection/request owner per seat. See `--help` for supported combinations of transport and log options.
|
||||
|
||||
## Track ownership and the whole response
|
||||
|
||||
Keep the current seat, window, manager/club identity, phase and pending question/editor. Parse the entire response before choosing the next action. A question can arrive in information produced during another manager's turn or a suspended calendar advance. Match the question's recipient to this client; answer with its actual ID and listed option.
|
||||
|
||||
The seat hub can prefix a response with information accumulated while other managers played. Do not mistake an old desktop in that feed for the current owned projection. Retain questions and errors from the full response, then use the current own state for financial or squad decisions. A new window header is not emitted after every operation. Status can instead report `matchday running, minute N`.
|
||||
|
||||
Use `WaitTurn` when another seat owns management. At a desktop, apply a short batch of independent decisions, then put `Kickoff` last. Reinspect after actions that open a question, negotiate a contract or change the meaning of a row. Unknown questions require a policy decision; `GoBack` can commit a default or cancel an editor and must not be used as a generic acknowledgement.
|
||||
|
||||
## Shared matches and calendar boundaries
|
||||
|
||||
In a stepped match, `Run` and `Step` participate in a barrier across the required seats. Put the clock command last. Read the returned actual minute and phase before choosing another stop; do not request half-time after that boundary. A manager without a fixture still participates in the barrier but should not issue substitutions or tactical edits for another team's match.
|
||||
|
||||
Questions and staged offer editors can suspend a calendar operation. Finish the owning question/editor before requesting another advance. Once an answered clock request returns without advancement, inspect why before sending another readiness request; blindly replaying a mutation can duplicate an effect.
|
||||
|
||||
A useful automated policy inspects budget, advertising, contracts, squad availability and tactics at deliberate intervals, using explicit rules and bounds. `Advice` supplies observations, not a complete strategy. Count actual `season_index` changes and inspect `phase` at year end; a historical table or summary does not constitute another completed season.
|
||||
|
||||
## Reproducibility and recovery
|
||||
|
||||
Record the binary version, data edition, seed, time mode and the exact submitted blocks when a reproducible session matters. The seed alone is insufficient if the initial save, data or command order differs. `--log`, `--replay` and, for supported multi-seat sessions, `--resume` provide execution records; a replay must use compatible inputs.
|
||||
|
||||
Keep an independent input receipt. Mailbox request files are transport state: a held request may be rewritten to `WaitTurn`, including a request originally submitted as a clock command. Such a file is not proof of what was first sent. Preserve responses and raw bytes before decoding diagnostics. Do not publish logs containing proprietary game text, saves or personal data.
|
||||
|
||||
For restart, use a fresh mailbox, pin the intended binary and verify the recovered current phase, manager and pending operation. Do not silently adopt an old client request or run two processes against the same seat. Normal saved games and replay are the supported starting points; editing native state to get past a question defeats the ownership checks the client is meant to exercise.
|
||||
@@ -0,0 +1,60 @@
|
||||
# Intentional differences from the original
|
||||
|
||||
Generated from source comment markers by `tools/public_release/collect_differences.py`.
|
||||
|
||||
See [Compatibility decisions](COMPATIBILITY.md) for the overall policy. These entries
|
||||
describe deliberate changes; they are not a list of every known compatibility limit.
|
||||
|
||||
- [src/app/career_session.cpp](../src/app/career_session.cpp): supports designated set-piece record initialization and validation.
|
||||
- [src/app/career_session.cpp](../src/app/career_session.cpp): native saves do not consume gameplay randomness for encryption.
|
||||
- [src/app/quit_confirmation.hpp](../src/app/quit_confirmation.hpp): confirms application exit with a localized native dialog, with cancellation selected by default.
|
||||
- [src/formats/le.hpp](../src/formats/le.hpp): applies a shared supported rule profile when loading editions with different rule-table values.
|
||||
- [src/formats/rule_base.cpp](../src/formats/rule_base.cpp): normalizes live-scene defaults, league strength ranges, option defaults, stadium prices and capacities, betting limits, and the foreign-player limit across supported editions.
|
||||
- [src/formats/rule_base.hpp](../src/formats/rule_base.hpp): normalizes live-scene options, league strength ranges, option defaults, stadium prices and capacities, betting limits, and the foreign-player limit.
|
||||
- [src/game/career.cpp](../src/game/career.cpp): skips reserved calendar positions when assigning a joining manager to a club.
|
||||
- [src/game/career.hpp](../src/game/career.hpp): uses the supported player-generation ranges and excludes reserved calendar positions when assigning managers.
|
||||
- [src/game/desk_actions.cpp](../src/game/desk_actions.cpp): uses the supported transfer-fee arithmetic and designated set-piece fields.
|
||||
- [src/game/desk_actions.hpp](../src/game/desk_actions.hpp): supports designated set-piece records and the supported transfer-editor rules.
|
||||
- [src/game/environment.hpp](../src/game/environment.hpp): uses six monthly environment budgets across data editions while retaining the shared staff prices and academy player-generation strength bands.
|
||||
- [src/game/highscore.cpp](../src/game/highscore.cpp): reads the supported edition-specific high-score format from the loaded image.
|
||||
- [src/game/lineup.cpp](../src/game/lineup.cpp): disables the foreign-player limit in the supported rule profile.
|
||||
- [src/game/lineup.hpp](../src/game/lineup.hpp): disables the foreign-player limit and supports owner-bound designated set-piece selection.
|
||||
- [src/game/match.hpp](../src/game/match.hpp): uses the enhanced injury selection and suspension rules.
|
||||
- [src/game/match_engine.cpp](../src/game/match_engine.cpp): supports designated set-piece takers, the enhanced injury tables, and the extended suspension fields.
|
||||
- [src/game/season.cpp](../src/game/season.cpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
|
||||
- [src/game/season.hpp](../src/game/season.hpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
|
||||
- [src/game/state.hpp](../src/game/state.hpp): retains designated set-piece selections in the supported manager-record extension.
|
||||
- [src/game/week.cpp](../src/game/week.cpp): uses the enhanced training rules: focus strength is at least five below its target, and completed skills rotate to another focus.
|
||||
- [src/game/week.hpp](../src/game/week.hpp): uses the enhanced assistant-training rules, retaining the selected skill until it reaches its maximum.
|
||||
- [src/game/weekly.cpp](../src/game/weekly.cpp): uses the supported weekly-event configuration, with its rule switch disabled.
|
||||
- [src/game/weekly.hpp](../src/game/weekly.hpp): uses the supported weekly processing and transfer rule profile.
|
||||
- [src/modern/app/modern_session.cpp](../src/modern/app/modern_session.cpp): supports designated set-piece record initialization and validation.
|
||||
- [src/modern/app/modern_session.cpp](../src/modern/app/modern_session.cpp): native saves do not consume gameplay randomness for encryption.
|
||||
- [src/modern/content/world_expand.cpp](../src/modern/content/world_expand.cpp): Modern worlds have league sizes, clubs and players of their own; players whose nation has no single-byte nationality code carry a substitute foreign code.
|
||||
- [src/modern/game/career.cpp](../src/modern/game/career.cpp): in a Modern world a club's place in the strength band of its league follows the data set's ranking of the squads instead of the table place, and its players keep their relative values (balance.md).
|
||||
- [src/modern/game/career.cpp](../src/modern/game/career.cpp): skips reserved calendar positions when assigning a joining manager to a club.
|
||||
- [src/modern/game/career.cpp](../src/modern/game/career.cpp): retains an existing Modern club's league slot when a human joins, preserving its played results.
|
||||
- [src/modern/game/career.hpp](../src/modern/game/career.hpp): uses the supported player-generation ranges and excludes reserved calendar positions when assigning managers.
|
||||
- [src/modern/game/desk_actions.cpp](../src/modern/game/desk_actions.cpp): uses the supported transfer-fee arithmetic and designated set-piece fields.
|
||||
- [src/modern/game/desk_actions.cpp](../src/modern/game/desk_actions.cpp): Modern training camps have grades up to six stars with a capped step, a higher limit and recovery extras.
|
||||
- [src/modern/game/desk_actions.cpp](../src/modern/game/desk_actions.cpp): the Modern Toto takes up to six columns (one in the original), each at the stake plus a 10 % fee per extra column, 400,000 at most in all.
|
||||
- [src/modern/game/desk_actions.cpp](../src/modern/game/desk_actions.cpp): in Modern a training camp stay can bring an exclusive sponsor (shirt or four boards at 1.5 times the best regular offer), taken now or after the running contract.
|
||||
- [src/modern/game/desk_actions.hpp](../src/modern/game/desk_actions.hpp): supports designated set-piece records and the supported transfer-editor rules.
|
||||
- [src/modern/game/environment.hpp](../src/modern/game/environment.hpp): uses six monthly environment budgets across data editions while retaining the shared staff prices and academy player-generation strength bands.
|
||||
- [src/modern/game/highscore.cpp](../src/modern/game/highscore.cpp): reads the supported edition-specific high-score format from the loaded image.
|
||||
- [src/modern/game/matchday_setup.cpp](../src/modern/game/matchday_setup.cpp): in Modern worlds a referee may take a second match on a day with more matches than referees.
|
||||
- [src/modern/game/season.cpp](../src/modern/game/season.cpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
|
||||
- [src/modern/game/season.cpp](../src/modern/game/season.cpp): in Modern the age stops at 47, the most its five bits hold; real ages of a data set (a goalkeeper of 40) would otherwise run into the bits above.
|
||||
- [src/modern/game/season.hpp](../src/modern/game/season.hpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
|
||||
- [src/modern/game/week.cpp](../src/modern/game/week.cpp): uses the enhanced training rules: focus strength is at least five below its target, and completed skills rotate to another focus.
|
||||
- [src/modern/game/week.hpp](../src/modern/game/week.hpp): uses the enhanced assistant-training rules, retaining the selected skill until it reaches its maximum.
|
||||
- [src/modern/game/weekly.cpp](../src/modern/game/weekly.cpp): uses the supported weekly-event configuration, with its rule switch disabled.
|
||||
- [src/modern/game/weekly.hpp](../src/modern/game/weekly.hpp): uses the supported weekly processing and transfer rule profile.
|
||||
- [src/modern/ui/demo_calendar.cpp](../src/modern/ui/demo_calendar.cpp): the native season follows its saved start year (including leap days), rather than the HTML's fixed 2027/28.
|
||||
- [src/modern/ui/engine_achievements.cpp](../src/modern/ui/engine_achievements.cpp): shows recorded manager history between seasons without inventing future results.
|
||||
- [src/modern/ui/engine_balance.cpp](../src/modern/ui/engine_balance.cpp): viewing a balance is read-only and publishing a changed plan requires explicit confirmation.
|
||||
- [src/ui/league_table.hpp](../src/ui/league_table.hpp): uses three points for a win in the supported rule profile.
|
||||
- [src/ui/pitch.cpp](../src/ui/pitch.cpp): supports owner-bound designated set-piece selection in the extended manager record.
|
||||
- [src/ui/save_load.cpp](../src/ui/save_load.cpp): focuses the host save filename on entry and selects an existing name for replacement.
|
||||
- [src/ui/save_load.cpp](../src/ui/save_load.cpp): omits DOS drive and delete buttons in the directory-confined save/load view.
|
||||
- [src/ui/save_load.cpp](../src/ui/save_load.cpp): permits cancelling host file dialogs with the right mouse button.
|
||||
+171
@@ -0,0 +1,171 @@
|
||||
# OpenBMH Editor 0.5.5
|
||||
|
||||
Der eigenständige, native Editor verwendet **RmlUI und SDL2**, unter Windows mit Direct3D 11, unter Linux/macOS mit OpenGL. Er bearbeitet Startdatenbanken, keine laufenden Spielstände. Das Spiel und seine Classic-Prüfung bleiben unverändert. Editor 0.5.5 hat eine eigene Versionsreihe und den Release-Tag `editor-v0.5.5`; die Spielversion ist 0.2.1.
|
||||
|
||||
## Windows-Start und Diagnose
|
||||
|
||||
Windows verwendet Direct3D 11 und wechselt bei fehlender Hardware automatisch auf
|
||||
den integrierten WARP-Renderer. Der Editor und der Spiel-Launcher benötigen dort
|
||||
keinen OpenGL-Treiber. Dieser Start wird auch mit erzwungenem WARP auf Windows
|
||||
Server 2022 geprüft. Zum gezielten Testen lässt sich `OPENBMH_RML_DRIVER=warp`
|
||||
setzen; die normale Auswahl erfolgt automatisch.
|
||||
|
||||
Startfehler erscheinen in einem nativen Dialog und werden zusätzlich unter
|
||||
`%LOCALAPPDATA%\OpenBMH\OpenBMHEditor-startup.log` protokolliert. Bei einem
|
||||
Aufruf aus PowerShell/CMD kann auch stderr umgeleitet werden. Headless- und
|
||||
MCP-Aufrufe zeigen keinen modalen Fehlerdialog und behalten ihre Prozesscodes.
|
||||
|
||||
## Starten und Daten öffnen
|
||||
|
||||
Das vollständige Paket `OpenBMHEditor-0.5.5-<plattform>.zip` entpacken und `OpenBMHEditor.exe` (Windows) beziehungsweise `OpenBMHEditor` (Linux/macOS) starten. `assets/editor` muss beim Programm bleiben. Auf macOS kann die unsignierte Anwendung über **Rechtsklick → Öffnen** gestartet werden. Eine Signatur/Notarisierung ist nicht Bestandteil dieser Version. `OpenBMHEditor --version` zeigt die Editorversion ohne Grafikstart.
|
||||
|
||||
**Öffnen** bietet OBW-Dateien und entpackte Welten an. **BMH / FLTD importieren** liest einen Ordner mit einer unterstützten BMH- oder Football-Limited-Installation durch den bestehenden Konverter. Das Original wird nicht überschrieben. Eine bestehende Classic-OBW wird zunächst überprüft und dann in eine bearbeitbare Editorwelt übernommen.
|
||||
|
||||
**Demo öffnen** lädt ausschließlich synthetische Testdaten. Echte Vereine, Spielerdaten, Fotos und importierte Originalgrafiken gehören in getrennte, private Datenpakete.
|
||||
|
||||
## Bearbeiten
|
||||
|
||||
- Links einen Datenbereich auswählen; die Liste lässt sich durchsuchen, filtern, sortieren und seitenweise durchgehen. Rechts Änderungen mit **Anwenden** übernehmen. **Speichern** übernimmt auch die aktuellen Eingaben.
|
||||
- **Doppelklick** auf ein Land zeigt seine Ligen, auf eine Liga ihre Vereine und auf einen Verein dessen Spieler. Land, Liga und Verein werden als Filter übernommen. Ein einfacher Klick wählt weiterhin den Datensatz zum Bearbeiten aus. Nicht übernommene Eingaben werden vor dem Wechsel abgefragt.
|
||||
- Länder, Wettbewerbe, Vereine, Spieler, Kader, Stadien und Schiedsrichter lassen sich anlegen und bearbeiten. Referenzierte Datensätze werden erst nach Änderung ihrer Verknüpfungen gelöscht. Vereinswechsel zwischen Ligen aktualisieren auch deren Mitgliederlisten.
|
||||
- Spielwerte behalten ihre **quellenspezifischen Wertebereiche**. Ein Classic-Wert wird nicht auf eine erfundene 1–10-Skala umgerechnet. Neue Spieler ohne belegte Werte bleiben zunächst unbewertet.
|
||||
- Kader bleiben vollständig erhalten. Die Schaltfläche **24** schaltet lediglich die Seitengröße um. Spieler lassen sich über das Vereinsfeld verschieben, zum Tausch merken und mit einem anderen Spieler tauschen; die Pfeile ändern ihre Reihenfolge.
|
||||
- **Prüfen** zeigt überlieferte Quellenkonflikte. Eine Auswahl übernimmt den gewählten Wert; die übrigen Quellen bleiben erhalten. Fehlende Daten sind Hinweise, fehlerhafte Verknüpfungen oder unzulässige Werte blockieren Änderungen und Speichern.
|
||||
- Rückgängig/Wiederholen gilt gemeinsam für native Oberfläche und MCP. Noch nicht angewendete Eingaben werden bei externen Änderungen nicht automatisch ersetzt; eine veraltete Änderung muss nach Aktualisierung erneut geprüft werden.
|
||||
- **Bilder** und die Bildaktionen am Datensatz unterstützen PNG, JPEG, WebP und eigenständige SVG. Vor dem Import: Ausschnitt ziehen oder Werte eingeben, frei drehen, spiegeln. Ein unveränderter Import behält seine Originalbytes. Bearbeitete Rasterbilder werden PNG, SVG bleibt Vektor. Das Original und die Transformationswerte bleiben für erneutes Bearbeiten im Paket. Classic-Porträts werden aus ihren eingefrorenen Rezepten angezeigt; eine Umbenennung ändert das Gesicht nicht.
|
||||
- Bildänderungen am Spieler, Verein oder Wettbewerb erhalten eine eigene Zuordnung. Gemeinsame Platzhalter und Bilder anderer Datensätze bleiben dabei erhalten. Im Bereich **Bilder** kann ein gemeinsam verwendetes Bild bewusst zentral bearbeitet werden.
|
||||
- Ein Klick auf ein Wappen, Porträt, einen Pokal oder ein Bild in der Liste öffnet eine große, schreibgeschützte **Bildvorschau**. **Zum Asset** öffnet den zugehörigen Eintrag im Bereich **Bilder**. Bei zusammengesetzten Classic-Porträts ohne einzelne Bilddatei führt die Schaltfläche zur allgemeinen Bildübersicht. Das Anschauen verändert keine Daten; beim Wechsel bleiben offene Eingaben durch die Übernehmen-/Verwerfen-Abfrage geschützt.
|
||||
|
||||
**Speichern** erzeugt ausschließlich `.obw` im Profil **`editor-world-v1`, Format 1.1**. Editorwelten sind **noch nicht im Classic-Spiel startbar**. Die Bezeichnung ist im Editor sichtbar. Unbekannte Erweiterungen, nicht bearbeitete Dokumente, Quellnachweise und Bilder bleiben erhalten. Noch nicht im Formular angebotene Regeln, Kalender- und Finanzdaten werden erhalten, aber nicht als vollständig editierbare Bereiche ausgegeben.
|
||||
|
||||
Shortcuts: Ctrl/Cmd+O, Ctrl/Cmd+S, Shift+Ctrl/Cmd+S, Ctrl/Cmd+Z und Shift+Ctrl/Cmd+Z. In Textfeldern gilt die lokale Text-Rückgängig-Funktion.
|
||||
|
||||
## Zurück und Vorwärts
|
||||
|
||||
Ein **Rechtsklick** an beliebiger Stelle öffnet **Zurück / Vorwärts**. Dieselbe
|
||||
Navigation funktioniert mit **Alt+Links / Alt+Rechts** und den beiden seitlichen
|
||||
Maustasten. Nicht verfügbare Richtungen sind ausgegraut. Escape oder ein Klick
|
||||
außerhalb schließt das Menü.
|
||||
|
||||
Der Verlauf merkt Datenbereiche, Doppelklick-Absprünge, Vergleichsansichten und
|
||||
Asset-Verknüpfungen. Beim Zurückkehren werden Filter, Suche, Sortierung,
|
||||
Datensatzauswahl, Tabellenseite und Scrollpositionen wiederhergestellt.
|
||||
Filtereingaben und einfache Zeilenauswahl erzeugen keine einzelnen Verlaufsschritte.
|
||||
Offene Formulareingaben werden weiterhin vor dem Wechsel abgefragt; Abbrechen
|
||||
lässt die Position im Verlauf unverändert. Ein neuer Absprung nach Zurück ersetzt
|
||||
den bisherigen Vorwärtszweig. Das Öffnen einer anderen Welt, auch über MCP,
|
||||
setzt den Verlauf zurück. **Zurück** ist unabhängig von **Rückgängig** und ändert
|
||||
keine Daten.
|
||||
|
||||
Die Dropdowns verwenden die Gestaltung der Modern-Desktop-Untermenüs:
|
||||
leichte Verläufe, runde Popup-Listen, ein Häkchen am gewählten Wert und dieselbe
|
||||
Schriftgröße in geschlossenem Feld und Auswahlliste. Escape schließt zuerst die
|
||||
offene Auswahlliste. [Native Vergleichsbilder](qa/editor-navigation/README.md)
|
||||
zeigen die Darstellung in allen drei Themes.
|
||||
|
||||
## CPU im Leerlauf
|
||||
|
||||
Ab 0.5.4 zeichnet der Editor nur bei Eingaben, sichtbaren Änderungen oder von
|
||||
RmlUI angeforderten Zeitereignissen. Ein unveränderter Bildschirm benötigt keine
|
||||
fortlaufenden Frames. Textcursor, Animationen, Scrollen und externe MCP-Änderungen
|
||||
bleiben aktiv; minimierte Fenster zeichnen nicht. Die vorherige Dauerschleife
|
||||
konnte insbesondere mit dem WARP-Softwarerenderer unter Remote Desktop einen
|
||||
erheblichen Teil der CPU belegen. Import, Bildverarbeitung und andere tatsächliche
|
||||
Datenarbeit benötigen weiterhin Rechenzeit.
|
||||
|
||||
## Stärken und Gehälter vergleichen
|
||||
|
||||
**Wertevergleich** in der Seitenleiste (oder die gleichnamige Schaltfläche bei Spielern, Vereinen und Wettbewerben) öffnet eine Übersicht mit drei Ansichten: **Spieler**, **Mannschaften**, **Ligen**. Spieler zeigen ihre einzelnen Spielwerte und das Gehalt je Saison; Mannschaften und Ligen zeigen Durchschnittswerte, Spielergehaltssummen, das Durchschnittsgehalt und die Anzahl bekannter Gehälter. Ein Klick auf eine Zeile öffnet ihren Datensatz zur Bearbeitung.
|
||||
|
||||
- Auf einen Spaltenkopf klicken, um auf- oder absteigend zu sortieren. Sortiert wird der gesamte gefilterte Bestand vor der Aufteilung auf Seiten mit bis zu 200 Zeilen. Suche sowie Land-, Liga- und Vereinsfilter grenzen die Ansicht ein. Fehlende Zahlen stehen in beiden Sortierrichtungen hinten.
|
||||
- **Spalten auswählen** blendet beliebige vorhandene Spielwerte ein. Bei vielen Spalten horizontal scrollen; Tabellenkopf und Werte bewegen sich gemeinsam. Die Wertebereiche stehen im Spaltenkopf, Gruppenwerte sind spielergewichtete Durchschnitte über bekannte Werte. Der gesamte Kader einschließlich Reserve zählt; reine Quellenduplikate mit `x-simulation.squad_role: source-only-duplicate` werden ausgeschlossen und ihre Anzahl angezeigt.
|
||||
- Verschiedene Attributsysteme bleiben getrennt. Bei einem einzigen System werden dessen Spielwerte automatisch angezeigt. Bei mehreren ein **Attributsystem** wählen, um dessen Spieler und die daraus gebildeten Mannschafts-/Ligawerte zu vergleichen. Das FC-Attribut `strength` heißt in einem System mit `overall` **Körperkraft**; es wird nicht als Classic-Gesamtstärke interpretiert. Es wird keine neue Stärkeskala berechnet.
|
||||
- **Gehälter gelten je Saison**, in der Währung und kleinsten Einheit aus dem OBW-Manifest. Berücksichtigt werden zum Saisonstart gültige Verträge des Spielers mit seiner aktuellen Mannschaft. Personalverträge, abgelaufene und zukünftige Verträge zählen nicht. Mehrere gleichzeitig gültige Verträge derselben Zuordnung sind unklar und werden nicht addiert. Ohne Vertragsangabe steht **—**, ein ausdrücklich gespeichertes Nullgehalt bleibt **0**.
|
||||
- Unvollständige Gehaltssummen und Durchschnitte tragen ein **\***. Sie berücksichtigen nur bekannte Spielergehälter; die Spalte **Gehälter bekannt** zeigt die Abdeckung. Auch Spielwertdurchschnitte verwenden nur bekannte Werte (Anzahl per Tooltip). Classic-Grunddaten liefern häufig keine konkreten Verträge: Der Editor erfindet diese Gehälter nicht.
|
||||
|
||||
[Native Vorher-/Nachher-Bilder](qa/editor-comparison/README.md) dokumentieren die Ansichten und Spaltenauswahl.
|
||||
|
||||
Die Übersicht verändert weder Daten noch Undo-Historie. Änderungen und Rückgängig aktualisieren ihre Werte automatisch. Alle drei Themes und beide Sprachen werden unterstützt.
|
||||
|
||||
Über MCP liefert **`editor_compare`** dieselbe schreibgeschützte Übersicht. Beispielargumente:
|
||||
|
||||
```json
|
||||
{"table":"players","sort":"attributes.overall","descending":true,"limit":200}
|
||||
```
|
||||
|
||||
`table` ist `players`, `clubs` oder `leagues`. Weitere Sortierschlüssel sind `name`, `salary` (Spieler), `salary_total`, `salary_average`, `salary_known`, `player_count`, `club_count` sowie `attributes.<feld>`. `attribute_set` grenzt das System ein, `search`, `nation`, `competition`, `team` filtern, `offset`/`limit` blättern. Die Antwort enthält Originalskalen, Stichtag, Währung und Abdeckung. Gehälter bleiben Integer in kleinster Währungseinheit; das Durchschnittsgehalt wird auf diese Einheit gerundet. Das entsprechende Session-Kommando für Command-Scripts heißt `compare`.
|
||||
|
||||
## Optionen und MCP
|
||||
|
||||
**Optionen** bietet Deutsch/Englisch, Midnight Glass/Silver Glass/Matchday und den integrierten MCP-Server. Die Sprache ändert die Oberfläche; Namen und Quelldaten werden nicht übersetzt. Einstellungen werden im Benutzerprofil gespeichert.
|
||||
|
||||
Unter **Darstellung** stehen die drei Farbwelten der modernen Untermenüs zur Auswahl:
|
||||
|
||||
- **Midnight Glass:** Schiefergrau mit dezenten Mint-Akzenten.
|
||||
- **Silver Glass:** helle silbergraue Flächen mit Petrol-Akzenten.
|
||||
- **Matchday:** Graphit mit warmen Korall-Akzenten.
|
||||
|
||||
**Anwenden** wechselt das Theme ohne Neustart. Die Farbwahl gilt auch für Tabellen, Eigenschaften, Dropdowns, Meldungen und die Bildbearbeitung. [Native Vergleichsbilder](qa/editor-poc/README.md#theme-comparison) zeigen alle drei mit denselben synthetischen Daten.
|
||||
|
||||
Der MCP-Server ist standardmäßig aktiviert und bindet ausschließlich `127.0.0.1`, standardmäßig Port `8765`. Port `0` wählt einen freien Port. Status und tatsächlicher Port sind in Optionen sichtbar. **Verbindung kopieren** kopiert eine JSON-Konfiguration einschließlich Bearer-Token für HTTP-fähige MCP-Clients. Das Token bleibt lokal im Benutzerprofil und wird nur auf ausdrückliches Kopieren/CLI-Anfordern ausgegeben. Ein anderer bereits laufender Editor kann den Standardport belegen; dann einen anderen Port wählen.
|
||||
|
||||
Implementiert ist [MCP Streamable HTTP 2025-11-25](https://modelcontextprotocol.io/specification/2025-11-25/basic/transports), mit Aushandlung von 2025-06-18; JSON-Antworten, ohne optionale SSE-Sitzungen. Neuere MCP-Versionen werden nicht als unterstützt beworben. Der Server prüft Token, Host und gegebenenfalls Origin. Oberfläche und Agent bearbeiten dieselbe Welt, verwenden dieselbe Validierung und dieselbe Undo-Historie. Für konkurrierende Änderungen `expected_revision` aus `editor_info`/`editor_get` mitsenden. `editor_info.world_generation` kennzeichnet die aktuell geladene Welt innerhalb der Sitzung: Öffnen/Neu erhöht den Wert, Bearbeiten, Speichern und Rückgängig behalten ihn bei. Er wird nicht im OBW gespeichert.
|
||||
|
||||
Werkzeuge: `editor_info`, `editor_open`, `editor_new`, `editor_list`, `editor_compare`, `editor_regulations`, `editor_get`, `editor_apply`, `editor_rules`, `editor_validate`, `editor_history`, `editor_save`, `editor_undo`, `editor_redo`, `editor_roster_move`, `editor_roster_swap`, `editor_roster_order`, `editor_review_resolve`, `editor_image_import`, `editor_image_edit`, `editor_image_preview`, `editor_image_export`. Die eingeblendeten Tools enthalten Parameterschemata und Beschreibungen. Öffnen einer anderen Welt verwirft ungespeicherte Änderungen nur mit `discard: true`.
|
||||
|
||||
## Spiel- und Ligaregeln ansehen
|
||||
|
||||
**Regelwerk** zeigt Auf- und Abstieg, Ziel-Ligen, Relegation und internationale
|
||||
Qualifikation. Wettbewerbe lassen sich durchsuchen und nach Land filtern.
|
||||
**Spielregeln** zeigt die übernommenen Einträge aus `world/rules.json`, etwa
|
||||
Wertebereiche, Kreditfaktoren, Trainingslager und Classic-Verfahren. Phasen und
|
||||
weitere Originalfelder sind ebenfalls einsehbar. Dieser Bereich ist vollständig
|
||||
schreibgeschützt; er verändert weder Welt noch Undo-Historie.
|
||||
|
||||
Explizite OBW-Regeln werden direkt dargestellt. Bei Classic-Importen kennzeichnet
|
||||
die Ansicht die versionierten Classic-Verfahrensregeln. Parallel-Ligen behalten
|
||||
Meister plus bedingte Relegationsplätze; die unterste Liga nutzt den Nachrückerpool.
|
||||
Internationale Plätze folgen dem ursprünglichen Champions-League-/UEFA-/
|
||||
Pokalsieger-Cup-Verfahren. Nicht festgelegte Regeln bleiben als solche sichtbar.
|
||||
Das sind keine heutigen UEFA-Regeln und kein neuer Saison-Simulator.
|
||||
`editor_regulations` bietet dieselben Informationen schreibgeschützt über MCP.
|
||||
|
||||
## Kompilieren
|
||||
|
||||
Voraussetzungen entsprechen dem Hauptprojekt: C++20-Compiler, Git, CMake ≥ 3.24 und Ninja. Windows: Visual Studio 2022 C++ Build Tools / x64 Native Tools Prompt; macOS ARM: Xcode Command Line Tools, CMake und Ninja; Linux: GTK3-, X11- und OpenGL-Entwicklungspakete wie im Haupt-README. Windows nutzt Direct3D 11 mit automatischem WARP-Software-Fallback; Linux benötigt OpenGL 3.3, macOS OpenGL 4.1.
|
||||
|
||||
```sh
|
||||
cmake -S . -B build-editor -G Ninja -DCMAKE_BUILD_TYPE=Release -DOPENBMH_BUILD_EDITOR=ON
|
||||
cmake --build build-editor --target openbmh_editor editor_core_tests editor_comparison_tests editor_regulations_tests --parallel 2
|
||||
ctest --test-dir build-editor -C Release -R '^editor_(core_tests|comparison_tests|regulations_tests|version)$' --output-on-failure
|
||||
```
|
||||
|
||||
macOS ARM zusätzlich bei der Konfiguration: `-DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0`. Unter Windows das Argument nach `-R` ohne einfache Shell-Anführungszeichen verwenden. Der Editor wird beim normalen Spiel-Build standardmäßig nicht mitgebaut.
|
||||
|
||||
```sh
|
||||
build-editor/OpenBMHEditor --demo
|
||||
build-editor/OpenBMHEditor --headless --open world.obw --validate
|
||||
build-editor/OpenBMHEditor --headless --open world.obw --output edited.obw
|
||||
build-editor/OpenBMHEditor --serve --open world.obw --mcp-port 8765
|
||||
build-editor/OpenBMHEditor --stdio-mcp --open world.obw
|
||||
```
|
||||
|
||||
Weitere Argumente: `--settings datei.json`, `--assets verzeichnis`, `--commands script.json`, `--print-mcp-config`. Ein Command-Script ist ein Array aus `{"command":"…","args":{…}}`, mit denselben Kommandos wie die gemeinsame Session (z. B. `get`, `apply`, `save`). `--headless` startet kein Fenster. `--stdio-mcp` bietet dieselben Werkzeuge über newline-delimited JSON-RPC; stdout enthält dabei ausschließlich Protokollnachrichten. Testaufnahmen: `--screenshot bild.png --quit-after-ms 1800 --page clubs` (unter Linux mit Xvfb möglich).
|
||||
|
||||
Pakete baut `tools/package/make_editor_package.py --build build-editor --out dist --platform linux-x64` (oder `windows-x64`, `macos-arm64`). `--source-package` ergänzt den zugehörigen Quellcode mit den tatsächlich verwendeten, gepinnten Abhängigkeiten. Die CI **OBW Editor** baut und prüft alle drei Plattformen. Tags `editor-v<version>` erzeugen nach erfolgreicher Prüfung einen Release-Entwurf. Die nativen Tests unterscheiden sich von einem späteren menschlichen GUI-Test auf Windows/macOS.
|
||||
|
||||
## English quick start
|
||||
|
||||
Extract the complete package and run **OpenBMHEditor**. Open an OBW archive or an unpacked world, import a supported BMH/Football Limited installation, or open the synthetic demo. Use the sidebar, searchable/filterable list and property inspector; **Apply** records one shared, undoable transaction. **Save** writes only an **OBW 1.1 editor world**, not a playable Classic mod or a legacy installation.
|
||||
|
||||
Use **Comparison** to inspect sortable player, team and league ratings and per-season salaries. Select attribute columns and filter by country, league, club or attribute system. Group ratings are player-weighted means; salary totals and means use known player contracts only and explicitly flag incomplete coverage. Missing values remain unknown. The read-only MCP tool `editor_compare` returns the same data.
|
||||
|
||||
Use **Regulations** to inspect promotion, relegation, playoffs, international qualification and stored game rules. Explicit OBW declarations and versioned Classic policies are distinguished; missing rules stay unspecified. This page and `editor_regulations` are read only.
|
||||
|
||||
The editor retains full squads, original image data, source claims and unknown extensions. Its 24-player view does not remove players. Image import offers normalized crop, arbitrary rotation and mirroring; re-editing uses the preserved source. Classic portraits keep their frozen appearance recipe. Unsupported editing areas are preserved rather than replaced.
|
||||
|
||||
Click a crest, portrait, trophy or list thumbnail to open a large read-only image preview. **View asset** opens its linked asset record; composed Classic portraits without a single image file lead to the image library. Viewing preserves the world and pending property edits.
|
||||
|
||||
In **Options**, switch the interface to **English**, choose one of the three themes, and enable/disable the integrated local MCP server. **Copy connection** provides the authenticated configuration. The server defaults to loopback port 8765; use port 0 for a free port. GUI and MCP share the same world, validation and undo history. It supports MCP Streamable HTTP 2025-11-25/2025-06-18 and optional stdio mode. Use `expected_revision` for concurrent edits.
|
||||
|
||||
Build with the three commands above, including `-DOPENBMH_BUILD_EDITOR=ON`. Windows uses Direct3D 11 with automatic WARP software fallback. Linux requires OpenGL 3.3; macOS requires OpenGL 4.1, plus the documented platform development dependencies. Editor 0.5.5 is unsigned and does not bundle any real-world dataset or proprietary game assets.
|
||||
@@ -0,0 +1,194 @@
|
||||
# Engine split: Classic, Classic Extended and Modern
|
||||
|
||||
Status: **concept and migration plan**. It prepares one shared match engine under the season engines of three game variants. Nothing in this document changes the behaviour of the current release.
|
||||
|
||||
## 1. Goal
|
||||
|
||||
OpenBMH will offer three game variants:
|
||||
|
||||
| Variant | Data | Season engine | Interface | State |
|
||||
|---|---|---|---|---|
|
||||
| **Classic** | Imported from the user's BMH or FLTD installation (OBW `runtime:classic-v1`) | Classic: fixed calendar, 9 leagues, original competition structure and rules | Classic 320×200 bitmap interface | Essentially complete |
|
||||
| **Classic Extended** | Classic data, optionally extended where the classic screens can show it | Working idea: Classic engine plus features **backported from Modern**, step by step (§4) | Classic bitmap interface, extended by hand per feature | Open; after Modern |
|
||||
| **Modern** | New OBW data set (imported and extended, or own worlds) | Modern: generated calendar, data-driven leagues and competitions, playable foreign leagues, leagues larger than 12 teams | New high-resolution interface (RmlUi), designed for many leagues | Interface in progress |
|
||||
|
||||
All three use **the same match engine**. A match between two given teams under the same rules is simulated by the same code in every variant; only what happens around it (calendar, competitions, finances, transfers, development) differs.
|
||||
|
||||
### 1.1 Where a change belongs
|
||||
|
||||
- **Classic** receives changes that work with the imported original assets and the original data layout: bug fixes, quality of life, small rule corrections, menus such as the environment menu of a later DIAMOND release.
|
||||
- **Modern** is where new features are designed first, without the limits of the original screens or data layout: more leagues, foreign leagues with more than 12 teams, a free calendar, new competitions and systems.
|
||||
- **Classic Extended** takes Modern features back into the Classic engine **one at a time**, where the bitmap interface can present them with reasonable manual work. The classic screens were never designed for variable structures, so Classic Extended will never offer every Modern feature; each backport is a decision of its own (§4).
|
||||
|
||||
## 2. Target architecture
|
||||
|
||||
```
|
||||
Classic UI (bitmap) Classic UI + extra screens Modern UI (RmlUi)
|
||||
| | |
|
||||
+---------------- app / protocol layer (capabilities) -------+
|
||||
| | |
|
||||
season: classic season: classic + backported features season: modern
|
||||
(GameState image) (GameState image + extension state) (typed OBW model)
|
||||
| | \ / |
|
||||
| | shared feature modules |
|
||||
| | (bmh_features, ports) |
|
||||
+------------------ match adapter (per engine) --------------+
|
||||
|
|
||||
match engine (bmh_match: typed contract)
|
||||
|
|
||||
random sources, attribute set bmh-classic@1
|
||||
```
|
||||
|
||||
### 2.1 Libraries
|
||||
|
||||
| Target | Contents | May depend on |
|
||||
|---|---|---|
|
||||
| `bmh_match` | Minute simulation, events, chances, cards, injuries during the match, substitutions, live interventions, the Reality scene and reporter | `random`, the match contract types; **not** `GameState`, calendar, finances |
|
||||
| `bmh_season_classic` | Today's `src/game` without the match core: turn driver, weekly/monthly/season processing, cups, transfers, finances, post-match effects | `bmh_match`, `bmhcore` formats |
|
||||
| `bmh_season_classic_ext` | Classic Extended: registry of backported features, their state and hook points in the Classic turn (§4) | `bmh_season_classic`, `bmh_features` |
|
||||
| `bmh_features` | Season features written once for Modern and reusable by Classic Extended, each against small **ports** (interfaces) instead of a concrete state model | the match contract types only |
|
||||
| `bmh_season_modern` | New season engine on the typed OBW model (§5) | `bmh_match`, `bmh_features`, `bmh_world` |
|
||||
| `bmh_world` | Typed OBW model, reader/writer, validator (`src/content`, `src/import`) | `bmhcore` formats |
|
||||
|
||||
The dependency rules: **the match engine knows no season engine**; no season engine reaches into the state of another; **no season engine knows an interface**; a feature in `bmh_features` knows neither `GameState` nor the OBW model, only its ports.
|
||||
|
||||
### 2.2 Writing Modern features so they can be backported
|
||||
|
||||
Backporting is cheap only if a feature is written for it from the start:
|
||||
|
||||
- The rules of a feature (for example youth development, a staff system, sponsor negotiation) live in `bmh_features` and read and write the game only through a port: `PlayerRoster`, `ClubFinance`, `Calendar`, `Mailbox`, `RandomSources` and similar narrow interfaces.
|
||||
- Modern implements the ports on the typed model. Classic Extended implements the same ports as adapters on `GameState` plus its extension state.
|
||||
- A feature declares what it needs (ports, data fields, calendar events) and which presentation it needs (screens, messages). This declaration is the checklist for a backport: if the Classic adapter cannot provide a port, or no classic screen can show the result, the feature stays Modern-only.
|
||||
- Features that depend on Modern-only structures (generated calendar, generic competition stages, leagues of variable size) are marked as such and are not candidates.
|
||||
|
||||
## 3. The match contract
|
||||
|
||||
Today the match core reads and writes the memory image directly: `MatchGroup` holds raw descriptors, and `matchday.cpp` mixes the minute loop with season effects (`finish_match`, `update_club_table`, `update_morale`, `develop_players`, `book_money`, `injure_player`, `rate_manager`). The split replaces this with typed input and output.
|
||||
|
||||
### 3.1 Input: `MatchdaySetup`
|
||||
|
||||
The contract works per **matchday batch**, not per single match: the original walks all match groups and all matches every minute, so the random numbers of different matches are interleaved. A batch keeps that order exactly for Classic; Modern may pass a batch of one.
|
||||
|
||||
```
|
||||
MatchdaySetup
|
||||
rules per group: competition kind (league, cup, friendly, indoor),
|
||||
half length (45 / 20), stoppage, extra time, penalties,
|
||||
away-goals and away-penalty flags, leg and first-leg score
|
||||
groups[] matches[]: home TeamSheet, away TeamSheet, venue, spectators
|
||||
random RandomSources (see 3.3)
|
||||
live optional LiveControl (see 3.4)
|
||||
|
||||
TeamSheet
|
||||
team id, side, players on the pitch and bench (player id, position, slot,
|
||||
attributes of set bmh-classic@1, condition, form, morale, cards already held),
|
||||
formation, tactic items, attitude, captain, penalty and free-kick takers,
|
||||
automation flags (computer-controlled tactics)
|
||||
```
|
||||
|
||||
Everything a match needs is copied into the setup. The engine does not look anything up.
|
||||
|
||||
### 3.2 Output: `MatchdayResult`
|
||||
|
||||
```
|
||||
per match: final score per phase (regular, extra time, penalties), end minute,
|
||||
event list (minute, kind, team, players: goal, assist, chance,
|
||||
card, injury with severity, substitution, tactical change),
|
||||
player ratings and statistics, side records (typed form of the
|
||||
18 legacy record bytes), live-intervention log
|
||||
```
|
||||
|
||||
The engine reports **facts**. Consequences belong to the season engine: league tables, money, morale, player development, suspensions counted per competition, injury duration in days, manager ratings, mail and press. Classic applies them exactly as today; Modern applies its own rules to the same facts.
|
||||
|
||||
### 3.3 Random numbers
|
||||
|
||||
The match engine draws only through an injected `RandomSources` interface with the two streams the original uses (`WatcomRandom`, `GameRandom`, see `docs/RNG.md`).
|
||||
|
||||
- Classic passes the session's global streams, so consumption order and regression results stay identical.
|
||||
- Modern passes streams seeded per matchday (or per match) from the world seed, so a match can be replayed on its own.
|
||||
|
||||
### 3.4 Live matches
|
||||
|
||||
`LiveControl` is the only channel for human influence during a match: pause points (half time, events that request a lineup), substitutions, tactic and attitude changes, and the minute clock barrier of multi-client sessions. The Reality scene (`reality_*`) is a presentation of the same simulation and moves with the match engine. Interfaces receive match progress as events; none of them calls into the minute loop directly.
|
||||
|
||||
### 3.5 Attribute set
|
||||
|
||||
The match engine consumes players in attribute set `bmh-classic@1` (OBW §5.3). Classic already stores exactly this. Modern may keep richer attributes for its own systems, but provides a `bmh-classic@1` projection for every player it sends into a match. A later, finer match model would be a **new version** of the match engine with its own attribute set, selectable per variant; it is not part of this plan.
|
||||
|
||||
### 3.6 Versioning
|
||||
|
||||
`bmh_match` carries a contract version (`match@1`). Saves record the version they were played with. A behavioural change to the match engine is a new version, noted in `docs/DIFFERENCES.md`, and is checked against all three variants before it lands.
|
||||
|
||||
## 4. Classic Extended
|
||||
|
||||
> **Working idea, not a decision.** Backporting Modern features into the Classic engine is the current idea for Classic Extended; the variant may take a different shape. What does not depend on it: the shared match engine (§3), the Modern engine driven only through the protocol, and features written against ports (§2.2), which keep several options open.
|
||||
|
||||
Classic Extended is the **Classic season engine plus backported Modern features**, presented in the classic bitmap interface.
|
||||
|
||||
- **Invariant:** with every backported feature switched off, Classic Extended produces exactly the Classic results. A test runs the Classic regression through the Extended engine with no features.
|
||||
- Each backported feature is a module with an id and version, its own state (`x-extended/` in OBW saves), the Classic adapters for its ports and its classic-style screens. A career records which features it uses; features can be switched on at career start and, where safe, later.
|
||||
- Features hook into defined points of the Classic turn (start/end of day, week, month and season; before/after a matchday; desk actions), never into the middle of a Classic routine.
|
||||
- **Data:** Classic Extended starts from Classic data. A feature may bring additional data, but only in a shape the classic screens can show. Structures that change the size of what the screens list (more or larger leagues, new competitions) are Modern-only unless a specific screen is redesigned for them.
|
||||
- **Interface cost per feature**, the main factor in each backport decision:
|
||||
1. The result fits existing screens (a new value on the player card, a message, a desk action): small.
|
||||
2. A new screen of fixed size in the classic style (a staff or youth screen): medium, new own artwork needed.
|
||||
3. A screen whose content grows with the data (longer tables, more league selectors, calendar views): large, often not worth it.
|
||||
- **Assets:** the original bitmaps of the user's installation plus new classic-style artwork. New artwork must be the project's own.
|
||||
- Order of work: a feature is built and settled in Modern first, then backported if its ports and its presentation fit (§2.2).
|
||||
|
||||
## 5. Modern
|
||||
|
||||
> **Decision for 0.3 (October 2026):** Modern starts as a **fork of the Classic season core** in `src/modern/`, sharing formats, `GameState` (with a world layout) and the match core with Classic. It runs only on Modern data sets and moves away from Classic step by step; Classic stays unchanged. The typed engine described below remains the direction, reached gradually rather than by a rewrite. The 0.3 plan, status and UI interface are documented in German under [new_engine](new_engine/README.md).
|
||||
|
||||
Modern is a new season engine on the typed OBW model (`docs/formats/OBW.md`):
|
||||
|
||||
- **Data set:** an OBW world that goes beyond the original structure, for example foreign leagues with more than 12 teams, more leagues (up to 32) and real-world competition formats. It can start from an imported Classic world and be extended, or be a world of its own.
|
||||
- **Calendar:** generated each season from `world/calendar.json` (series, windows, events) instead of a fixed day table; any season start, international windows, winter breaks per nation.
|
||||
- **Competitions:** the generic stage model (league, groups, league phase, knockout, playoff, final) with declarative slots and promotion/relegation; foreign leagues are playable, not only simulated.
|
||||
- **Systems:** finances, transfers, contracts, youth, staff and development are rewritten on the typed model, reusing Classic formulas where they fit and documenting where they differ.
|
||||
- **Interface:** the RmlUi client through the app/protocol layer only.
|
||||
- Matches always go through the shared match contract (§3).
|
||||
|
||||
Modern does not have to reproduce Classic results; its quality gate is plausibility (seasons simulated in bulk, agentic QA, fan expectations), not bit equality.
|
||||
|
||||
## 6. Variant selection and saves
|
||||
|
||||
- The world or save manifest names the runtime: `requires: ["runtime:classic-v1"]`, `["runtime:classic-extended-v1"]` (with the list of active features and their versions) or `["runtime:modern-v1"]`, plus `match@1`.
|
||||
- `CareerSession` selects the season engine from the manifest; the protocol reports **capabilities** per engine and feature, so interfaces and console clients only offer supported actions.
|
||||
- Conversions are **one-way**: Classic → Classic Extended (switch features on), Classic or Classic Extended → Modern (convert to the typed model; backported feature state maps to the Modern original of the feature). There is no way back, and the original file is kept.
|
||||
- **All variants save only in the OBW format** (`.obs`). Legacy `.FBM` saves are an import source only: they are converted into a Classic `.obs` career and never written.
|
||||
|
||||
## 7. Migration plan
|
||||
|
||||
Each step keeps the game playable and the Classic regression (`tools/regression/checkonly.sh`, season simulations, long runs) unchanged.
|
||||
|
||||
| Step | Content | Gate |
|
||||
|---|---|---|
|
||||
| 0 | Freeze the Classic baseline: tag, record regression outputs and long-run statistics as reference | Reference recorded |
|
||||
| 1 | Move the match core (`match_engine`, `match`, `reality_*`, reporter) into `src/match` and target `bmh_match`; no behaviour change | Regression identical |
|
||||
| 2 | Introduce `RandomSources`; the match core no longer touches the global streams directly | Regression identical |
|
||||
| 3 | Typed `MatchdaySetup`/`MatchdayResult`; Classic adapter builds the setup from `MatchGroup`/`GameState` and writes results back; move post-match effects out of the minute loop into `bmh_season_classic` | Regression identical; match contract tests |
|
||||
| 4 | Remove the remaining `GameState` dependencies from `bmh_match` (enforced by the build: `bmh_match` does not link `GameState`) | Build rule; regression identical |
|
||||
| 5 | Runtime field in manifests, engine selection in `CareerSession`, capability reporting in the protocol | Classic unchanged; capability tests |
|
||||
| 6 | `bmh_features` with the first ports; Modern season engine on `bmh_world`, first with one nation and the shared match engine, then the competition model, then foreign leagues and larger leagues | Modern plausibility runs |
|
||||
| 7 | Classic Extended skeleton: feature registry, hook points, `x-extended` state, Classic adapters for the first ports, "no features = Classic" test | Regression identical through Extended |
|
||||
| 8 | Backports one feature at a time, each with its interface cost assessed (§4) | Per feature: Classic regression with the feature off, plausibility with it on |
|
||||
| 9 | Classic → Modern conversion of worlds and careers | Converted careers playable |
|
||||
|
||||
Steps 1 to 4 are the actual split and the risky part; they are pure refactoring and must be done in small commits with the regression after each. Classic improvements continue in parallel on `bmh_season_classic`.
|
||||
|
||||
For 0.3 the order changes: the Modern fork (phases M0–M7 in [new_engine](new_engine/phasen.md)) comes first and shares the match core as it is; steps 1 to 4 follow later and then serve both season cores.
|
||||
|
||||
## 8. Tests
|
||||
|
||||
- **Match contract tests:** a fixed `MatchdaySetup` with fixed seeds yields a fixed `MatchdayResult` (golden files with synthetic teams, public).
|
||||
- **Classic regression:** unchanged scripts and expected outputs; run after every step.
|
||||
- **Extended identity:** the Classic regression through the Extended engine with no features.
|
||||
- **Feature tests:** each module in `bmh_features` is tested once against fake ports, then through both adapters (Modern and Classic Extended).
|
||||
- **Modern plausibility:** bulk season simulations with goal, points and money distributions compared to Classic as a reference band.
|
||||
- **Dependency checks:** the build fails if `bmh_match` includes season or `GameState` headers, if `bmh_features` includes `GameState` or OBW model headers, or if a season engine includes interface headers.
|
||||
|
||||
## 9. Open decisions
|
||||
|
||||
- Which features become the first backport candidates (proposal: features of interface cost 1 or 2 that do not change league structure).
|
||||
- Whether Modern keeps `bmh-classic@1` as its only player attribute set at first (proposal: yes, richer attributes later as a new match engine version).
|
||||
- Ownership: the split and Classic (engine/integration), the Modern interface (UI), Modern features and their backports (shared, per feature).
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
# Random generators
|
||||
|
||||
OpenBMH uses two explicit stateful generators in `src/game/random.hpp`. Frontends do not create gameplay randomness. Save and rollback operations must preserve the relevant generator state and call order.
|
||||
|
||||
## General generator
|
||||
|
||||
The compatibility generator uses a 32-bit unsigned linear recurrence:
|
||||
|
||||
```text
|
||||
seed = seed * 0x41C64E6D + 0x3039 (modulo 2^32)
|
||||
r = (seed >> 16) & 0x7FFF
|
||||
n = hi - lo + 1
|
||||
product = signed32(unsigned32(r) * unsigned32(n))
|
||||
result = lo + product / 32768
|
||||
```
|
||||
|
||||
The product wraps at 32 bits and signed division truncates toward zero. For an empty range it returns the lower bound without drawing. A run's initial seed is supplied explicitly by the session/CLI when reproducibility is required.
|
||||
|
||||
## Game generator
|
||||
|
||||
The second stream has a separate recurrence and can be reseeded by defined game operations:
|
||||
|
||||
```text
|
||||
seed = signed32(unsigned32(seed) * 16 + 0xA7) % 4000000
|
||||
product = signed32(unsigned32(seed) * unsigned32(hi - lo + 1))
|
||||
result = product / 4000000 + lo
|
||||
```
|
||||
|
||||
Signed division truncates toward zero; overflow in the indicated products wraps at 32 bits before signed interpretation. Replacing this with floating-point arithmetic or a standard-library distribution changes results. Negative intermediate values must retain their specified semantics.
|
||||
|
||||
Observing or rendering a value should not draw random numbers unless opening that actual game operation requires it. Transactional failures restore both streams with the game state. A seed alone is not a complete replay specification: engine version, data, options and command order also matter.
|
||||
@@ -0,0 +1,38 @@
|
||||
# Roadmap
|
||||
|
||||
OpenBMH combines a playable reconstruction with a foundation for extension. These milestones describe direction and dependencies, not promised dates.
|
||||
|
||||
## 0.1: a usable engine
|
||||
|
||||
Career management, matches, finances, transfers, original-style SDL2 screens, audio and a console share the same session logic. German game data is the primary target; Football Limited support is experimental. Compatibility and remaining limitations are documented in the [release notes](release/0.1/RELEASE_NOTES.md).
|
||||
|
||||
## 0.15: broader English compatibility
|
||||
|
||||
Complete edition-specific loading, presentation, competitions and sound support. Imported content determines names, text, clubs and league organisation; a shared engine rule base defines the simulation.
|
||||
|
||||
## 0.2: portable Classic content and native saves
|
||||
|
||||
Import a supplied BMH or Football Limited installation through the launcher into a
|
||||
sealed [OBW](formats/OBW.md) Classic mod. Run the original-style interface and
|
||||
console exclusively from converted content, with native careers and preferences
|
||||
stored separately. Legacy save migration is an import operation. See the
|
||||
[0.2 release notes](release/0.2/RELEASE_NOTES.md) and
|
||||
[runtime contract](formats/obw/runtime-0.2.md).
|
||||
|
||||
Modern game screens are deferred. The Modern UI POC remains separate from the
|
||||
0.2 distribution. Replacing the remaining compatibility blocks with typed clubs,
|
||||
players, contracts and competitions is subsequent work, not a completed 0.2 claim.
|
||||
|
||||
## 0.3: configurable rules
|
||||
|
||||
Expose rule values and balance choices as configuration, with reproducible simulations to assess changes. Improve tactical automation, transfer decisions and scoring distributions through documented changes rather than hidden edition-specific branches.
|
||||
|
||||
## 0.4: adaptable interfaces and competitions
|
||||
|
||||
Add a scalable interface (RmlUi) through the shared application/protocol boundary. Make league sizes and competition structures data-driven. Define content-pack formats for independently licensed artwork, names and other resources; do not distribute third-party material without permission.
|
||||
|
||||
## 0.5: independently distributable content
|
||||
|
||||
Provide original or freely licensed graphics, sound and generated football worlds so that OpenBMH can be played without proprietary game data. Support editors, new competitions and multiplayer clients built on the same engine interfaces.
|
||||
|
||||
The typed model and open format are prerequisites for flexible competitions, configurable rules and new content. See [architecture](architecture.md) for the current boundaries and [compatibility decisions](COMPATIBILITY.md) for intentional departures.
|
||||
@@ -0,0 +1,78 @@
|
||||
# Architecture
|
||||
|
||||
OpenBMH is a C++20 engine with graphical and console frontends. The implementation reads externally supplied game data; it does not execute the original program. See [file formats](formats/README.md) for the compatibility representations and [roadmap](ROADMAP.md) for the planned typed model.
|
||||
|
||||
## Layers
|
||||
|
||||
| Directory | Responsibility |
|
||||
|---|---|
|
||||
| `src/formats` | Binary readers, explicit-width records, palettes, fonts, images, text, executable-data loading and save containers |
|
||||
| `src/game` | Game state, random generators, career setup, scheduling, match simulation, accounting and weekly/monthly/seasonal progression |
|
||||
| `src/app` | CareerSession, shared actions, revisions, ownership, transactional publication and rollback |
|
||||
| `src/ui` | View projections, rendering and input interpretation for game screens |
|
||||
| `src/cli` | Command language, structured protocol, console windows and multi-client seat routing |
|
||||
| `src/audio` | Bank decoding, synthesis, playback and cues, without authority to change gameplay |
|
||||
| `src/launch` | RmlUI launcher, portable mod library, child processes and legacy installation discovery |
|
||||
| `src/modern/ui` | Opt-in native Modern UI with a read-only world catalogue and a replaceable presentation data source |
|
||||
| `src/content` | Sealed OBW content, native career containers and personal preferences |
|
||||
| `src/import` | Legacy installation and save-layout conversion; original readers are used here |
|
||||
|
||||
`bmhcore` contains the format and game layers. `bmhui`, `openbmh_audio` and the application session provide reusable pieces above it. Frontends should translate actions and display results; they should not introduce independent transfer, calendar or financial rules.
|
||||
|
||||
The experimental Modern frontend uses namespace `bmh::modern_ui`, preserving
|
||||
the Modern season fork's existing lookup of `bmh::ui`. Its current `DemoSource`
|
||||
owns presentation-only fixtures and separate JSON checkpoints; it neither
|
||||
constructs a career nor starts matches. See [native UI status](new_ui/NATIVE_STATUS.md)
|
||||
for the implemented slice and outstanding HTML transfers. Shared archive/image
|
||||
helpers live in `bmh_asset_io`, without linking the editor GUI or MCP server.
|
||||
|
||||
## Session boundary
|
||||
|
||||
`CareerSession` owns the live game, the two random streams and progression state. Requests identify the manager and the revision they observed. Shared actions validate that identity, stage state and random effects, and publish supported results together. Rejected requests must not leave partial transactions.
|
||||
|
||||
Some calendar operations need synchronous human decisions. Their presenters own a staged state until the question or editor returns. A console worker hands control to the input thread while paused; exactly one thread operates on that transaction at a time. Cancellation, failure and process shutdown must release the owner and preserve the transaction's rollback contract. A view must not read live state as though it were the paused staged state.
|
||||
|
||||
## Calendar and matches
|
||||
|
||||
The planned split into one shared match engine and the season engines of Classic, Classic Extended (Classic plus backported Modern features) and Modern is described in [ENGINE_SPLIT](ENGINE_SPLIT.md).
|
||||
|
||||
The turn driver moves between manager desks, match clocks and calendar events. Weekly, monthly and seasonal processing can produce decisions as well as simulation results. Match groups contain the day's competitions; a manager can intervene only in a group involving that manager's team. A multi-client match clock advances at a barrier shared by all seats.
|
||||
|
||||
## Compatibility state
|
||||
|
||||
The current game model combines interpreted vectors with fixed-layout compatibility blocks. Identifiers are not interchangeable: a club's stable identity, current runtime team index, squad row and player id represent different things. Guard each at its boundary. Fixed offsets belong to file/layout code; preserve integer widths and signedness when porting calculations.
|
||||
|
||||
Legacy saves serialize blocks in a fixed order and store name pools separately. Runtime UI owners, pending input and frontend capabilities are not additional save fields. See [FBM](formats/FBM.md), [state records](formats/STATE.md) and [RNG](RNG.md).
|
||||
|
||||
## Public interfaces and validation
|
||||
|
||||
The [console reference](CLI_CONCEPT/README.md) documents window commands. [protocol.md](protocol.md) describes structured requests, and [CONSOLE_CLIENTS.md](CONSOLE_CLIENTS.md) explains safe client ownership and batching. Prefer shared projections/actions when adding another frontend.
|
||||
|
||||
Use synthetic data for public tests and locally supplied installations only for data-dependent checks. Renderer tests, simulation tests and target-platform runtime checks answer different questions; document what each validates. See [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||
|
||||
## 0.2 content boundary
|
||||
|
||||
Normal GUI and console entrypoints accept sealed Classic OBW packages. `content::Mount`
|
||||
owns a shared immutable decoded store; existing path-shaped UI aliases identify resources
|
||||
inside it, without creating VGA/FNT/EXE files or falling back to an installation on disk.
|
||||
The only mutable mount setting is the presentation year of the selected career. Native
|
||||
`.obs` checkpoints serialize named fields, compatibility memory blocks, both random
|
||||
streams, Reality residues and the manager-desk driver. No host object, pointer or callback
|
||||
is dumped. The session reconstructs content pointers and callbacks when loading.
|
||||
|
||||
The RmlUI launcher remains the parent process. Each game starts in a fresh child process
|
||||
of `OpenBMH`, keeping edition-specific process globals isolated. Portable mod content and
|
||||
personal files have independent lifetimes. See [runtime-0.2](formats/obw/runtime-0.2.md).
|
||||
|
||||
The launcher layout and theme live in `assets/launcher/launcher.rml` and `theme.rcss`.
|
||||
They share the same RmlUI core, FreeType font engine and SDL2 platform layer.
|
||||
Windows uses the pinned upstream Direct3D 11 renderer with hardware-to-WARP
|
||||
fallback, while Linux/macOS keep the upstream OpenGL renderer. Both the editor
|
||||
and launcher share window/device lifetime, resizing and capture through
|
||||
`src/launch/rml_video.*`. The C++ view translates events into the existing launcher
|
||||
interface; it does not own conversion rules or mod storage. This presentation layer
|
||||
can be reused by future modern screens. Classic game screens retain their current UI.
|
||||
The operating system supplies the folder picker through nativefiledialog-extended.
|
||||
Release packages contain the complete launcher asset directory and unmodified Lato
|
||||
fonts from the pinned RmlUI source. Background artwork is independently generated;
|
||||
its provenance and approved digest are recorded with the project assets.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Palette: `M3PC.COL`
|
||||
|
||||
The file contains 256 RGB triplets: 768 bytes, with each channel a six-bit VGA DAC value. `load_palette` in `src/formats/palette.cpp` requires at least that size and ignores trailing data.
|
||||
|
||||
A channel is masked with `0x3f` and expanded to eight bits using `(v * 255 + 31) / 63`. Rendering uses opaque alpha unless the drawing operation supplies transparency separately. No palette index is inherently transparent.
|
||||
|
||||
Some [VGA](VGA.md) images supply a separate palette. The same channel conversion applies. `Palette::nearest` is an implementation helper for colour matching, not an additional file field.
|
||||
@@ -0,0 +1,11 @@
|
||||
# Legacy installation configuration
|
||||
|
||||
`SOUND.CFG` and `PFAD.MAN` belong to the DOS installation. OpenBMH uses host SDL audio and its data-directory configuration instead of DOS ports, IRQs, DMA channels or path-prefix files.
|
||||
|
||||
## `SOUND.CFG`
|
||||
|
||||
The 30-byte file begins with the nine-byte `ALPTRAUM!` signature. A marker byte and two words precede two eight-byte device records. Each record contains four little-endian words representing the enabled state and legacy Sound Blaster configuration. These values describe the old machine, not valid SDL device settings.
|
||||
|
||||
## `PFAD.MAN`
|
||||
|
||||
This short legacy text file supplies a DOS path prefix. OpenBMH accepts a game location through startup selection or `--data`. Do not copy machine-specific DOS configuration into a new OpenBMH configuration file.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Switch settings: `.EIN` and saved settings
|
||||
|
||||
The legacy settings block is 180 bytes: twenty rows of nine bytes, without a header or encryption. The same block is retained in [FBM](FBM.md). OpenBMH's settings actions operate on the career's block; standalone `.EIN` import is not the save mechanism.
|
||||
|
||||
Rows are indexed 0–19 and columns 0–8 in code. On-screen row letters and one-based column labels are presentation conventions. For supported boolean cells, zero means enabled and one means disabled. Some cells carry high-bit flags, reserved values or numeric settings; do not normalise the whole block to booleans.
|
||||
|
||||
`src/game/state.hpp`, the settings action implementation and the settings projection define supported cells and their bounds. Availability can also depend on the current frontend's audio capabilities. A failed audio device is not represented by rewriting the stored music preference. Clients should use the projected availability and normal actions rather than editing raw settings bytes.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,33 @@
|
||||
# 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, normally `V2.24` for the supported 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.
|
||||
|
||||
## Edition compatibility
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,27 @@
|
||||
# Bitmap fonts: `.FNT`
|
||||
|
||||
`src/formats/font.cpp` loads a 28-byte little-endian header followed by a bitmap and glyph tables. The layout resembles an Amiga TextFont with pointer slots stored as placeholders.
|
||||
|
||||
| Offset | Type | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | u16 | Glyph height |
|
||||
| 2 | u8 | Style |
|
||||
| 3 | u8 | Flags; value 2 omits the spacing table |
|
||||
| 4 | u16 | Nominal advance |
|
||||
| 6 | u16 | Baseline |
|
||||
| 8 | u8 | First character |
|
||||
| 9 | u8 | Last character |
|
||||
| 10 | u16 | Reserved |
|
||||
| 12 | u32 | Bitmap pointer placeholder |
|
||||
| 16 | u16 | Bytes per bitmap row |
|
||||
| 18 | u16 | Reserved |
|
||||
| 20 | u32 | Glyph-location pointer placeholder |
|
||||
| 24 | u32 | Spacing pointer placeholder |
|
||||
|
||||
Let `n = last - first + 2`; the extra entry is the replacement glyph. After the header come:
|
||||
|
||||
1. `height * row_bytes` bytes of one-bit bitmap, most significant bit first.
|
||||
2. `n` pairs of u16 bit offset and bit width.
|
||||
3. `n` signed 16-bit advances, unless flags equal 2. Fixed-width glyphs use the nominal advance instead.
|
||||
|
||||
The loader requires the computed total size to match. Characters outside the supported range use the replacement glyph. Legacy character conversion is described in the [format index](README.md); use the supplied font with its matching text encoding.
|
||||
@@ -0,0 +1,15 @@
|
||||
# Executable images used as data
|
||||
|
||||
OpenBMH reads tables and text from the user's original executable. It does not execute that program. The file is not part of the OpenBMH distribution.
|
||||
|
||||
## German LE image
|
||||
|
||||
`src/formats/le.cpp` loads the DOS/4GW Linear Executable format. The DOS header's u32 field at `0x3c` locates the LE header. Object records define virtual sizes, image bases and page ranges. Page-map entries locate file data; unloaded areas are zero-filled. The image applies supported internal relocation records before consumers follow pointers.
|
||||
|
||||
The reader supports the internal offset/selector forms required by the installation. External fixups are rejected. Bounds and object validation belong to the loader; arbitrary executable formats are not accepted merely because they begin with an MZ stub. String access decodes the legacy single-byte encoding.
|
||||
|
||||
## English X-32 image
|
||||
|
||||
Football Limited uses a different executable layout. `src/launch/fltd.cpp` prepares supported English executable data and maps the required tables into the engine's expected data view. It is not an instruction emulator or a conversion of English game rules into a separate engine.
|
||||
|
||||
The [executable layout reference](EXECUTABLE_LAYOUT.md) describes supported table locations and semantic layout identifiers. A byte address is meaningful only with its edition and image layout. Application APIs should expose the table's meaning rather than an address-derived field name.
|
||||
@@ -0,0 +1,37 @@
|
||||
# Master database: `M3D.MAN` / `M3E.MAN`
|
||||
|
||||
`load_database` in `src/formats/m3d.cpp` reads an unencrypted sequence of string pools and parallel tables. Counts are supplied by `DbCounts`, not stored in the file. Default counts are 419 clubs, 2,574 players, 168 team records and an auxiliary extent of 3,096. Readers must agree on these counts; changing a count without rebuilding dependent tables does not define a valid new database.
|
||||
|
||||
Let `C`, `P`, `T` and `A` denote those counts. The stream order is:
|
||||
|
||||
| Size | Content |
|
||||
|---|---|
|
||||
| 4 × u16 | Byte lengths of club, player, referee and stadium name pools |
|
||||
| `A + 50` bytes | Player bonus/flag table and auxiliary entries |
|
||||
| Sum of pool lengths | Four consecutive NUL-separated name pools |
|
||||
| `C` × u16 | Club name offsets into pool 0 |
|
||||
| `P` × u16 | Player name offsets into pool 1 |
|
||||
| 100 bytes | Auxiliary table |
|
||||
| `T` × u16 | Auxiliary team table |
|
||||
| `C` × u16 | Club crest/flag words; low nine bits select a crest |
|
||||
| 251 + 189 + 50 + 419 + 168 bytes | Five fixed-size auxiliary tables |
|
||||
| `2 * (A - 4) + 108` bytes | Squad-list words |
|
||||
| `P` × u32, three times | Three parallel player-word tables |
|
||||
|
||||
The loader checks bounds and requires complete consumption. Pool references are byte offsets; they are neither club IDs nor Unicode indices. The name pools also occur in [savegame trailers](FBM.md). A career initialises and reorders parts of the database, so its runtime team IDs can differ from the master club index.
|
||||
|
||||
## Player words
|
||||
|
||||
A squad-list word stores a twelve-bit player ID and four flag bits. Player ID `0xfff` means no player. The `Player` accessors in `src/formats/m3d.hpp` interpret the three words in file order:
|
||||
|
||||
| Word | Bits | Meaning |
|
||||
|---|---|---|
|
||||
| 1 | 0–6 | Form |
|
||||
| 1 | 7–13 | Technique |
|
||||
| 1 | 14–20 | Condition |
|
||||
| 2 | 0–13 | Seven two-bit skills: teamplay, speed, shooting, passing, tackling, free kick, corner |
|
||||
| 2 | 27–31 | Nationality |
|
||||
| 3 | 0–1 | Position: goalkeeper, defender, midfielder, forward |
|
||||
| 3 | 21–25 | Age minus 16 |
|
||||
|
||||
Other bits carry additional state or remain uninterpreted by these accessors. Preserve them when changing a supported field. Display strength is `min((((form >> 3) + 94) * (technique + condition) / 100) / 2, 99)` with integer division in that order. It is a derived value, not an extra database field.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Formation coordinates: `M3.DAT`
|
||||
|
||||
The file is a 1,408-byte raw block containing four 352-byte manager slots. Each slot contains an outdoor and indoor set, each with eight 22-byte formation records.
|
||||
|
||||
A record stores eleven horizontal coordinates followed by eleven vertical coordinates. For a formation `f` and player slot `p`, the horizontal coordinate is at `set_base + f * 22 + p`; the vertical coordinate is eleven bytes later. The indoor set begins 176 bytes into the manager slot.
|
||||
|
||||
Career initialisation copies the first manager slot over the other three. Subsequently the manager-specific block is retained in [FBM](FBM.md). The semantic accessor is `GameState::formation_position` in `src/game/state.cpp`. Coordinates belong to the game's pitch grid, not directly to screen pixels.
|
||||
@@ -0,0 +1,20 @@
|
||||
# Desktop layout: `.MEN`
|
||||
|
||||
A desktop layout is 864 bytes: 54 entries of 16 bytes, without a header or encryption. `src/ui/desk_state.cpp` interprets the list. New careers initialise manager slots from the installation's layout; saved careers retain their layouts in [FBM](FBM.md).
|
||||
|
||||
Entry zero is the list head. Byte 5 contains the first visible entry; each following entry uses byte 5 for its successor and byte 6 for its predecessor. Index zero terminates a chain and `0xff` denotes an unlisted entry. The reader checks indices and detects cycles.
|
||||
|
||||
| Offset within entry | Type | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | u16 | Horizontal coordinate; bit `0x1000` hides the entry |
|
||||
| 2 | u8 | Vertical coordinate |
|
||||
| 3 | u8 | Width |
|
||||
| 4 | u8 | Height |
|
||||
| 5 | u8 | Next entry |
|
||||
| 6 | u8 | Previous entry |
|
||||
| 7–11 | bytes | Reserved |
|
||||
| 12 | u8 | Item kind |
|
||||
| 13 | u8 | Drawer state; bit 7 indicates open |
|
||||
| 14–15 | bytes | Reserved |
|
||||
|
||||
Icon kinds occupy 0–29; drawer kinds occupy 50–72. The graphical client decides which kinds it can display and which actions are available in the current mode. A kind number is not a console window ID. Unrecognised or inactive layout data must not be interpreted as an executable action.
|
||||
@@ -0,0 +1,572 @@
|
||||
# OBW: OpenBMH world, save and pack format
|
||||
|
||||
## 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.
|
||||
|
||||
## 1. Goals and non-goals
|
||||
|
||||
Goals:
|
||||
|
||||
- One documented, versioned format for a game world (start database), a running career (save) and content packs.
|
||||
- A typed model of nations, clubs, players, staff, contracts, finances and competitions that no longer depends on the memory image of a particular executable.
|
||||
- Data-driven competitions: up to **32 leagues** (national and foreign leagues together), real-world European club cups (league phase plus knockout), and national-team competitions including qualification and a Nations-League-style tiered competition.
|
||||
- Import from the supported German editions and from Football Limited (FLTD), both for a new career and for an existing `.FBM` save.
|
||||
- Preparation for a high-resolution interface built with RmlUi: logical asset keys, high-resolution crests and icons, player photos, further languages and modern font formats.
|
||||
- Forward compatibility: readers of the same major version accept files written by later minor versions.
|
||||
|
||||
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.
|
||||
- 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.
|
||||
|
||||
| Extension | `kind` | Contents |
|
||||
|---|---|---|
|
||||
| `.obw` | `world` | Start database: everything needed to begin a career |
|
||||
| `.obs` | `save` | A world plus the running state of a career |
|
||||
| `.obp` | `pack` | Overlays and assets for worlds (names, crests, photos, texts) |
|
||||
| `.obt` | `theme` | Interface theme for the RmlUi client (§9.6) |
|
||||
|
||||
An unpacked directory with the same layout is accepted wherever an archive is, which keeps development and version control simple.
|
||||
|
||||
### 2.2 Layout
|
||||
|
||||
```
|
||||
manifest.json required, §3
|
||||
world/nations.json nations and their national teams
|
||||
world/clubs.json clubs (teams of type "club")
|
||||
world/players.json players
|
||||
world/staff.json managers, coaches, other staff
|
||||
world/stadiums.json stadiums
|
||||
world/contracts.json player and staff contracts
|
||||
world/finance.json club finances, sponsors, advertising, loans, shares
|
||||
world/competitions.json competition definitions, §6
|
||||
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
|
||||
x-<name>/... extensions, §3.3
|
||||
```
|
||||
|
||||
Every table file is an object `{"schema": "<table>@<major>.<minor>", "items": [...]}`. Tables with many rows (results, history, mail) may instead be stored as JSON Lines (`*.jsonl`, one item per line, first line the header object without `items`).
|
||||
|
||||
### 2.3 Encoding rules
|
||||
|
||||
- Text is UTF-8. Legacy single-byte text is converted on import (`iso646de_to_utf8`).
|
||||
- Money is an integer in the smallest unit of the world currency (`manifest.currency`, e.g. `{"code": "DEM", "minor_units": 0}`); no floating point for money.
|
||||
- Dates are ISO 8601 calendar dates (`"1995-07-01"`), in-game time is a date plus an optional `"minute"`.
|
||||
- Percentages and ratings are integers on the scale declared by their attribute set (§5.3).
|
||||
- Optional fields may be omitted; the schema gives their default.
|
||||
|
||||
### 2.4 Reserved
|
||||
|
||||
A compact binary encoding of large `state/` tables is reserved for a later minor version as an alternative representation of the same schema (`"encoding": "cbor"` in the table header). Readers of 1.0 reject unknown encodings with a clear error.
|
||||
|
||||
## 3. Versioning and migration
|
||||
|
||||
### 3.1 Manifest
|
||||
|
||||
```json
|
||||
{
|
||||
"format": "openbmh-world",
|
||||
"format_version": "1.0",
|
||||
"kind": "world",
|
||||
"min_reader": "1.0",
|
||||
"generator": "OpenBMH 0.2.0",
|
||||
"created": "2026-10-17",
|
||||
"title": {"default": "Season 1995/96"},
|
||||
"provenance": "import:bmh-de",
|
||||
"content_license": "local-import-only",
|
||||
"currency": {"code": "DEM", "minor_units": 0},
|
||||
"start_date": "1995-07-01",
|
||||
"languages": ["de"],
|
||||
"limits": {"leagues": 32},
|
||||
"requires": [],
|
||||
"extensions": []
|
||||
}
|
||||
```
|
||||
|
||||
- `format_version` is `major.minor`. A **minor** step only adds optional fields, tables, enum values that have a documented fallback, or new stage types guarded by `requires`. A **major** step may rename, remove or re-interpret fields.
|
||||
- `min_reader` is the lowest reader version that can use the file correctly (a writer raises it when it uses a minor feature without a safe fallback).
|
||||
- `requires` lists features without which the file cannot be played, e.g. `["stage:swiss"]`; a reader that lacks one refuses the file instead of guessing.
|
||||
- `provenance` records where the content came from: `native`, `import:bmh-de`, `import:bmh-de-classic`, `import:fltd`, or `pack:<id>`. `content_license` is free text or an SPDX identifier; `local-import-only` marks data converted from a user's own installation (§8.4).
|
||||
|
||||
### 3.2 Reading and migration
|
||||
|
||||
- Readers ignore unknown fields and tables, keep them in memory and write them back unchanged (round trip), so a newer minor version survives an older tool.
|
||||
- Missing optional fields take the schema default.
|
||||
- Older major versions are upgraded on load through a chain of migrations (`migrate_1_to_2`, `migrate_2_to_3`, ...). Writers always write the newest version; a migrated save is written under a new name unless the player confirms the upgrade.
|
||||
- Each table carries its own `schema` version, so a table can advance a minor step independently; the manifest version is the highest of them.
|
||||
|
||||
### 3.3 Extensions
|
||||
|
||||
Fields and directories whose name starts with `x-` belong to extensions (`x-matchengine`, `x-realnames`, `x-editor`). The core never interprets them, preserves them on round trip and lists active ones in `manifest.extensions` with a version, e.g. `{"id": "x-matchengine", "version": "1.0"}`.
|
||||
|
||||
### 3.4 Schemas
|
||||
|
||||
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.
|
||||
- Ids are unique within a world and never reused within a save. The engine assigns runtime indices; files never store them.
|
||||
- Nation keys use ISO 3166-1 alpha-2 where one exists, otherwise a documented private key (`nation:x-eng` for England, `nation:x-sco`, ...).
|
||||
- Every displayed name is a localized string: `{"default": "...", "en": "...", "short": {"default": "..."}}`. `default` is required; a language entry overrides it; `short` and `abbr` are optional display variants for narrow layouts.
|
||||
- Packs overlay names, crests and photos by id (§9.5), never by position.
|
||||
|
||||
## 5. Entities
|
||||
|
||||
Field lists name the type and whether the field is required (R) or optional (O, with default). Only the main fields are listed; the schema is authoritative.
|
||||
|
||||
### 5.1 Nation (`world/nations.json`)
|
||||
|
||||
| Field | Type | | Meaning |
|
||||
|---|---|---|---|
|
||||
| `id` | string | R | `nation:<key>` |
|
||||
| `name` | localized | R | |
|
||||
| `confederation` | string | R | `uefa`, `conmebol`, `caf`, `afc`, `concacaf`, `ofc`, `other` |
|
||||
| `coefficient` | integer | O 0 | Club-competition ranking points (§6.6) |
|
||||
| `strength` | integer | O 0 | Rating of the national team when no squad is simulated |
|
||||
| `national_team` | string | O | Team id of type `national` (§5.2) |
|
||||
| `playable` | bool | O false | Whether its leagues are simulated in full |
|
||||
|
||||
### 5.2 Team (`world/clubs.json`)
|
||||
|
||||
Clubs and national teams share one entity type, distinguished by `type`.
|
||||
|
||||
| Field | Type | | Meaning |
|
||||
|---|---|---|---|
|
||||
| `id` | string | R | `club:<key>` or `nt:<nation key>` |
|
||||
| `type` | enum | R | `club`, `national`, `amateur` (newcomer pool), `foreign` (strength only) |
|
||||
| `name` | localized | R | |
|
||||
| `nation` | string | R | |
|
||||
| `stadium` | string | O | |
|
||||
| `colors` | array | O | 1 to 3 `#rrggbb` values, used for generated crests and kits |
|
||||
| `reputation`, `fans`, `strength` | integer | O | Club values on the attribute scale of the world |
|
||||
| `founded` | integer | O | Year |
|
||||
| `crest` | string | O | Asset key, default `asset:club/<key>/crest` (§9.1) |
|
||||
| `x-*` | any | O | Extensions |
|
||||
|
||||
Teams without a squad (`foreign`, or `national` in a world that does not simulate national squads) carry `strength` instead of players.
|
||||
|
||||
### 5.3 Player (`world/players.json`)
|
||||
|
||||
| Field | Type | | Meaning |
|
||||
|---|---|---|---|
|
||||
| `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. |
|
||||
| `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` |
|
||||
| `attribute_set` | string | O world default | e.g. `bmh-classic@1` |
|
||||
| `attributes` | object | R | Values named by the attribute set, e.g. `{"strength": 7, "technique": 5, "condition": 9, "form": 6}` |
|
||||
| `character` | object | O | Traits the attribute set defines |
|
||||
| `team` | string | O | Current team id; absent for free agents |
|
||||
| `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:
|
||||
|
||||
```json
|
||||
{"id": "bmh-classic@1", "fields": {
|
||||
"strength": {"min": 1, "max": 10},
|
||||
"technique": {"min": 1, "max": 10},
|
||||
"condition": {"min": 0, "max": 100},
|
||||
"form": {"min": 1, "max": 10}}}
|
||||
```
|
||||
|
||||
The exact list and scales of `bmh-classic@1` are fixed when the importer is written, from the fields the current engine uses (`Player` in `src/game/state.hpp`).
|
||||
|
||||
### 5.4 Staff and managers (`world/staff.json`)
|
||||
|
||||
Managers (human or computer), coaches and other employees: `id`, `name`, `born`, `nation`, `role` (`manager`, `coach`, `physio`, ...), `team`, `attributes`. In a save, `state/managers.json` adds the human manager profile: options, ratings, history, automation settings.
|
||||
|
||||
### 5.5 Contracts (`world/contracts.json`)
|
||||
|
||||
`id`, `person` (player or staff id), `team`, `start`, `end`, `salary` (money per season), `bonuses` (signing, per goal, ...), `release_clause` (O), `options` (O). One active contract per person and team; the history is kept in the save.
|
||||
|
||||
### 5.6 Stadiums (`world/stadiums.json`)
|
||||
|
||||
`id`, `name`, `capacity` split by area (`standing`, `seated`, `boxes`), `facilities` (floodlights, heating, scoreboard, ... as named levels), `pitch`, `owner` (team id or `null`).
|
||||
|
||||
### 5.7 Finance (`world/finance.json`)
|
||||
|
||||
Per team: balance, ticket prices, sponsors (shirt, boards, with duration and value), advertising, loans (amount, rate, due date), shares and other income or cost sources the engine models today. Rate tables such as the credit table live in `world/rules.json`.
|
||||
|
||||
### 5.8 Rules (`world/rules.json`)
|
||||
|
||||
Named rule values that are content of the world rather than of the engine: training-camp resorts (price, quality grades), credit-rate tables, attribute sets, points for a win, squad limits. Today these values are read from the executable of the selected edition; in OBW they are ordinary data (and the starting point of the configurable rules of roadmap 0.3).
|
||||
|
||||
### 5.9 Save state (`state/`, saves only)
|
||||
|
||||
| File | Contents |
|
||||
|---|---|
|
||||
| `state/career.json` | Current date, season, phase, active human managers, settings |
|
||||
| `state/rng.json` | State of the random generator(s) (`docs/RNG.md`), so a load continues deterministically |
|
||||
| `state/tables.json` | Standings per competition stage and group |
|
||||
| `state/results.jsonl` | Every played or scheduled match: competition, stage, round, home, away, result, after extra time / penalties |
|
||||
| `state/squads.json` | Lineups, formations, tactics per team |
|
||||
| `state/history.jsonl` | Season history: champions, cup winners, top scorers, records |
|
||||
| `state/mail.jsonl` | Messages and news |
|
||||
| `state/market.json` | Transfer list, open bids, loan offers |
|
||||
| `state/x-legacy.json` | Unmapped legacy values carried over by the importer (§8.3) |
|
||||
|
||||
## 6. Competitions
|
||||
|
||||
### 6.1 Model
|
||||
|
||||
A competition is an ordered list of **stages**. Each stage takes teams from **slots** (§6.4), plays a format and hands teams on (to the next stage, to another competition, or to a final ranking).
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "comp:de-2",
|
||||
"name": {"default": "2. Liga"},
|
||||
"type": "league",
|
||||
"nation": "nation:de",
|
||||
"tier": 2,
|
||||
"trophy": "asset:comp/de-2/trophy",
|
||||
"season_cycle": 1,
|
||||
"stages": [{
|
||||
"id": "regular",
|
||||
"format": "league",
|
||||
"teams": 18,
|
||||
"legs": 2,
|
||||
"points": {"win": 3, "draw": 1, "loss": 0},
|
||||
"tiebreakers": ["points", "goal_difference", "goals_for", "head_to_head", "draw_lots"],
|
||||
"matchdays": "calendar:league-weekends"
|
||||
}],
|
||||
"movement": [
|
||||
{"ranks": [1, 2], "to": "comp:de-1"},
|
||||
{"ranks": [3], "to": "comp:de-1/playoff", "role": "challenger"},
|
||||
{"ranks": [16, 18], "to": "comp:de-3"}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`type` is `league` (counts towards the league limit), `cup` (national cup), `club_international`, `national_team`, `friendly` or `indoor`.
|
||||
|
||||
### 6.2 Stage formats
|
||||
|
||||
| Format | Purpose | Main parameters |
|
||||
|---|---|---|
|
||||
| `league` | Round robin | `teams`, `legs` (1, 2, n), `points`, `tiebreakers`, fixture generator |
|
||||
| `groups` | Several round robins | `groups`, `teams_per_group`, `legs`, seeding `pots`, draw constraints (e.g. no two teams of one nation) |
|
||||
| `swiss` | League phase with a fixed number of games against drawn opponents | `teams` (e.g. 36), `matches` (e.g. 8), `pots`, `home_away_balance`, one common table |
|
||||
| `knockout` | Ties | `legs` (1 or 2), `seeded`, `draw` (`open`, `seeded`, `bracket`), `extra_time`, `penalties`, `away_goals` (on/off), `neutral_venue`, `replay` (FA-Cup style) |
|
||||
| `playoff` | Ties between teams of different competitions (relegation, qualification) | as `knockout` plus the roles of the participants |
|
||||
| `final` | Single match or final tournament | `venue`, `teams` |
|
||||
|
||||
Common stage parameters: `extra_time` (minutes), `penalties`, `suspensions` (cards that lead to a ban, counted per competition or per stage), `substitutions`, `squad_registration` (size, home-grown quota), `prize_money` per round and result, `tv_money`, `gate_split`. New formats are added through a minor version with an entry in `manifest.requires`.
|
||||
|
||||
### 6.3 Fixture generation
|
||||
|
||||
A `league` or `groups` stage names a generator: `"generator": "round-robin"` (circle method, home/away balanced) works for every size. The legacy round tables of the original game remain available as `"generator": "legacy:<teams>"` for imported worlds, so imported careers keep their familiar order; they come from the user's installation, not from the format.
|
||||
|
||||
### 6.4 Slots and qualification
|
||||
|
||||
Participants are declared, not hard-coded:
|
||||
|
||||
```json
|
||||
"slots": [
|
||||
{"from": "comp:de-1", "ranks": [1, 4], "stage": "league-phase"},
|
||||
{"from": "comp:de-cup", "winner": true, "to": "comp:uel", "stage": "league-phase",
|
||||
"fallback": {"from": "comp:de-1", "next_unqualified": true}},
|
||||
{"from": "coefficient", "nation_rank": [1, 4], "places": 4},
|
||||
{"holder": "comp:ucl", "stage": "league-phase"}
|
||||
]
|
||||
```
|
||||
|
||||
A slot source is: a rank range of a stage, the winner/runner-up of a competition, the holder of a title, the next team not yet qualified (substitution rules), a coefficient ranking, or an explicit list. The engine resolves all slots at season end in the order given by `world/calendar.json`.
|
||||
|
||||
### 6.5 League pyramid
|
||||
|
||||
`movement` on a league connects tiers: promotion, relegation and playoffs between two leagues, several parallel lower leagues feeding one league (the two regional third divisions of the German editions), and a refill pool for the lowest tier (`"refill": {"from": "pool:amateur", "count": 2}`). This replaces the fixed per-edition tables in `src/game/schedule.hpp` (`kLeagueRelegation`, `kLeagueEurope`, `kGroupBelow`, `kNewcomerFirst`).
|
||||
|
||||
### 6.6 Coefficients
|
||||
|
||||
`world/rules.json` may define coefficient rankings (club and nation) with the points per result and per round reached and the number of seasons summed. They drive seeding pots and the number of European places per nation. A world may instead fix places per nation (`"places": {"nation:de": {"ucl": 4, "uel": 2}}`), which is how imported legacy worlds start.
|
||||
|
||||
### 6.7 Templates
|
||||
|
||||
The project ships competition templates under `docs/formats/obw/templates/`. They contain structure only, with neutral names:
|
||||
|
||||
- **Club competitions:** a champions cup with a 36-team league phase, a knockout playoff for places 9 to 24, round of 16 to final; a second and a third club cup in the same shape; a super cup; the knockout-only cups of the original game.
|
||||
- **National teams:** a world cup with continental qualification groups and playoffs, a continental championship with qualification, and a **tiered nations league**. The nations league has leagues A to D with groups of three or four, promotion and relegation between tiers, a final tournament for the group winners of A, and playoffs that can feed continental-championship places.
|
||||
- **National cups and side competitions:** knockout national cups (with or without replays and a qualifying round), an indoor tournament, friendlies.
|
||||
|
||||
### 6.8 National teams
|
||||
|
||||
A world that simulates national teams gives each `national` team a call-up rule: squad size, eligibility through `nationalities[0]`, selection by attribute set (best `n` by position) or by a human manager. International windows in the calendar (§7) suspend club play when the world asks for it (`"club_break": true`). Worlds without national squads use `strength` and simulate only results.
|
||||
|
||||
## 7. Calendar
|
||||
|
||||
`world/calendar.json` describes a season as dated events, independent of the executable's day table:
|
||||
|
||||
```json
|
||||
{
|
||||
"season_start": "07-01",
|
||||
"season_length_days": 365,
|
||||
"windows": [
|
||||
{"id": "summer-transfer", "type": "transfer", "from": "07-01", "to": "08-31"},
|
||||
{"id": "intl-sep", "type": "international", "from": "09-02", "to": "09-10", "club_break": true}
|
||||
],
|
||||
"series": [
|
||||
{"id": "league-weekends", "weekday": "sat", "from": "08-08", "to": "05-20", "skip": ["winter-break", "intl-*"]},
|
||||
{"id": "ucl-league-phase", "weekdays": ["tue", "wed"], "dates": ["09-16", "09-30"]}
|
||||
],
|
||||
"events": [
|
||||
{"date": "06-30", "action": "season_end"},
|
||||
{"date": "01-05", "action": "training_camp_window"}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Dates are month-day within the season; the engine maps them to concrete days each year, including leap years and seasons whose first day falls on a different weekday (the cases fixed in the current calendar code). Stages refer to a series by id. Imported worlds receive a calendar generated from the edition's day table, so the familiar rhythm stays.
|
||||
|
||||
## 8. Import from BMH and Football Limited
|
||||
|
||||
### 8.1 Sources
|
||||
|
||||
The importer (planned module `src/import/`) reuses the existing loaders:
|
||||
|
||||
| Source | Loader | Result |
|
||||
|---|---|---|
|
||||
| Master database `M3D.MAN` / `M3E.MAN` | `src/formats/m3d.cpp` | Clubs, players, staff, stadiums |
|
||||
| Executable tables (league sizes, ladders, calendar, fixture tables, rule values) | `src/formats/le.cpp`, `src/launch/fltd.cpp`, `src/game/schedule.hpp` installers | Competitions, calendar, rules |
|
||||
| Text database `TEXTD.BLK` / `TEXTE.BLK` | `src/formats/textd.cpp` | Local language layer `de-original` / `en-original` |
|
||||
| Save `*.FBM` | `src/formats/fbm.cpp`, `savestate.cpp` | `state/` of a save |
|
||||
| Crests and pictures `*.VGA`, `WAPPEN.LBM` | `src/formats/vga.cpp` | Low-resolution fallback assets, local only |
|
||||
|
||||
Edition detection is the one the launcher already performs (`src/launch/game_data.cpp`).
|
||||
|
||||
### 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:
|
||||
|
||||
| Legacy league | German editions | Football Limited | OBW |
|
||||
|---|---|---|---|
|
||||
| 0 | 1st division, 18 teams | 1st division, 20 teams | `comp:<n>-1`, tier 1 |
|
||||
| 1 | 2nd division, 18 | 2nd division, 20 | tier 2 |
|
||||
| 2, 3 | Two parallel third divisions A and B, 18 each, one promotion group | 3rd and 4th division, 20 each | tier 3 (two leagues) / tiers 3 and 4 |
|
||||
| 4 | Fourth tier, 18 | Fifth league, 10 teams, not played | tier 4 / tier 5 with `"played": false` |
|
||||
| 5-8 | Four foreign leagues of 12 | Same four foreign leagues of 12 | `comp:<nation>-1` each, `nation.playable = true` |
|
||||
| Newcomer pool | 30 amateur clubs | 12 further named clubs | `pool:amateur` |
|
||||
|
||||
Cups, European cups, the indoor tournament, the English FA Cup with its qualifying stage and the League Cup become competitions with the same rules the engine applies today. Relegation places, European places and promotion groups are taken from the installed tables (`kLeagueRelegation`, `kLeagueEurope`, `kGroupBelow`), not re-typed by hand.
|
||||
|
||||
### 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.
|
||||
|
||||
### 8.4 Rights
|
||||
|
||||
Imported content stays on the player's machine. The importer marks it `"provenance": "import:..."` and `"content_license": "local-import-only"`; tools refuse to bundle such a world into a distributable pack. Only worlds and packs with their own licence may be shared.
|
||||
|
||||
## 9. Assets, languages, fonts and the RmlUi interface
|
||||
|
||||
### 9.1 Asset keys
|
||||
|
||||
Data never refers to file paths. It uses logical keys:
|
||||
|
||||
| Key | Meaning |
|
||||
|---|---|
|
||||
| `asset:club/<key>/crest` | Club crest |
|
||||
| `asset:club/<key>/kit/home` | Kit |
|
||||
| `asset:player/<key>/photo` | Player photo |
|
||||
| `asset:staff/<key>/photo` | Staff photo |
|
||||
| `asset:comp/<key>/logo`, `asset:comp/<key>/trophy` | Competition logo and trophy |
|
||||
| `asset:nation/<key>/flag` | Flag |
|
||||
| `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.
|
||||
|
||||
- **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.
|
||||
- Data names are localized strings inside the tables (§4); packs can add languages to them.
|
||||
- The original text databases are imported into a local layer `de-original` or `en-original`, which the classic interface uses. New interfaces use the project's own texts.
|
||||
- A fallback chain is configured by the player, e.g. `["en-GB", "en", "de"]`.
|
||||
- Text is shaped as Unicode (RmlUi supports it); no single-byte substitutions outside the legacy layer.
|
||||
|
||||
### 9.4 Fonts
|
||||
|
||||
- TrueType and OpenType (`.ttf`, `.otf`); RmlUi renders them through FreeType. Variable fonts are allowed.
|
||||
- A theme declares font families with weights, a fallback chain covering the languages it claims, and the licence of every font file (for example SIL OFL).
|
||||
- The original bitmap fonts stay for the classic interface only.
|
||||
|
||||
### 9.5 Content packs (`.obp`)
|
||||
|
||||
```json
|
||||
{
|
||||
"format": "openbmh-world",
|
||||
"format_version": "1.0",
|
||||
"kind": "pack",
|
||||
"id": "pack:example-crests",
|
||||
"title": {"default": "Example crests"},
|
||||
"targets": [{"world_provenance": "import:bmh-de"}],
|
||||
"priority": 100,
|
||||
"content_license": "CC-BY-4.0",
|
||||
"overlays": ["names", "assets", "locale"]
|
||||
}
|
||||
```
|
||||
|
||||
- A pack contains `overlay/<table>.json` files with partial entities by id (only the fields it changes), `assets/` and `locale/`.
|
||||
- Several packs stack; the higher `priority` wins per field and per asset key. A pack may not add or remove entities in 1.0 (that is a world, not a pack), which keeps saves valid when a pack is removed.
|
||||
- `targets` restricts a pack to worlds by provenance or world id.
|
||||
- The project distributes only the format, tools and its own or freely licensed material. Packs with real names, crests or photos are made and shared by their authors under their own responsibility. The team's internal real-name pack uses this format and stays private.
|
||||
|
||||
### 9.6 RmlUi themes (`.obt`)
|
||||
|
||||
- A theme contains `.rml` documents, `.rcss` style sheets, fonts, icons and its `locale/` texts, plus a manifest naming the client version it targets.
|
||||
- Fixed interface artwork, including training-camp illustrations, maps, menu scenes and desktop motifs, belongs to the GUI resources or theme, not to the world. World assets include club crests, player photos and competition trophies. The stock Modern UI must not require its own pictures in the world's asset index; see the [GUI/world boundary](../new_ui/assets.md). Old interface images can be removed from Modern worlds through a separate validated migration once their remaining dependencies are gone. Classic content and its seals retain their existing requirements.
|
||||
- Interfaces bind to a **view model**, not to the world files. The client exposes data models (RmlUi data bindings) built from the application/protocol layer (`docs/protocol.md`), with ids and asset keys as values. RmlUi loads images through a file interface that resolves `asset:` keys (§9.2).
|
||||
- Neither worlds nor packs contain layout, so a theme works with every world, and the classic 320×200 interface keeps working next to it.
|
||||
|
||||
## 10. Validation and limits
|
||||
|
||||
The validator (planned `openbmh_cli --validate <file>`) checks, in this order:
|
||||
|
||||
1. Container, manifest, `format_version`, `min_reader`, `requires`.
|
||||
2. Every table against its JSON Schema.
|
||||
3. References: every id used exists and has the right type; no id is defined twice.
|
||||
4. Competition logic: slot counts match stage sizes; movements between tiers are balanced; every stage can be scheduled in the calendar; fixture generators exist for the sizes.
|
||||
5. Engine limits declared in `manifest.limits` and enforced by the engine of a version. For 1.0:
|
||||
|
||||
| Limit | Value |
|
||||
|---|---|
|
||||
| Competitions of type `league` (national and foreign) | **32** |
|
||||
| Teams per league | 4 to 24 |
|
||||
| Squad size per team | engine maximum of the attribute set |
|
||||
| Groups per stage | 16 |
|
||||
|
||||
The format itself has no fixed limits; a later engine raises them by changing `limits` and its own checks, without a format change.
|
||||
|
||||
Errors name the file, the JSON path and the rule (`clubs.json: items[41].stadium: unknown id stadium:0999`).
|
||||
|
||||
## 11. Implementation steps
|
||||
|
||||
| Step | Roadmap | Content |
|
||||
|---|---|---|
|
||||
| 1 | 0.2 | Schemas 1.0, reader/writer, validator, round-trip tests with synthetic worlds |
|
||||
| 2 | 0.2 | Importer for German editions and FLTD into `.obw`; adapter OBW → current `GameState`; regression: same first seasons |
|
||||
| 3 | 0.2 | `.FBM` → `.obs` conversion and native OBW saves; area by area the engine reads typed data instead of the memory image (clubs, players, contracts, finances, then competitions) |
|
||||
| 4 | 0.3 | `rules.json` drives the rule values; balance changes as data |
|
||||
| 5 | 0.4 | Generic competition engine (stage formats, slots, pyramid, variable league sizes up to the limits); templates for the real-world club cups and national-team competitions |
|
||||
| 6 | 0.4 | Asset resolver, packs, `.po` languages, RmlUi client with themes |
|
||||
| 7 | 0.5 | Own worlds that need no original data |
|
||||
|
||||
Each step keeps the game playable and the regression runs green; the legacy formats stay readable as import sources.
|
||||
@@ -0,0 +1,26 @@
|
||||
# File formats
|
||||
|
||||
OpenBMH reads files from a game installation supplied by the user. This directory documents their structure and the implementation's interfaces; it does not distribute game content or inventories of extracted text or artwork.
|
||||
|
||||
Unless a page says otherwise, integer fields are little endian. Legacy strings use a single-byte encoding; the German character substitutions are handled by `iso646de_to_utf8` in `src/formats/binary.cpp`. Text presented to clients is converted to UTF-8. Do not interpret a legacy byte offset as a Unicode character index.
|
||||
|
||||
| Data | Files | Documentation | Implementation |
|
||||
|---|---|---|---|
|
||||
| Palette | `M3PC.COL` | [COL](COL.md) | `src/formats/palette.cpp` |
|
||||
| Indexed images | `KB/*.VGA`, `W/*.VGA` | [VGA](VGA.md) | `src/formats/vga.cpp` |
|
||||
| Bitmap fonts | `F/*.FNT` | [FNT](FNT.md) | `src/formats/font.cpp` |
|
||||
| Text database | `TEXTD.BLK`, `TEXTE.BLK` | [TEXTD](TEXTD.md) | `src/formats/textd.cpp` |
|
||||
| Master database | `M3D.MAN`, `M3E.MAN` | [M3D](M3D.md) | `src/formats/m3d.cpp` |
|
||||
| Desktop layout | `M3.MEN`, `*.MEN` | [M3MEN](M3MEN.md) | `src/ui/desk_state.cpp` |
|
||||
| Formation coordinates | `M3.DAT` | [M3DAT](M3DAT.md) | `src/game/state.cpp` |
|
||||
| Settings | `*.EIN`, saved settings block | [EIN](EIN.md) | `src/game/state.hpp` |
|
||||
| Save container and state | `*.FBM` | [FBM](FBM.md), [STATE](STATE.md) | `src/formats/fbm.cpp`, `savestate.cpp` |
|
||||
| Legacy configuration | `SOUND.CFG`, `PFAD.MAN` | [CONFIG](CONFIG.md) | Not used for host device configuration |
|
||||
| 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 |
|
||||
|
||||
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.
|
||||
|
||||
The loaders and accessors are authoritative for supported bounds and validation. Unknown fields are preserved where required by save compatibility; an unexplained value is not an extension point. File offsets and record strides here describe formats, not stable application API names.
|
||||
@@ -0,0 +1,36 @@
|
||||
# Audio containers: `S/2000` through `S/2003`
|
||||
|
||||
`src/audio/container.cpp` validates the sound containers and decodes bounded PCM samples. `src/audio/original.cpp` implements the supported music sequencer, OPL instrument path, sample channel and effect dispatch. Audio resources and instrument values come from the user's installation; none are distributed here.
|
||||
|
||||
## Container structure
|
||||
|
||||
| Offset | Size | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | 4 | `FORM` signature |
|
||||
| 4 | u32, little endian | Declared length |
|
||||
| 8 | 8 | `ALPTRAUM` type |
|
||||
| 16 | Variable | Consecutive chunks |
|
||||
|
||||
Each chunk has a four-byte ID, a little-endian u32 payload length and its payload. Unlike standard padded IFF chunks, these chunks are adjacent without an alignment byte. The walker rejects overflows and requires the final chunk to end at the file boundary.
|
||||
|
||||
Music banks contain `HEDR`, `SONG`, `TRCK`, `PART`, `INST` and `SAMP` chunks. The effects bank uses `HEDR`, `SEFX`, `INST` and `SAMP`. The usual FORM length excludes the first eight bytes. The supported effects variant instead declares the whole file size; this exception is accepted only with its validated fixed chunk layout.
|
||||
|
||||
## PCM samples
|
||||
|
||||
A `SAMP` payload starts with two u16 words: a header field and the sample count. Each sample has a 16-byte descriptor followed by a shared unsigned eight-bit mono data area. Within a descriptor:
|
||||
|
||||
| Offset | Type | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | u16 | Start relative to the sample-data area |
|
||||
| 2 | u16 | Length in bytes |
|
||||
| 8 | u16 | Sample rate |
|
||||
|
||||
`decode_sample` checks the descriptor table and sample bounds, rejects empty samples and validates the rate. Conversion to signed sixteen-bit PCM is `(value - 128) * 256`.
|
||||
|
||||
## Sequencing and effects
|
||||
|
||||
`SONG`, `TRCK` and `PART` provide sequence order and timed note events; `INST` supplies instrument records. `OriginalSynth` schedules the supported register and sample operations using a deterministic audio tick. Nuked OPL3 renders the OPL-compatible register stream. This audio clock is separate from career random generators and match time.
|
||||
|
||||
The effects table has a four-byte prefix and sixteen-byte records. Instrument-backed effects and sample-backed effects use separate paths. `decode_original_cue` alone supports the direct sample-backed subset; this does not mean the full synthesiser lacks the instrument path. Music and effects settings control playback, while actual device availability belongs to the frontend. English audio compatibility remains subject to the release's experimental edition limits.
|
||||
|
||||
Sample-domain output checks establish decoder behaviour, not the timing or audible quality of a physical audio device. Platform listening and device checks are separate validation work.
|
||||
@@ -0,0 +1,27 @@
|
||||
# Interpreting saved game state
|
||||
|
||||
The [FBM container](FBM.md) contains fixed-order state blocks rather than a self-describing object graph. `src/formats/savestate.cpp` defines the physical layout; `src/game/state.hpp` and `state.cpp` provide semantic accessors. Keep those implementations as the single source of truth when adding a field.
|
||||
|
||||
## Manager records
|
||||
|
||||
Five compatibility slots use 2,828-byte records. Not every slot represents a playable manager. Important offsets within each record include:
|
||||
|
||||
| Record offset | Type | Meaning |
|
||||
|---|---|---|
|
||||
| `0x0a8` | Fixed character area | Manager name |
|
||||
| `0x290` | i16 | Runtime team ID; a sentinel represents no club |
|
||||
| `0x314` | i32 | Cash balance in the engine's currency units |
|
||||
| `0x748` | i32 array | First income accounting table |
|
||||
| `0x85c` | i32 array | Second income accounting table |
|
||||
|
||||
Financial projections can include computed expenses; raw accounting tables do not by themselves reproduce the complete balance screen. A displayed currency conversion is not a change to saved arithmetic.
|
||||
|
||||
Other blocks retain desktop layouts, settings, formation coordinates, tactics, transfers, loan ledgers, calendar state, results, player words and name offsets. Loan duration is kept separately from a player's contract-byte sentinel; a sentinel must not be read as a real multi-century contract.
|
||||
|
||||
## Identity and schedule
|
||||
|
||||
Master club indices, club-name pool offsets, runtime team IDs, player IDs and squad rows are distinct identifiers. Initialisation can shuffle clubs between runtime positions. Promotion and relegation can change those positions again. Use a session's current projections to resolve identity rather than holding a runtime row across a season boundary.
|
||||
|
||||
The base league structure contains five eighteen-team and four twelve-team ranges. A result byte packs home goals in the high nibble and away goals in the low nibble; `0xcc` denotes an unplayed result. The schedule combines round templates with current calendar and competition state. Tables additionally incorporate deductions and selected competition rules; clients should request a table projection instead of deriving one from raw results alone.
|
||||
|
||||
Do not serialise frontend capabilities, pointers, callback owners or request IDs into this compatibility state. Session staging and rollback must include the associated runtime state and both [random streams](../RNG.md), not just selected byte arrays.
|
||||
@@ -0,0 +1,16 @@
|
||||
# Text database: `TEXTD.BLK` / `TEXTE.BLK`
|
||||
|
||||
`src/formats/textd.cpp` reads a seven-byte header followed by consecutive NUL-terminated legacy strings.
|
||||
|
||||
| Offset | Type | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | u8 | Edition-specific identifier |
|
||||
| 1 | u16 | Declared buffer size |
|
||||
| 3 | u32 | Header field with no application-level interpretation |
|
||||
| 7 | bytes | String buffer |
|
||||
|
||||
The loader indexes the first 1,382 strings and rejects a shorter database. Declared buffer size can differ from the actual payload; the loader takes the remaining file bytes rather than trusting it as a stream length. Each stored offset is relative to the start of the string buffer, not to the file or a UTF-8 result.
|
||||
|
||||
Strings are converted through the legacy character decoder when displayed. Currency labels and other edition content come from the installation. The text database is not copied into a savegame; the name pools stored in [FBM](FBM.md) are separate.
|
||||
|
||||
This document intentionally describes structure only. A distributable replacement must provide independently licensed text; copying or translating the supplied game's text database does not create a new license for it.
|
||||
@@ -0,0 +1,16 @@
|
||||
# Indexed bitmap: `.VGA`
|
||||
|
||||
`src/formats/vga.cpp` decodes eight-bit palette indices from a continuous run-length stream. Coordinates use a top-left origin.
|
||||
|
||||
| Offset | Type | Meaning |
|
||||
|---|---|---|
|
||||
| 0 | u16 | Width |
|
||||
| 2 | u16 | Height |
|
||||
| 4 | u32 | Encoded length, including one trailing byte |
|
||||
| 8 | bytes | Encoded pixel stream |
|
||||
|
||||
For a control byte `c >= 0x80`, repeat the following byte `c - 0x7f` times. Otherwise copy the next `c + 1` literal bytes. Decoding continues across row boundaries until `width * height` indices have been produced. The loader rejects truncated data and requires exactly one byte to remain within the declared stream afterwards. A run exceeding the pixel count is clipped by the decoder.
|
||||
|
||||
The default colours come from [M3PC.COL](COL.md). Certain full-screen resources append a 768-byte palette after the encoded stream; callers loading those resources must select that palette separately. `decode_vga` itself returns indices and does not interpret appended palette data.
|
||||
|
||||
Crest sheets use 38 by 38 pixel cells, eight per sheet. For a nine-bit crest ID, the file number is `id >> 3` and the horizontal cell is `id & 7`. This describes the lookup scheme rather than any particular copyrighted crest or sheet content.
|
||||
@@ -0,0 +1,7 @@
|
||||
# IFF crest templates: `WAPPEN.LBM`
|
||||
|
||||
OpenBMH does not load this file. Its crest renderer uses indexed [VGA](VGA.md) sheets. No authorship or redistribution permission for templates found alongside a game installation is implied by their filename.
|
||||
|
||||
An IFF `FORM` of type `PBM ` can contain a `BMHD` bitmap header, an eight-bit RGB `CMAP`, optional application chunks and a `BODY` with chunky pixel indices. IFF lengths and header integers are big endian; chunks are padded to even boundaries.
|
||||
|
||||
For ByteRun1-compressed data, controls 0–127 copy the next `n + 1` bytes, controls 129–255 repeat the next byte `257 - n` times, and 128 is a no-op. This encoding differs from the game's VGA run-length stream. Adding a loader would require its own input validation and independently licensed test fixture.
|
||||
@@ -0,0 +1,206 @@
|
||||
# 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.
|
||||
@@ -0,0 +1,160 @@
|
||||
# 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.
|
||||
@@ -0,0 +1,158 @@
|
||||
# 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.
|
||||
@@ -0,0 +1,107 @@
|
||||
<!-- 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.
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-bytes.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,402 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-driver.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-driver@1.0"
|
||||
},
|
||||
"stage": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 2
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"manager_position": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4
|
||||
},
|
||||
"next_event_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
},
|
||||
"loaded_matchday_resume": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"suppress_remaining_pre_match_offers": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"national_nomination_desk": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"enable_national_nomination_desks": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"referee_source": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"referees": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"last_results": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"valid": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"matchday": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"valid",
|
||||
"date",
|
||||
"calendar_entry",
|
||||
"matchday",
|
||||
"groups",
|
||||
"tournament_name"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"stage",
|
||||
"calendar_entry",
|
||||
"manager_position",
|
||||
"next_event_id",
|
||||
"loaded_matchday_resume",
|
||||
"suppress_remaining_pre_match_offers",
|
||||
"national_nomination_desk",
|
||||
"enable_national_nomination_desks",
|
||||
"groups",
|
||||
"referee_source",
|
||||
"referees",
|
||||
"last_results"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-highscore.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-highscore@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 720,
|
||||
"minLength": 720
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-layout.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-layout@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 1728,
|
||||
"minLength": 1728
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"$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"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,200 @@
|
||||
{
|
||||
"$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"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-rng.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-rng@1.0"
|
||||
},
|
||||
"watcom": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"game": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"watcom",
|
||||
"game"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-seal.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-seal@1.0"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"content_id",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-session.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-session@1.0"
|
||||
},
|
||||
"runtime": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"value": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"value"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"desk_callargs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"managers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 3,
|
||||
"maxItems": 3
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"runtime",
|
||||
"desk_callargs",
|
||||
"managers"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-settings.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-settings@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 360,
|
||||
"minLength": 360
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,189 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,542 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-state.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-state@1.0"
|
||||
},
|
||||
"indoor": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"level": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_rain": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_temperature": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_shooter": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_pick_quality": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"live_scene": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_selection_available": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_club_threshold": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"list_toggle": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"lineups_frozen": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"offer_answer": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"transfer_notice_suppressed": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"pools_open": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"autosave_months": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"autosave_month": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"display_start_year": {
|
||||
"type": "integer",
|
||||
"minimum": 1900,
|
||||
"maximum": 9998
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"season_start": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"development_balance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"trend_rotation": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"season": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"team_morale": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_bonus": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"formations": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_records": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tactics": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_options": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_table": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_bc": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_78": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_b8": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"master_database_metadata": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"referee_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stadium_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_ratings": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"position_history": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"league_rounds": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stocks": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"foreign_strength": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"mailbox": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"squad_slots": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"team_flags": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"manager_teams": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"live_matches": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"sportschau_homes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"sportschau_priorities": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"club_ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_cards": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_name_offsets": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"players": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"form": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"skills": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"identity": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name_hex",
|
||||
"form",
|
||||
"skills",
|
||||
"identity"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4095
|
||||
},
|
||||
"memory": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"reality": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"initialized": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"deflected": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"card_kind": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"distance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"actors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 5,
|
||||
"maxItems": 5
|
||||
},
|
||||
"grid": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"planes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 1144,
|
||||
"maxItems": 1144
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"positions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 24,
|
||||
"maxItems": 24
|
||||
},
|
||||
"ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"previous_ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"planes",
|
||||
"positions",
|
||||
"ball",
|
||||
"previous_ball"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"initialized",
|
||||
"deflected",
|
||||
"card_kind",
|
||||
"distance",
|
||||
"actors",
|
||||
"grid"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"indoor",
|
||||
"level",
|
||||
"chance_rain",
|
||||
"chance_temperature",
|
||||
"last_shooter",
|
||||
"last_pick_quality",
|
||||
"live_scene",
|
||||
"sportschau_selection_available",
|
||||
"sportschau_club_threshold",
|
||||
"list_toggle",
|
||||
"lineups_frozen",
|
||||
"offer_answer",
|
||||
"transfer_notice_suppressed",
|
||||
"pools_open",
|
||||
"autosave_months",
|
||||
"autosave_month",
|
||||
"display_start_year",
|
||||
"date",
|
||||
"season_start",
|
||||
"development_balance",
|
||||
"trend_rotation",
|
||||
"season",
|
||||
"team_morale",
|
||||
"player_bonus",
|
||||
"formations",
|
||||
"manager_records",
|
||||
"tactics",
|
||||
"manager_options",
|
||||
"club_table",
|
||||
"club_heap_bc",
|
||||
"club_heap_78",
|
||||
"club_heap_b8",
|
||||
"master_database_metadata",
|
||||
"referee_names",
|
||||
"stadium_names",
|
||||
"tournament_name",
|
||||
"manager_results",
|
||||
"manager_ratings",
|
||||
"position_history",
|
||||
"league_rounds",
|
||||
"results",
|
||||
"stocks",
|
||||
"foreign_strength",
|
||||
"mailbox",
|
||||
"club_names",
|
||||
"player_names",
|
||||
"squad_slots",
|
||||
"team_flags",
|
||||
"manager_teams",
|
||||
"live_matches",
|
||||
"sportschau_homes",
|
||||
"sportschau_priorities",
|
||||
"club_ids",
|
||||
"player_cards",
|
||||
"player_name_offsets",
|
||||
"players",
|
||||
"memory",
|
||||
"reality"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,171 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,235 @@
|
||||
{
|
||||
"$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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,153 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-integrity.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "save-integrity@1.0"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-manifest.json",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"format",
|
||||
"format_version",
|
||||
"kind",
|
||||
"save_profile",
|
||||
"content_id"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"const": "openbmh-world"
|
||||
},
|
||||
"format_version": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"kind": {
|
||||
"const": "save"
|
||||
},
|
||||
"save_profile": {
|
||||
"const": "classic-career-v1"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"$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."
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"$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}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,152 @@
|
||||
FreeType font driver for BDF fonts
|
||||
|
||||
Francesco Zappa Nardelli
|
||||
<francesco.zappa.nardelli@ens.fr>
|
||||
|
||||
|
||||
Introduction
|
||||
************
|
||||
|
||||
BDF (Bitmap Distribution Format) is a bitmap font format defined by Adobe,
|
||||
which is intended to be easily understood by both humans and computers.
|
||||
This code implements a BDF driver for the FreeType library, following the
|
||||
Adobe Specification V 2.2. The specification of the BDF font format is
|
||||
available from Adobe's web site:
|
||||
|
||||
https://adobe-type-tools.github.io/font-tech-notes/pdfs/5005.BDF_Spec.pdf
|
||||
|
||||
Many good bitmap fonts in bdf format come with XFree86 (www.XFree86.org).
|
||||
They do not define vertical metrics, because the X Consortium BDF
|
||||
specification has removed them.
|
||||
|
||||
|
||||
Encodings
|
||||
*********
|
||||
|
||||
[This section is out of date, retained for historical reasons. BDF
|
||||
properties can be retrieved with `FT_Get_BDF_Property`, character set ID
|
||||
values with `FT_Get_BDF_Charset_ID`.]
|
||||
|
||||
The variety of encodings that accompanies bdf fonts appears to encompass the
|
||||
small set defined in freetype.h. On the other hand, two properties that
|
||||
specify encoding and registry are usually defined in bdf fonts.
|
||||
|
||||
I decided to make these two properties directly accessible, leaving to the
|
||||
client application the work of interpreting them. For instance:
|
||||
|
||||
|
||||
#include FT_INTERNAL_BDF_TYPES_H
|
||||
|
||||
FT_Face face;
|
||||
BDF_Public_Face bdfface;
|
||||
|
||||
|
||||
FT_New_Face( library, ..., &face );
|
||||
|
||||
bdfface = (BDF_Public_Face)face;
|
||||
|
||||
if ( ( bdfface->charset_registry == "ISO10646" ) &&
|
||||
( bdfface->charset_encoding == "1" ) )
|
||||
[..]
|
||||
|
||||
|
||||
Thus the driver always exports `ft_encoding_none' as face->charmap.encoding.
|
||||
FT_Get_Char_Index's behavior is unmodified, that is, it converts the ULong
|
||||
value given as argument into the corresponding glyph number.
|
||||
|
||||
If the two properties are not available, Adobe Standard Encoding should be
|
||||
assumed.
|
||||
|
||||
|
||||
Anti-Aliased Bitmaps
|
||||
********************
|
||||
|
||||
The driver supports an extension to the BDF format as used in Mark Leisher's
|
||||
xmbdfed bitmap font editor. Microsoft's SBIT tool expects bitmap fonts in
|
||||
that format for adding anti-aliased them to TrueType fonts. It introduces a
|
||||
fourth field to the `SIZE' keyword which gives the bpp value (bits per
|
||||
pixel) of the glyph data in the font. Possible values are 1 (the default),
|
||||
2 (four gray levels), 4 (16 gray levels), and 8 (256 gray levels). The
|
||||
driver returns either a bitmap with 1 bit per pixel or a pixmap with 8bits
|
||||
per pixel (using 4, 16, and 256 gray levels, respectively).
|
||||
|
||||
|
||||
Known problems
|
||||
**************
|
||||
|
||||
- A font is entirely loaded into memory. Obviously, this is not the Right
|
||||
Thing(TM). If you have big fonts I suggest you convert them into PCF
|
||||
format (using the bdftopcf utility): the PCF font drive of FreeType can
|
||||
perform incremental glyph loading.
|
||||
|
||||
When I have some time, I will implement on-demand glyph parsing.
|
||||
|
||||
- Except for encodings properties, client applications have no visibility of
|
||||
the PCF_Face object. This means that applications cannot directly access
|
||||
font tables and must trust FreeType.
|
||||
|
||||
- Currently, glyph names are ignored.
|
||||
|
||||
I plan to give full visibility of the BDF_Face object in an upcoming
|
||||
revision of the driver, thus implementing also glyph names.
|
||||
|
||||
- As I have never seen a BDF font that defines vertical metrics, vertical
|
||||
metrics are (parsed and) discarded. If you own a BDF font that defines
|
||||
vertical metrics, please let me know (I will implement them in 5-10
|
||||
minutes).
|
||||
|
||||
|
||||
License
|
||||
*******
|
||||
|
||||
Copyright (C) 2001-2002 by Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
*** Portions of the driver (that is, bdflib.c and bdf.h):
|
||||
|
||||
Copyright 2000 Computing Research Labs, New Mexico State University
|
||||
Copyright 2001-2002, 2011 Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the "Software"),
|
||||
to deal in the Software without restriction, including without limitation
|
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||||
THE COMPUTING RESEARCH LAB OR NEW MEXICO STATE UNIVERSITY BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
|
||||
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
|
||||
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
Credits
|
||||
*******
|
||||
|
||||
This driver is based on excellent Mark Leisher's bdf library. If you
|
||||
find something good in this driver you should probably thank him, not
|
||||
me.
|
||||
@@ -0,0 +1,169 @@
|
||||
The FreeType Project LICENSE
|
||||
----------------------------
|
||||
|
||||
2006-Jan-27
|
||||
|
||||
Copyright 1996-2002, 2006 by
|
||||
David Turner, Robert Wilhelm, and Werner Lemberg
|
||||
|
||||
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
The FreeType Project is distributed in several archive packages;
|
||||
some of them may contain, in addition to the FreeType font engine,
|
||||
various tools and contributions which rely on, or relate to, the
|
||||
FreeType Project.
|
||||
|
||||
This license applies to all files found in such packages, and
|
||||
which do not fall under their own explicit license. The license
|
||||
affects thus the FreeType font engine, the test programs,
|
||||
documentation and makefiles, at the very least.
|
||||
|
||||
This license was inspired by the BSD, Artistic, and IJG
|
||||
(Independent JPEG Group) licenses, which all encourage inclusion
|
||||
and use of free software in commercial and freeware products
|
||||
alike. As a consequence, its main points are that:
|
||||
|
||||
o We don't promise that this software works. However, we will be
|
||||
interested in any kind of bug reports. (`as is' distribution)
|
||||
|
||||
o You can use this software for whatever you want, in parts or
|
||||
full form, without having to pay us. (`royalty-free' usage)
|
||||
|
||||
o You may not pretend that you wrote this software. If you use
|
||||
it, or only parts of it, in a program, you must acknowledge
|
||||
somewhere in your documentation that you have used the
|
||||
FreeType code. (`credits')
|
||||
|
||||
We specifically permit and encourage the inclusion of this
|
||||
software, with or without modifications, in commercial products.
|
||||
We disclaim all warranties covering The FreeType Project and
|
||||
assume no liability related to The FreeType Project.
|
||||
|
||||
|
||||
Finally, many people asked us for a preferred form for a
|
||||
credit/disclaimer to use in compliance with this license. We thus
|
||||
encourage you to use the following text:
|
||||
|
||||
"""
|
||||
Portions of this software are copyright © <year> The FreeType
|
||||
Project (www.freetype.org). All rights reserved.
|
||||
"""
|
||||
|
||||
Please replace <year> with the value from the FreeType version you
|
||||
actually use.
|
||||
|
||||
|
||||
Legal Terms
|
||||
===========
|
||||
|
||||
0. Definitions
|
||||
--------------
|
||||
|
||||
Throughout this license, the terms `package', `FreeType Project',
|
||||
and `FreeType archive' refer to the set of files originally
|
||||
distributed by the authors (David Turner, Robert Wilhelm, and
|
||||
Werner Lemberg) as the `FreeType Project', be they named as alpha,
|
||||
beta or final release.
|
||||
|
||||
`You' refers to the licensee, or person using the project, where
|
||||
`using' is a generic term including compiling the project's source
|
||||
code as well as linking it to form a `program' or `executable'.
|
||||
This program is referred to as `a program using the FreeType
|
||||
engine'.
|
||||
|
||||
This license applies to all files distributed in the original
|
||||
FreeType Project, including all source code, binaries and
|
||||
documentation, unless otherwise stated in the file in its
|
||||
original, unmodified form as distributed in the original archive.
|
||||
If you are unsure whether or not a particular file is covered by
|
||||
this license, you must contact us to verify this.
|
||||
|
||||
The FreeType Project is copyright (C) 1996-2000 by David Turner,
|
||||
Robert Wilhelm, and Werner Lemberg. All rights reserved except as
|
||||
specified below.
|
||||
|
||||
1. No Warranty
|
||||
--------------
|
||||
|
||||
THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR COPYRIGHT HOLDERS
|
||||
BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE OR THE INABILITY TO
|
||||
USE, OF THE FREETYPE PROJECT.
|
||||
|
||||
2. Redistribution
|
||||
-----------------
|
||||
|
||||
This license grants a worldwide, royalty-free, perpetual and
|
||||
irrevocable right and license to use, execute, perform, compile,
|
||||
display, copy, create derivative works of, distribute and
|
||||
sublicense the FreeType Project (in both source and object code
|
||||
forms) and derivative works thereof for any purpose; and to
|
||||
authorize others to exercise some or all of the rights granted
|
||||
herein, subject to the following conditions:
|
||||
|
||||
o Redistribution of source code must retain this license file
|
||||
(`FTL.TXT') unaltered; any additions, deletions or changes to
|
||||
the original files must be clearly indicated in accompanying
|
||||
documentation. The copyright notices of the unaltered,
|
||||
original files must be preserved in all copies of source
|
||||
files.
|
||||
|
||||
o Redistribution in binary form must provide a disclaimer that
|
||||
states that the software is based in part of the work of the
|
||||
FreeType Team, in the distribution documentation. We also
|
||||
encourage you to put an URL to the FreeType web page in your
|
||||
documentation, though this isn't mandatory.
|
||||
|
||||
These conditions apply to any software derived from or based on
|
||||
the FreeType Project, not just the unmodified files. If you use
|
||||
our work, you must acknowledge us. However, no fee need be paid
|
||||
to us.
|
||||
|
||||
3. Advertising
|
||||
--------------
|
||||
|
||||
Neither the FreeType authors and contributors nor you shall use
|
||||
the name of the other for commercial, advertising, or promotional
|
||||
purposes without specific prior written permission.
|
||||
|
||||
We suggest, but do not require, that you use one or more of the
|
||||
following phrases to refer to this software in your documentation
|
||||
or advertising materials: `FreeType Project', `FreeType Engine',
|
||||
`FreeType library', or `FreeType Distribution'.
|
||||
|
||||
As you have not signed this license, you are not required to
|
||||
accept it. However, as the FreeType Project is copyrighted
|
||||
material, only this license, or another one contracted with the
|
||||
authors, grants you the right to use, distribute, and modify it.
|
||||
Therefore, by using, distributing, or modifying the FreeType
|
||||
Project, you indicate that you understand and accept all the terms
|
||||
of this license.
|
||||
|
||||
4. Contacts
|
||||
-----------
|
||||
|
||||
There are two mailing lists related to FreeType:
|
||||
|
||||
o freetype@nongnu.org
|
||||
|
||||
Discusses general use and applications of FreeType, as well as
|
||||
future and wanted additions to the library and distribution.
|
||||
If you are looking for support, start in this list if you
|
||||
haven't found anything to help you in the documentation.
|
||||
|
||||
o freetype-devel@nongnu.org
|
||||
|
||||
Discusses bugs, as well as engine internals, design issues,
|
||||
specific licenses, porting, etc.
|
||||
|
||||
Our home page can be found at
|
||||
|
||||
https://www.freetype.org
|
||||
|
||||
|
||||
--- end of FTL.TXT ---
|
||||
@@ -0,0 +1,96 @@
|
||||
FreeType font driver for PCF fonts
|
||||
|
||||
Francesco Zappa Nardelli
|
||||
<francesco.zappa.nardelli@ens.fr>
|
||||
|
||||
|
||||
Introduction
|
||||
************
|
||||
|
||||
PCF (Portable Compiled Format) is a binary bitmap font format, largely used
|
||||
in X world. This code implements a PCF driver for the FreeType library.
|
||||
Glyph images are loaded into memory only on demand, thus leading to a small
|
||||
memory footprint.
|
||||
|
||||
Information on the PCF font format can only be worked out from
|
||||
`pcfread.c', and `pcfwrite.c', to be found, for instance, in the XFree86
|
||||
(www.xfree86.org) source tree (xc/lib/font/bitmap/).
|
||||
|
||||
Many good bitmap fonts in bdf format come with XFree86: they can be
|
||||
compiled into the pcf format using the `bdftopcf' utility.
|
||||
|
||||
|
||||
Supported hardware
|
||||
******************
|
||||
|
||||
The driver has been tested on linux/x86 and sunos5.5/sparc. In both
|
||||
cases the compiler was gcc. When back in Paris, I will test it also
|
||||
on linux/alpha.
|
||||
|
||||
|
||||
Encodings
|
||||
*********
|
||||
|
||||
Use `FT_Get_BDF_Charset_ID' to access the encoding and registry.
|
||||
|
||||
The driver always exports `ft_encoding_none' as face->charmap.encoding.
|
||||
FT_Get_Char_Index() behavior is unmodified, that is, it converts the ULong
|
||||
value given as argument into the corresponding glyph number.
|
||||
|
||||
|
||||
Known problems
|
||||
**************
|
||||
|
||||
- dealing explicitly with encodings breaks the uniformity of FreeType 2
|
||||
API.
|
||||
|
||||
- except for encodings properties, client applications have no
|
||||
visibility of the PCF_Face object. This means that applications
|
||||
cannot directly access font tables and are obliged to trust
|
||||
FreeType.
|
||||
|
||||
- currently, glyph names and ink_metrics are ignored.
|
||||
|
||||
I plan to give full visibility of the PCF_Face object in the next
|
||||
release of the driver, thus implementing also glyph names and
|
||||
ink_metrics.
|
||||
|
||||
- height is defined as (ascent - descent). Is this correct?
|
||||
|
||||
- if unable to read size information from the font, PCF_Init_Face
|
||||
sets available_size->width and available_size->height to 12.
|
||||
|
||||
- too many english grammar errors in the readme file :-(
|
||||
|
||||
|
||||
License
|
||||
*******
|
||||
|
||||
Copyright (C) 2000 by Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
Credits
|
||||
*******
|
||||
|
||||
Keith Packard wrote the pcf driver found in XFree86. His work is at
|
||||
the same time the specification and the sample implementation of the
|
||||
PCF format. Undoubtedly, this driver is inspired from his work.
|
||||
@@ -0,0 +1,29 @@
|
||||
/* zlib.h -- interface of the 'zlib' general purpose compression library
|
||||
version 1.3, August 18th, 2023
|
||||
|
||||
Copyright (C) 1995-2023 Jean-loup Gailly and Mark Adler
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Jean-loup Gailly Mark Adler
|
||||
jloup@gzip.org madler@alumni.caltech.edu
|
||||
|
||||
|
||||
The data format used by the zlib library is described by RFCs (Request for
|
||||
Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
|
||||
(zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
|
||||
*/
|
||||
@@ -0,0 +1,46 @@
|
||||
FREETYPE LICENSES
|
||||
-----------------
|
||||
|
||||
The FreeType 2 font engine is copyrighted work and cannot be used
|
||||
legally without a software license. In order to make this project
|
||||
usable to a vast majority of developers, we distribute it under two
|
||||
mutually exclusive open-source licenses.
|
||||
|
||||
This means that *you* must choose *one* of the two licenses described
|
||||
below, then obey all its terms and conditions when using FreeType 2 in
|
||||
any of your projects or products.
|
||||
|
||||
- The FreeType License, found in the file `docs/FTL.TXT`, which is
|
||||
similar to the original BSD license *with* an advertising clause
|
||||
that forces you to explicitly cite the FreeType project in your
|
||||
product's documentation. All details are in the license file.
|
||||
This license is suited to products which don't use the GNU General
|
||||
Public License.
|
||||
|
||||
Note that this license is compatible to the GNU General Public
|
||||
License version 3, but not version 2.
|
||||
|
||||
- The GNU General Public License version 2, found in
|
||||
`docs/GPLv2.TXT` (any later version can be used also), for
|
||||
programs which already use the GPL. Note that the FTL is
|
||||
incompatible with GPLv2 due to its advertisement clause.
|
||||
|
||||
The contributed BDF and PCF drivers come with a license similar to
|
||||
that of the X Window System. It is compatible to the above two
|
||||
licenses (see files `src/bdf/README` and `src/pcf/README`). The same
|
||||
holds for the source code files `src/base/fthash.c` and
|
||||
`include/freetype/internal/fthash.h`; they were part of the BDF driver
|
||||
in earlier FreeType versions.
|
||||
|
||||
The gzip module uses the zlib license (see `src/gzip/zlib.h`) which
|
||||
too is compatible to the above two licenses.
|
||||
|
||||
The files `src/autofit/ft-hb.c` and `src/autofit/ft-hb.h` contain code
|
||||
taken almost verbatim from the HarfBuzz file `hb-ft.cc`, which uses
|
||||
the 'Old MIT' license, compatible to the above two licenses.
|
||||
|
||||
The MD5 checksum support (only used for debugging in development
|
||||
builds) is in the public domain.
|
||||
|
||||
|
||||
--- end of LICENSE.TXT ---
|
||||
@@ -0,0 +1,504 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
|
||||
USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random
|
||||
Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
@@ -0,0 +1,7 @@
|
||||
LZMA SDK
|
||||
--------
|
||||
|
||||
This package also contains some files from LZMA SDK
|
||||
You can download LZMA SDK from:
|
||||
http://www.7-zip.org/sdk.html
|
||||
LZMA SDK is written and placed in the public domain by Igor Pavlov.
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,31 @@
|
||||
/* Nuked OPL3
|
||||
* Copyright (C) 2013-2020 Nuke.YKT
|
||||
*
|
||||
* This file is part of Nuked OPL3.
|
||||
*
|
||||
* Nuked OPL3 is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as
|
||||
* published by the Free Software Foundation, either version 2.1
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* Nuked OPL3 is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Nuked OPL3. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
* Nuked OPL3 emulator.
|
||||
* Thanks:
|
||||
* MAME Development Team(Jarek Burczynski, Tatsuyuki Satoh):
|
||||
* Feedback and Rhythm part calculation information.
|
||||
* forums.submarine.org.uk(carbon14, opl3):
|
||||
* Tremolo and phase generator calculation information.
|
||||
* OPLx decapsulated(Matthew Gambrell, Olli Niemitalo):
|
||||
* OPL2 ROMs.
|
||||
* siliconpr0n.org(John McMaster, digshadow):
|
||||
* YMF262 and VRC VII decaps and die shots.
|
||||
*
|
||||
* version: 1.8
|
||||
*/
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,18 @@
|
||||
# Included license texts
|
||||
|
||||
These files preserve upstream license and attribution wording. They are not a grant covering original game content. OpenBMH's GPL-3.0-only notice and the full GPLv3 text are in the root [README](../../README.md) and [LICENSE](../../LICENSE).
|
||||
|
||||
- [SDL2](SDL2.txt): SDL 2.32.10 `LICENSE.txt`.
|
||||
- SDL2's bundled HIDAPI: [license options](SDL2-HIDAPI-options.txt), [BSD-3-Clause](SDL2-HIDAPI-BSD.txt), [original license](SDL2-HIDAPI-original.txt).
|
||||
- [SDL2 yuv2rgb](SDL2-yuv2rgb.txt): BSD-3-Clause notice for that included source component.
|
||||
- [miniz](miniz.txt): the MIT license shipped with the 3.0.2 amalgamation. [Additional verbatim source notices](miniz-source-notices.txt), including the additional copyright attribution and public-domain dedication, are also retained.
|
||||
- [LZMA SDK](LZMA-SDK.txt): the public-domain declaration from the 7-Zip 24.09 documentation. Only individually marked public-domain decoder files are used.
|
||||
- [nativefiledialog-extended](nativefiledialog-extended.txt): version 1.2.1 zlib license.
|
||||
- [RmlUi](RmlUi.txt): 6.3 MIT license, including the separate [container notices](RmlUi-containers.txt) and [Khronos backend notice](RmlUi-Khronos.txt).
|
||||
- [FreeType](FreeType.txt): 2.13.3 license choices, with the [FTL](FreeType-FTL.txt) selected for this build and [BDF](FreeType-BDF.txt), [PCF](FreeType-PCF.txt) and [gzip/zlib](FreeType-zlib.txt) notices preserved.
|
||||
- [Lato font notices](RmlUi-fonts.txt): unmodified Regular and Bold Latin fonts from RmlUi 6.3, under SIL OFL 1.1. The upstream sample-font notice is retained verbatim.
|
||||
- [Nuked OPL3 copyright and license notice](Nuked-OPL3-notices.txt): unchanged leading notice from its vendored implementation.
|
||||
- [LGPL version 2.1](LGPL-2.1.txt): full license supplied with Nuked OPL3. Its source notices permit version 2.1 or any later version.
|
||||
- Optional native editor: [nlohmann/json](nlohmann-json.txt), [cpp-httplib](cpp-httplib.txt), [SDL2_image](SDL2_image.txt), [stb_image](stb-image.txt), [libwebp](libwebp.txt) with its [patent grant](libwebp-PATENTS.txt), [LunaSVG](LunaSVG.txt), [PlutoVG](PlutoVG.txt), and [pugixml](pugixml.txt). These are verbatim upstream notices for the pinned versions listed in the root notices.
|
||||
|
||||
[THIRD_PARTY_NOTICES.md](../../THIRD_PARTY_NOTICES.md) identifies the upstream versions and distribution requirements. Include this directory, that notice file and the root LICENSE with release packages. Preserve upstream attribution within these verbatim texts.
|
||||
@@ -0,0 +1,22 @@
|
||||
/*
|
||||
** Copyright (c) 2008-2018 The Khronos Group Inc.
|
||||
**
|
||||
** Permission is hereby granted, free of charge, to any person obtaining a
|
||||
** copy of this software and/or associated documentation files (the
|
||||
** "Materials"), to deal in the Materials without restriction, including
|
||||
** without limitation the rights to use, copy, modify, merge, publish,
|
||||
** distribute, sublicense, and/or sell copies of the Materials, and to
|
||||
** permit persons to whom the Materials are furnished to do so, subject to
|
||||
** the following conditions:
|
||||
**
|
||||
** The above copyright notice and this permission notice shall be included
|
||||
** in all copies or substantial portions of the Materials.
|
||||
**
|
||||
** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
||||
*/
|
||||
@@ -0,0 +1,58 @@
|
||||
RmlUi Core contains thirdparty libraries. They are listed below along with
|
||||
their full licenses - all MIT licensed.
|
||||
|
||||
---
|
||||
|
||||
robin_hood unordered map & set
|
||||
https://github.com/martinus/robin-hood-hashing
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2018-2020 Martin Ankerl <http://martin.ankerl.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
---
|
||||
|
||||
itlib
|
||||
https://github.com/iboB/itlib
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright(c) 2016-2019 Chobolabs Inc.
|
||||
Copyright(c) 2020-2023 Borislav Stanimirov
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files(the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and / or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions :
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,316 @@
|
||||
The RmlUi samples include fonts that are separately licensed. They are listed
|
||||
below along with their licenses.
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- Lato ---
|
||||
--- http://www.latofonts.com/ ---
|
||||
--- ---
|
||||
--- LatoLatin-Bold.ttf ---
|
||||
--- LatoLatin-BoldItalic.ttf ---
|
||||
--- LatoLatin-Italic.ttf ---
|
||||
--- LatoLatin-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
Copyright (c) 2010-2015, Łukasz Dziedzic (dziedzic@typoland.com),
|
||||
with Reserved Font Name Lato.
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- Noto Emoji ---
|
||||
--- https://www.google.com/get/noto/ ---
|
||||
--- ---
|
||||
--- NotoEmoji-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License,
|
||||
Version 1.1.
|
||||
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font
|
||||
creation efforts of academic and linguistic communities, and to
|
||||
provide a free and open framework in which fonts may be shared and
|
||||
improved in partnership with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply to
|
||||
any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software
|
||||
components as distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to,
|
||||
deleting, or substituting -- in part or in whole -- any of the
|
||||
components of the Original Version, by changing formats or by porting
|
||||
the Font Software to a new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed,
|
||||
modify, redistribute, and sell modified and unmodified copies of the
|
||||
Font Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components, in
|
||||
Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the
|
||||
corresponding Copyright Holder. This restriction only applies to the
|
||||
primary font name as presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created using
|
||||
the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- RobotoMono ---
|
||||
--- https://fonts.google.com/ ---
|
||||
--- ---
|
||||
--- RobotoMono-Bold.ttf ---
|
||||
--- RobotoMono-BoldItalic.ttf ---
|
||||
--- RobotoMono-Italic.ttf ---
|
||||
--- RobotoMono-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
https://openfontlicense.org
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
@@ -0,0 +1,22 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2008-2014 CodePoint Ltd, Shift Technology Ltd, and contributors
|
||||
Copyright (c) 2019-2026 The RmlUi Team, and contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,26 @@
|
||||
Copyright (c) 2010, Alan Ott, Signal 11 Software
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of Signal 11 Software nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
@@ -0,0 +1,13 @@
|
||||
HIDAPI can be used under one of three licenses.
|
||||
|
||||
1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt
|
||||
2. A BSD-Style License, in LICENSE-bsd.txt.
|
||||
3. The more liberal original HIDAPI license. LICENSE-orig.txt
|
||||
|
||||
The license chosen is at the discretion of the user of HIDAPI. For example:
|
||||
1. An author of GPL software would likely use HIDAPI under the terms of the
|
||||
GPL.
|
||||
|
||||
2. An author of commercial closed-source software would likely use HIDAPI
|
||||
under the terms of the BSD-style license or the original HIDAPI license.
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
HIDAPI - Multi-Platform library for
|
||||
communication with HID devices.
|
||||
|
||||
Copyright 2009, Alan Ott, Signal 11 Software.
|
||||
All Rights Reserved.
|
||||
|
||||
This software may be used by anyone for any reason so
|
||||
long as the copyright notice in the source files
|
||||
remains intact.
|
||||
@@ -0,0 +1,27 @@
|
||||
Copyright (c) 2016, Adrien Descamps
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of yuv2rgb nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
@@ -0,0 +1,18 @@
|
||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
@@ -0,0 +1,22 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 yhirose
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
Additional IP Rights Grant (Patents)
|
||||
------------------------------------
|
||||
|
||||
"These implementations" means the copyrightable works that implement the WebM
|
||||
codecs distributed by Google as part of the WebM Project.
|
||||
|
||||
Google hereby grants to you a perpetual, worldwide, non-exclusive, no-charge,
|
||||
royalty-free, irrevocable (except as stated in this section) patent license to
|
||||
make, have made, use, offer to sell, sell, import, transfer, and otherwise
|
||||
run, modify and propagate the contents of these implementations of WebM, where
|
||||
such license applies only to those patent claims, both currently owned by
|
||||
Google and acquired in the future, licensable by Google that are necessarily
|
||||
infringed by these implementations of WebM. This grant does not include claims
|
||||
that would be infringed only as a consequence of further modification of these
|
||||
implementations. If you or your agent or exclusive licensee institute or order
|
||||
or agree to the institution of patent litigation or any other patent
|
||||
enforcement activity against any entity (including a cross-claim or
|
||||
counterclaim in a lawsuit) alleging that any of these implementations of WebM
|
||||
or any code incorporated within any of these implementations of WebM
|
||||
constitute direct or contributory patent infringement, or inducement of
|
||||
patent infringement, then any patent rights granted to you under this License
|
||||
for these implementations of WebM shall terminate as of the date such
|
||||
litigation is filed.
|
||||
@@ -0,0 +1,30 @@
|
||||
Copyright (c) 2010, Google Inc. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
* Neither the name of Google nor the names of its contributors may
|
||||
be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
/**************************************************************************
|
||||
*
|
||||
* Copyright 2013-2014 RAD Game Tools and Valve Software
|
||||
* Copyright 2010-2014 Rich Geldreich and Tenacious Software LLC
|
||||
* All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
**************************************************************************/
|
||||
|
||||
/*
|
||||
This is free and unencumbered software released into the public domain.
|
||||
|
||||
Anyone is free to copy, modify, publish, use, compile, sell, or
|
||||
distribute this software, either in source code form or as a compiled
|
||||
binary, for any purpose, commercial or non-commercial, and by any
|
||||
means.
|
||||
|
||||
In jurisdictions that recognize copyright laws, the author or authors
|
||||
of this software dedicate any and all copyright interest in the
|
||||
software to the public domain. We make this dedication for the benefit
|
||||
of the public at large and to the detriment of our heirs and
|
||||
successors. We intend this dedication to be an overt act of
|
||||
relinquishment in perpetuity of all present and future rights to this
|
||||
software under copyright law.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||||
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
||||
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
For more information, please refer to <http://unlicense.org/>
|
||||
*/
|
||||
|
||||
/* Simple PNG writer function by Alex Evans, 2011. Released into the public domain: https://gist.github.com/908299, more context at
|
||||
http://altdevblogaday.org/2011/04/06/a-smaller-jpg-encoder/.
|
||||
This is actually a modification of Alex's original code so PNG files generated by this function pass pngcheck. */
|
||||
|
||||
/**************************************************************************
|
||||
*
|
||||
* Copyright 2013-2014 RAD Game Tools and Valve Software
|
||||
* Copyright 2010-2014 Rich Geldreich and Tenacious Software LLC
|
||||
* Copyright 2016 Martin Raiber
|
||||
* All Rights Reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
**************************************************************************/
|
||||
Loaded 100 of 1377 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user