Initial public OpenBMH 0.1 source (by Codex)
This commit is contained in:
commit
558fbf166b
613 files changed
+168029
No files matched your search
@@ -0,0 +1,52 @@
|
||||
# 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 and nativefiledialog-extended 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_play` (graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
|
||||
|
||||
## 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 dialog backend. The default Linux dialog backend uses GTK3. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries.
|
||||
|
||||
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.
|
||||
|
||||
## Run with your data
|
||||
|
||||
```sh
|
||||
build/openbmh_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
build/openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --seed 1
|
||||
```
|
||||
|
||||
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,351 @@
|
||||
# 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, 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` | – | staff levels and the youth academy |
|
||||
| `SetStaffLevel` | role:enum(AssistantCoach,Doctor,Physio), level:int(0..6) | click a staff tile: level 0..6, 5 000 a month each |
|
||||
| `SetYouthAcademy` | state:enum(On,Off) | start (July/August) or stop the youth academy |
|
||||
|
||||
### `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, 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,13 @@
|
||||
# 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.
|
||||
@@ -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 --data "path/to/game" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
|
||||
|
||||
For separate manager processes, start a local mailbox server:
|
||||
|
||||
```sh
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
|
||||
```
|
||||
|
||||
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,37 @@
|
||||
# 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/cli/console/windows_environment.cpp](../src/cli/console/windows_environment.cpp): uses monthly staff levels in increments of five thousand and the supported youth-academy controls.
|
||||
- [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/balance_plan.cpp](../src/game/balance_plan.cpp): omits the discontinued youth-group cost categories and uses league-specific youth-academy limits.
|
||||
- [src/game/balance_plan.hpp](../src/game/balance_plan.hpp): uses the supported staff and youth-academy cost categories.
|
||||
- [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): enables the supported youth academy and represents staff levels in monthly increments of five thousand.
|
||||
- [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/month.cpp](../src/game/month.cpp): omits the two discontinued youth-group cost categories from monthly accounts.
|
||||
- [src/game/season.cpp](../src/game/season.cpp): uses the enhanced youth-academy season settlement and player-generation rules.
|
||||
- [src/game/season.hpp](../src/game/season.hpp): uses the enhanced youth-academy season settlement and player-generation rules.
|
||||
- [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/ui/advertising.cpp](../src/ui/advertising.cpp): uses the supported youth-academy cap and its saved cost fields.
|
||||
- [src/ui/environment.cpp](../src/ui/environment.cpp): omits the two discontinued youth groups from the environment screen.
|
||||
- [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): omits DOS drive and delete buttons in the directory-confined save/load view.
|
||||
+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,29 @@
|
||||
# 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: open data and typed state
|
||||
|
||||
Introduce a documented import format and a native save format, retaining supported legacy import where practical. Replace fixed-layout state gradually with typed clubs, players, contracts and competitions. Keep each intermediate stage usable and cover transitions with tests.
|
||||
|
||||
## 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 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,39 @@
|
||||
# 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` | Locating user data, archive extraction, edition normalisation and file selection |
|
||||
|
||||
`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.
|
||||
|
||||
## 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 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,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,25 @@
|
||||
# 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 |
|
||||
|
||||
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,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,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,14 @@
|
||||
# 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.
|
||||
- [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.
|
||||
|
||||
[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,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,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.
|
||||
*
|
||||
**************************************************************************/
|
||||
@@ -0,0 +1,22 @@
|
||||
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.
|
||||
@@ -0,0 +1,16 @@
|
||||
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,72 @@
|
||||
# JSON Lines request protocol
|
||||
|
||||
`openbmh_cli` without `--console` offers a small JSON request adapter for a single `app::CareerSession`. It reads one JSON object per line and writes one response per line. `--text` is an interactive shorthand for this adapter. The broader window-oriented console and its `--json` output are a separate interface; use the [console reference](CLI_CONCEPT/README.md) for interactive questions, live matches and multiple manager clients.
|
||||
|
||||
```sh
|
||||
openbmh_cli --data "path/to/game" --seed 1 --json
|
||||
openbmh_cli --data "path/to/game" --seed 1 --json --log session.jsonl
|
||||
openbmh_cli --replay session.jsonl --json
|
||||
```
|
||||
|
||||
A request has `cmd` and the fields accepted for that command. Mutations carry an integer `manager` and the current `revision`. Responses contain `ok` and `revision`; errors add a stable `error` code and can include diagnostic `detail`. A rejected stale or foreign action must not mutate the projected state. Seed values are unsigned 32-bit decimal or hexadecimal values.
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Fields | Behavior |
|
||||
|---|---|---|
|
||||
| `help` | — | Machine-readable command and parameter list. |
|
||||
| `new` | `options`, `managers` | Creates a career. This adapter accepts exactly one manager. `options` supports `duration` (0–5), `difficulty` (0–9), `mode` (0–3), `league`, `world`, and `managers:1`. The single manager has `name`, `master_club`, optional `start_league`, `strength` (0–2), and `portrait` (0–11). |
|
||||
| `load` | `path` | Loads through `CareerSession`; a failed load leaves the current career active. |
|
||||
| `save` | `manager`, `revision`, `path`, optional `overwrite` | Saves through the Session after checking the current manager and revision. |
|
||||
| `status`, `desk` | — | Read the desktop projection and a compact status object. |
|
||||
| `kickoff` | `manager`, `revision` | Calls the existing turn driver through `dispatch_kickoff`, advancing to the next desk. Returns state and available desk/audio event metadata. |
|
||||
| `results` | — | Reads the owned results of the last completed event; `kickoff` also returns this object. A manager handoff or empty event has no new results. |
|
||||
| `tactics`, `training` | — | Read current preparation values. Reading training does not initialize or recalculate it. |
|
||||
| `tactics.set` | envelope, `index` (0–7), `value` | Sets a supported tactic; index 0 also disables the attitude assistant. |
|
||||
| `training.initialize` | envelope | Performs the normal first-open initialization only when needed. |
|
||||
| `training.type`, `training.area` | envelope, `index`, `value` (1–3) | Changes one of 4 types or 9 areas, validating supported plan limits and automation flags. |
|
||||
| `training.intensity` | envelope, `row`, `value` (1–3) | Changes the player currently occupying the selected squad row. |
|
||||
| `training.focus` | envelope, `row` | Cycles that player's training focus. |
|
||||
| `training.auto` | envelope, `index` (0–4), `value` (0–1) | Toggles a training automation bit, validating the expected value and visible context. |
|
||||
| `table` | `manager`, `league` (0–8) | Reads the selected full-season overall table in Engine rank order, with point deductions. Requires the active manager. |
|
||||
| `mail` | `manager` (0–3) | Reads the selected existing manager's mailbox, sorted by date and physical slot. Does not mark, keep or delete messages. |
|
||||
| `camp.focus` | envelope, `focus` (4 integers) | Dispatches a training-camp focus change. |
|
||||
| `camp.book` | envelope, `resort` (0–7) | Books the selected camp. |
|
||||
| `bank.deposit`, `bank.withdraw` | envelope, positive `amount` | Moves funds through the bank dispatch API. |
|
||||
| `bank.shares.buy`, `bank.shares.sell`, `bank.tip` | envelope, `asset` (0–11), optional `count` | Uses the bank dispatch API. |
|
||||
| `bank.fund.buy`, `bank.fund.sell` | envelope, `asset` (0–5), `count` (1–10) | Uses the bank dispatch API. |
|
||||
| `stadium.open` | envelope | Opens the existing stadium projection/action. |
|
||||
| `stadium.offer` | envelope, `object` (0–13) | Requests the existing periphery quote. |
|
||||
| `stadium.build`, `stadium.decline` | envelope, `object` (0–13), `price` | Uses the existing stadium dispatch API. |
|
||||
| `toto.submit` | envelope, `stake`, `tips` (11 values, each 0–2) | Submits through the existing Toto dispatch API. |
|
||||
| `quit` | — | Ends the input loop. |
|
||||
|
||||
The `envelope` above means integer `manager` and `revision`. This adapter uses one manager,
|
||||
slot 0; a different manager or stale revision is rejected. A failed `new` does not
|
||||
create a Session. A successful `load` starts a new CLI revision sequence.
|
||||
|
||||
The text mode is intentionally narrower: `help`, `new <master_club> <quoted name>
|
||||
[strength]`, `load <quoted path>`, `save <quoted path>`, `status`, `desk`, `kickoff`,
|
||||
`camp.book <resort>`, `results`, `tactics`, `tactics.set <index> <value>`, `training`,
|
||||
`training.initialize`, `training.type <index> <value>`, `training.area <index> <value>`,
|
||||
`training.intensity <row> <value>`, `training.focus <row>`,
|
||||
`training.auto <index> <value>`, `table <manager> <league>`, `mail <manager>`,
|
||||
bank deposit/withdraw/share/fund/tip actions, and `quit`. `help`
|
||||
prints parameter hints. Use JSON mode for all option fields, camp focus, stadium and Toto
|
||||
requests, and for machine clients.
|
||||
|
||||
## Errors and scope
|
||||
|
||||
Malformed JSON, unexpected fields and invalid field types return `invalid_request`. Unknown operations return `unsupported_command`; recognised operations without a session adapter return `career_session_api_unavailable`. `help` describes the command set implemented by this adapter. An operation can also be rejected by its normal phase, mode, manager or rule checks. These outcomes must not be converted into successful client-side approximations.
|
||||
|
||||
This adapter does not expose the console's full squad, calendar, finance, live-match, question/answer or multi-seat interfaces. Its `new` operation requires one manager. A loaded career is subject to the session's actual continuation and revision checks; a successful read alone is not a claim that every later action is available in this adapter.
|
||||
|
||||
`table` returns owned club names, a club identity key, runtime team ID, ranks, games, wins/draws/losses, goals and points. Identity keys, runtime positions and master database indices are distinct. `mail` returns a snapshot of mailbox slots and recipient/keep masks. Keeping is not the same as marking read. Slot references can change when messages are compacted and are not persistent message IDs.
|
||||
|
||||
## Log and replay
|
||||
|
||||
`--log FILE` writes a header with protocol version, data location and seed, then canonical request/response records. `--replay FILE` repeats those requests and reports a mismatch. Replay can overwrite a path recorded by a save operation, so use an isolated writable save directory. Keep the same compatible binary and data when comparing a run.
|
||||
|
||||
The log contains supplied values and game responses, potentially including proprietary text or personal paths. It is not a distributable substitute for game data, nor a complete serialisation of every hidden session mechanism. Do not attach a full game log or save to a public issue; prepare minimal independently written reproduction steps.
|
||||
|
||||
Text errors use `ERROR <code>: <detail>`; successful text replies use `OK`. JSON mode emits one JSON response per request line. Transport framing and field names are part of this adapter's API; executable table addresses are not.
|
||||
@@ -0,0 +1,44 @@
|
||||
OpenBMH v0.1.0
|
||||
===============
|
||||
|
||||
OpenBMH ist eine eigenstaendige Neuumsetzung der Engine von Bundesliga Manager
|
||||
Hattrick und der englischen Fassung Football Limited. Die englische Unterstuetzung
|
||||
ist experimentell. Originale Spielinhalte sind nicht enthalten; du benoetigst eine
|
||||
eigene unterstuetzte Installation. Originale V2.20-Spielstaende der englischen
|
||||
Fassung sind nicht mit dem unterstuetzten Speicherlayout austauschbar.
|
||||
|
||||
Start
|
||||
-----
|
||||
Paket in einen eigenen Ordner oder neben die Installation entpacken.
|
||||
openbmh_play starten (unter Windows openbmh_play.exe). Der Dateidialog nimmt einen
|
||||
Spielordner, die Programmdatei oder ZIP/7z mit einer einzelnen Installation an.
|
||||
|
||||
Aus einem Terminal:
|
||||
openbmh_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves"
|
||||
|
||||
Unter Windows den Programmnamen um .exe ergaenzen. Ein beschreibbarer separater
|
||||
Spielstandordner wird empfohlen. Vorhandene Spielstaende vorher sichern.
|
||||
Tonoptionen: --mute, --no-music, --volume 0.5. --version zeigt die Programmversion.
|
||||
In der Konsole zeigt ListOptions die aktuellen Befehle; eine eigene Zeile go.
|
||||
fuehrt den eingegebenen Block aus. Help beschreibt die Parameter.
|
||||
|
||||
Dokumentation und Rueckmeldungen
|
||||
-------------------------------
|
||||
README.md enthaelt die Bauanleitungen fuer Windows, Linux und macOS.
|
||||
Die Releasehinweise beschreiben den Umfang und die bekannten Grenzen.
|
||||
Linux benoetigt je nach Paket Systembibliotheken, insbesondere GTK3 fuer den
|
||||
Standard-Dateidialog. Plattform-Bauhinweise sind kein Nachweis eines nativen Tests.
|
||||
|
||||
Fehler mit Programmversion, Spielfassung und kurzen eigenen Schritten melden.
|
||||
Keine Originaldateien, Spielbilder, Aufnahmen, Textlisten oder Spielstaende in
|
||||
oeffentliche Issues hochladen.
|
||||
|
||||
Lizenz
|
||||
------
|
||||
Eigener OpenBMH-Code und Dokumentation: GNU GPL Version 3 ausschliesslich
|
||||
(GPL-3.0-only). LICENSE enthaelt den vollstaendigen Text. Drittanbieter behalten
|
||||
ihre Lizenzen; siehe THIRD_PARTY_NOTICES.md und docs/licenses/.
|
||||
Diese Lizenzen gelten nicht fuer die separat benoetigten Originalinhalte.
|
||||
OpenBMH ist ein unabhaengiges Projekt ohne Verbindung oder Billigung durch die
|
||||
urspruenglichen Rechteinhaber, DFL oder Bundesliga.
|
||||
@@ -0,0 +1,32 @@
|
||||
# OpenBMH v0.1.0
|
||||
|
||||
OpenBMH reconstructs the Bundesliga Manager Hattrick engine in C++20. The graphical client uses SDL2; the console provides command batches and local manager-client transports over the same career session. This release needs a supported game installation supplied by the player. No original executable, artwork, music, text database, manual or saved game is included.
|
||||
|
||||
## Scope
|
||||
|
||||
The engine includes career management, leagues and cups, transfers and contracts, finances, training and camps, stadium management, live match interventions, audio playback and normal saves. Supported actions remain subject to mode, manager and phase restrictions; an unimplemented path reports an explicit error rather than an invented result. The project aims for recognisable behaviour and plausible results, not a promise that every original version produces identical events.
|
||||
|
||||
German game editions are the primary compatibility target. **Football Limited support is experimental.** English installation loading and edition-specific text/layout data are supported paths, while original V2.20 save import, English audio and remaining competition/interface differences have limitations. Check current issues before relying on a particular English workflow.
|
||||
|
||||
## Compatibility decisions
|
||||
|
||||
OpenBMH uses shared rule values across supported German editions, with installation-specific content read from the selected data. It includes safety handling around invalid input, calendar boundaries, capacity checks and suspended operations. See [compatibility decisions](../../COMPATIBILITY.md) and [architecture](../../architecture.md). This is an independent reconstruction, not an official update to the original game.
|
||||
|
||||
## Running
|
||||
|
||||
Extract the package to a separate directory or alongside your installation. `openbmh_play` can select a game directory, executable or a ZIP/7z containing one supported installation. Use an explicit writable save directory when the original directory is read-only, and keep backups.
|
||||
|
||||
```sh
|
||||
openbmh_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves"
|
||||
```
|
||||
|
||||
Packages and their native platform results are listed with the release assets. The [build instructions](../../BUILDING.md) cover Windows, Linux and macOS source builds; an instruction is not a claim of native acceptance. Linux's default file dialog backend requires GTK3 system libraries. A macOS terminal executable is distinct from a signed application bundle.
|
||||
|
||||
## License
|
||||
|
||||
The matching application source tag is [v0.1.0](https://github.com/rezmer/openbmh/tree/v0.1.0). Source/build and relinking materials for linked components must also accompany or be offered with binary releases under their licenses.
|
||||
|
||||
OpenBMH-owned code and documentation use GPL-3.0-only. Third-party components retain their licenses; the full texts accompany the package. Read [LICENSE](../../../LICENSE) and [THIRD_PARTY_NOTICES](../../../THIRD_PARTY_NOTICES.md). These licenses do not grant rights to original game content.
|
||||
|
||||
For reports, include the OpenBMH version, data edition, independently written steps and the observed result. Do not upload original files, game screenshots, recordings, text collections or saved games to public issues.
|
||||
Reference in new issue
Block a user