Prepare game 0.2.0 and standalone editor 0.5.0 releases (by Codex)
OBW Editor / editor (linux-x64, ubuntu-24.04) (push) Canceled after 0s
OBW Editor / editor (macos-arm64, macos-14) (push) Canceled after 0s
OBW Editor / editor (windows-x64, windows-2022) (push) Canceled after 0s
OBW Editor / release (push) Canceled after 0s
Build without game data / build (windows-x64, windows-2022) (push) Canceled after 0s
Build without game data / build (macos-arm64, macos-14) (push) Canceled after 0s
Build without game data / build (linux-x64, ubuntu-24.04) (push) Canceled after 0s
Prepare release packages / build (push) Canceled after 0s
Prepare release packages / draft (push) Canceled after 0s

This commit is contained in:
Codex committed 2026-10-22 23:32:54 +02:00
1 parent 6636308cad
commit a447d9282a
22 files changed
+185 -38

No files matched your search

+6 -6
View File
@@ -1,10 +1,10 @@
# OpenBMH Editor POC
# OpenBMH Editor 0.5.0
Der eigenständige, native Editor verwendet **RmlUI, SDL2 und OpenGL**. Er bearbeitet Startdatenbanken, keine laufenden Spielstände. Das Spiel und seine Classic-Prüfung bleiben unverändert.
Der eigenständige, native Editor verwendet **RmlUI, SDL2 und OpenGL**. Er bearbeitet Startdatenbanken, keine laufenden Spielstände. Das Spiel und seine Classic-Prüfung bleiben unverändert. Editor 0.5.0 hat eine eigene Versionsreihe und den Release-Tag `editor-v0.5.0`; die Spielversion ist 0.2.0.
## Starten und Daten öffnen
Das vollständige Editor-Paket entpacken und `OpenBMHEditor.exe` (Windows) beziehungsweise `OpenBMHEditor` (Linux/macOS) starten. `assets/editor` muss beim Programm bleiben. Auf macOS kann die unsignierte Testanwendung über **Rechtsklick → Öffnen** gestartet werden. Eine Signatur/Notarisierung ist nicht Bestandteil dieses POC.
Das vollständige Paket `OpenBMHEditor-0.5.0-<plattform>.zip` entpacken und `OpenBMHEditor.exe` (Windows) beziehungsweise `OpenBMHEditor` (Linux/macOS) starten. `assets/editor` muss beim Programm bleiben. Auf macOS kann die unsignierte Anwendung über **Rechtsklick → Öffnen** gestartet werden. Eine Signatur/Notarisierung ist nicht Bestandteil dieser Version. `OpenBMHEditor --version` zeigt die Editorversion ohne Grafikstart.
**Öffnen** bietet OBW-Dateien und entpackte Welten an. **BMH / FLTD importieren** liest einen Ordner mit einer unterstützten BMH- oder Football-Limited-Installation durch den bestehenden Konverter. Das Original wird nicht überschrieben. Eine bestehende Classic-OBW wird zunächst überprüft und dann in eine bearbeitbare Editorwelt übernommen.
@@ -50,7 +50,7 @@ Voraussetzungen entsprechen dem Hauptprojekt: C++20-Compiler, Git, CMake ≥ 3.2
```sh
cmake -S . -B build-editor -G Ninja -DCMAKE_BUILD_TYPE=Release -DOPENBMH_BUILD_EDITOR=ON
cmake --build build-editor --target openbmh_editor editor_core_tests --parallel 2
ctest --test-dir build-editor -C Release -R '^editor_core_tests$' --output-on-failure
ctest --test-dir build-editor -C Release -R '^editor_(core_tests|version)$' --output-on-failure
```
macOS ARM zusätzlich bei der Konfiguration: `-DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0`. Unter Windows das Argument nach `-R` ohne einfache Shell-Anführungszeichen verwenden. Der Editor wird beim normalen Spiel-Build standardmäßig nicht mitgebaut.
@@ -65,7 +65,7 @@ build-editor/OpenBMHEditor --stdio-mcp --open world.obw
Weitere Argumente: `--settings datei.json`, `--assets verzeichnis`, `--commands script.json`, `--print-mcp-config`. Ein Command-Script ist ein Array aus `{"command":"…","args":{…}}`, mit denselben Kommandos wie die gemeinsame Session (z. B. `get`, `apply`, `save`). `--headless` startet kein Fenster. `--stdio-mcp` bietet dieselben Werkzeuge über newline-delimited JSON-RPC; stdout enthält dabei ausschließlich Protokollnachrichten. Testaufnahmen: `--screenshot bild.png --quit-after-ms 1800 --page clubs` (unter Linux mit Xvfb möglich).
Pakete baut `tools/package/make_editor_package.py --build build-editor --out dist --platform linux-x64` (oder `windows-x64`, `macos-arm64`). `--source-package` ergänzt den zugehörigen Quellcode mit den tatsächlich verwendeten, gepinnten Abhängigkeiten. Die CI **OBW Editor POC** baut und prüft alle drei Plattformen. Die nativen Tests unterscheiden sich von einem späteren menschlichen GUI-Test auf Windows/macOS.
Pakete baut `tools/package/make_editor_package.py --build build-editor --out dist --platform linux-x64` (oder `windows-x64`, `macos-arm64`). `--source-package` ergänzt den zugehörigen Quellcode mit den tatsächlich verwendeten, gepinnten Abhängigkeiten. Die CI **OBW Editor** baut und prüft alle drei Plattformen. Tags `editor-v<version>` erzeugen nach erfolgreicher Prüfung einen Release-Entwurf. Die nativen Tests unterscheiden sich von einem späteren menschlichen GUI-Test auf Windows/macOS.
## English quick start
@@ -75,4 +75,4 @@ The editor retains full squads, original image data, source claims and unknown e
In **Options**, switch the interface to **English**, choose one of the three themes, and enable/disable the integrated local MCP server. **Copy connection** provides the authenticated configuration. The server defaults to loopback port 8765; use port 0 for a free port. GUI and MCP share the same world, validation and undo history. It supports MCP Streamable HTTP 2025-11-25/2025-06-18 and optional stdio mode. Use `expected_revision` for concurrent edits.
Build with the three commands above, including `-DOPENBMH_BUILD_EDITOR=ON`. The native application requires OpenGL 3.3 (macOS 4.1) and the platform development dependencies documented in the main README. The proof of concept is unsigned and does not bundle any real-world dataset or proprietary game assets.
Build with the three commands above, including `-DOPENBMH_BUILD_EDITOR=ON`. The native application requires OpenGL 3.3 (macOS 4.1) and the platform development dependencies documented in the main README. Editor 0.5.0 is unsigned and does not bundle any real-world dataset or proprietary game assets.
+29 -7
View File
@@ -1,10 +1,31 @@
# OBW: OpenBMH world, save and pack format (concept, format version 1.0)
# OBW: OpenBMH world, save and pack format
The standalone editor additionally implements the non-playable
[OBW 1.1 `editor-world-v1` profile](obw/editor-v1.md). This does not relax the
Classic 1.0 content contract or seals. See [the editor guide](../EDITOR.md).
## Implemented profiles
Status: **format concept with a complete Classic installation-content converter** for roadmap 0.2, with preparation for 0.4. `openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds under the guarded [`runtime:classic-v1` contract](obw/classic-v1.md), including all startup inputs and media. The [import guide](obw/import.md) distinguishes this from the explicitly partial `legacy-database-v1` development export. The 0.2 development branch adds a sealed Classic runtime, portable launcher and native career checkpoints; see [the runtime contract](obw/runtime-0.2.md). The released 0.1 engine still reads legacy installations.
| Profile | Format | Reader/writer | Playable |
|---|---|---|---|
| `classic-installation-v1` | OBW 1.0, `runtime:classic-v1` | Complete BMH/FLTD converter; OpenBMH 0.2 launcher, GUI and console | Yes, sealed Classic content |
| `editor-world-v1` | OBW 1.1, `editor:world-v1` | OpenBMH Editor 0.5: OBW/unpacked worlds and legacy import, OBW-only saving | No; editable start database |
| `legacy-database-v1` | OBW 1.0 development export | Converter's explicit `--database-only` option | No; partial legacy export |
`openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds including
startup inputs, media and frozen portrait recipes. The
[import guide](obw/import.md) distinguishes them from the partial development
export. OpenBMH 0.2 reads the sealed content without the original installation
and writes separate native career checkpoints; see the
[runtime contract](obw/runtime-0.2.md).
The [1.1 editor profile](obw/editor-v1.md) adds editable worlds without relaxing
Classic seals. Opening Classic content in the editor preserves its sources;
saving creates an editor world rather than a newly sealed Classic world.
Names such as “Modern” are display names, not proof of runtime compatibility.
A modern-season data package can be structurally valid and fully editable while
its competition/season engine is still pending. See [the editor guide](../EDITOR.md).
The sections below define the general format and distinguish implemented
profiles from future capabilities. Generic calendar/rule authoring, modern
season simulation, network play and generic world-to-career generation are
not implemented merely because their data structures are documented here.
## 1. Goals and non-goals
@@ -20,14 +41,15 @@ Goals:
Non-goals of version 1.0:
- The match engine and its parameters (reserved namespace `x-matchengine`, see §3.3).
- Network play, an editor application and a binary encoding (reserved, see §2.4).
- Network play and a binary encoding (reserved, see §2.4). The separate editor
uses the additive 1.1 profile described above.
- Layout or screen data. Interfaces are themes (§9.6), not part of a world.
## 2. Container and files
### 2.1 Container
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents and referenced binary assets. The versioned Classic extension additionally permits data-only compatibility regions and startup input records; it does not permit executable code or save state in a world. The project already links miniz (`bmh_miniz`) and has a JSON reader/writer (`src/cli/json.cpp`), so the format needs no new dependency. JSON keeps worlds diffable and editable by hand or by script.
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents and referenced binary assets. The 1.1 editor reader also supports ZIP64, with its own documented size limits. The versioned Classic extension additionally permits data-only compatibility regions and startup input records; it does not permit executable code or save state in a world. The readers use miniz for the container; the editor additionally uses its declared JSON/image dependencies. Generic editor JSON remains editable by hand or script; sealed Classic packages must retain their original bytes and seals.
| Extension | `kind` | Contents |
|---|---|---|
+3
View File
@@ -2,6 +2,8 @@
This additive profile is a native editing interchange. It does **not** change
`classic-installation-v1`, its seals, the Classic runtime or save files.
It is implemented by OpenBMH Editor 0.5.0, whose application version is separate
from the OBW format version and the OpenBMH 0.2.0 game version.
## Identification
@@ -22,6 +24,7 @@ This additive profile is a native editing interchange. It does **not** change
The required editor capability is deliberately different from
`runtime:classic-v1`. An edited world must not be resealed as a Classic world.
The display title and a label such as Modern do not grant a runtime capability.
On import the editor keeps the original manifest under
`x-editor.original_manifest`, leaves compatibility/source regions intact, and
requires Save As. An original Classic seal is historical evidence only in this
+2
View File
@@ -22,6 +22,8 @@ surfaces and petrol accents, and Matchday graphite surfaces and coral accents.
All components consume the inherited palette, including dropdown popups,
validation/error text, scrollbars, image stages and crop outlines. The comparison
uses the same German `World::demo()` view in each theme.
The three Clubs captures were refreshed for Editor 0.5.0. The remaining
captures document the preceding theme/image-editing checks with the same layout.
| Theme | Clubs | Options | Image editor |
|---|---|---|---|
Binary file not shown.

Before

Width:  |  Height:  |  Size: 134 KiB

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 179 KiB

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 157 KiB

After

Width:  |  Height:  |  Size: 157 KiB

+7
View File
@@ -56,6 +56,13 @@ The launcher requires OpenGL 3.3 (macOS: 4.1). Linux requires the platform libra
described in [BUILDING](../../BUILDING.md), including GTK3 for its folder picker.
The macOS executable is unsigned and is not a notarised application bundle.
Platform-specific human confirmation remains open for
[macOS filename entry](https://github.com/Weyoune/openbmh/issues/8),
[Windows path display](https://github.com/Weyoune/openbmh/issues/9) and
[Windows initial national-team selection](https://github.com/Weyoune/openbmh/issues/10).
Their fixes are included and covered by automated/Linux checks; an HQA label
does not claim that the original platform report has been verified on that OS.
No original executables, graphics, sound, databases or saved games are distributed.
Supply a supported CD/later German or Football Limited installation; the original
German floppy edition is unsupported. OpenBMH is GPL-3.0-only; bundled components
+42
View File
@@ -0,0 +1,42 @@
<!-- SPDX-License-Identifier: GPL-3.0-only -->
# OpenBMH Editor 0.5.0
The first standalone editor release uses SDL2, RmlUI and OpenGL on Windows x64,
Linux x64 and macOS ARM64. Its version is independent of OpenBMH 0.2.0.
## Opening and editing worlds
Open an OBW archive, an unpacked world, or import a supported Bundesliga Manager
Hattrick / Football Limited installation. Edit countries, competitions, clubs,
players, squads, stadiums, referees and indexed artwork. Save exclusively as
**OBW 1.1 `editor-world-v1`**. Legacy installations are not overwritten.
The interface offers German and English, Midnight Glass, Silver Glass and
Matchday themes, shared undo/redo, validation and source-conflict review. Image
import supports cropping, arbitrary rotation and mirroring while retaining the
original. Shared placeholders remain intact when an individual image is edited.
The integrated authenticated MCP server is enabled by default on loopback.
Configure its port and copy the connection in Options. GUI and MCP use the same
transactions and revision checks; credentials remain in the local profile.
## Compatibility and limits
- Existing sealed Classic BMH/FLTD worlds can be opened and saved as editable
worlds. Edited worlds cannot be played by the Classic 0.2 runtime and are
never resealed as unmodified Classic content.
- Complete source rosters, unknown extensions, image originals and source
evidence are preserved. Missing facts remain missing; unresolved source
conflicts remain visible. This release does not supply game data.
- Modern season simulation, complete rule/calendar authoring and saved-career
editing are outside this release. An editor-valid world does not establish
that a season engine can play it.
- The ZIP contains the executable, `assets/editor`, fonts and notices. Retain
them together. Windows includes its app-local runtime. Linux needs the
documented system libraries. macOS is unsigned and not notarised.
The release has matching platform archives and a corresponding source archive
with pinned dependencies. Build/core/MCP checks run on all three platforms;
native mouse/keyboard GUI checks run on Linux. Target-platform human acceptance
remains separate. See the [editor guide](../../EDITOR.md) and
[format contract](../../formats/obw/editor-v1.md).