Compare commits

..
35 Commits
Author SHA1 Message Date
Codex 50e476f6e1 Prepare OpenBMH 1.1 Beta 2 construction dialog fix release (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-31 22:39:57 +01:00
Codex 96cb05894f Keep stadium and periphery backdrops behind compact construction dialogs (by Codex) 2026-10-31 22:31:05 +01:00
Codex c051dd6ca6 Clamp cropped logo edges before rotation and palette conversion (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-31 15:30:31 +01:00
Codex 561d290643 Add palette-faithful club logo import, transformations and isolated crest cells (by Codex) 2026-10-31 15:29:11 +01:00
Codex db21653b75 Correct native Windows sizing types and polish editor controls (by Codex) 2026-10-31 14:54:19 +01:00
Codex dca853e14e Add native obdeddi data editing and refine Beta window, strengths and scene pacing (by Codex) 2026-10-31 14:40:41 +01:00
Codex 1771cb5599 Load standalone community data without DOS programs and match Original crest backgrounds (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-31 11:43:25 +01:00
Codex 3044b95b44 Reject shared computer crests and document reviewed replacement artwork (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-31 10:39:55 +01:00
Codex 7628a7454e Include profile-aware fixture declarations for all-time tables (by Codex) 2026-10-31 10:26:54 +01:00
Codex be8a8c43e5 Fix portable roster initialization and expanded country statistics (by Codex) 2026-10-31 10:25:34 +01:00
Codex b5d60ef8a7 Enable expanded international careers and private Classic-format preparation (by Codex) 2026-10-31 10:20:09 +01:00
Codex aae6556708 Separate runtime roster and domestic boundaries for the 1.1 profile (by Codex) 2026-10-31 09:59:10 +01:00
Codex ff05d4f28a Introduce explicit Classic and expanded 1.1 data profile dimensions (by Codex) 2026-10-31 09:48:45 +01:00
Codex b2a6300aad Separate widget close clicks from right-button desktop dragging (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-31 09:06:12 +01:00
Codex 12e3e52537 Use the SDL entry-point signature in the video lifetime test (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-30 23:33:15 +01:00
Codex 6d97b60ebc Initialize native Mac compiler rules before dependency configuration (by Codex) 2026-10-30 23:21:04 +01:00
Codex e3e2262e37 Keep native Mac keyboard regression on a supported ARM runner (by Codex) 2026-10-30 23:18:07 +01:00
Codex 184a421512 Fix automation preview, desktop drag highlight and macOS keyboard startup (by Codex) 2026-10-30 23:13:44 +01:00
Codex 998b037d3d Clarify stable release build and launch instructions [skip ci] (by Codex) 2026-10-30 18:31:57 +01:00
Codex d43d09a378 Read the original edition calendar for gameplay, desktop and saves (by Codex)
Prepare verified release / draft (push) Waiting to run
2026-10-30 18:02:52 +01:00
Codex f0ef79a119 Complete original edition rules, season safety and verified 1.0 releases (by Codex) 2026-10-30 17:14:28 +01:00
Codex e432f20ae7 Focus the community repository and documentation on the original game (by Codex) 2026-10-30 16:18:00 +01:00
Codex 6b942a2293 Retire ageing market players without age wrap or duplicate entries (by Codex) 2026-10-30 15:56:46 +01:00
Codex 3cce6465d0 Validate the Classic source export separately from retained Modern history (by Codex) 2026-10-30 15:50:36 +01:00
Codex 8ee062ea46 Prepare Classic 1.0 edition rules and Diamond 3.7 foreign crests (by Codex) 2026-10-30 15:39:56 +01:00
Codex c293a35f56 Backport original message installation for Classic standalone tools (by Codex) 2026-10-30 14:22:18 +01:00
Codex 81fc772a15 Preserve Classic reschedule targets after undo (by Codex) 2026-10-30 14:21:55 +01:00
Codex dcfb724ebe Confirm application exits in German and English (by Codex)
Route window-close events, animation polls, Escape and desktop exit through a native confirmation with Cancel selected by default. Preserve the current owner when cancelled. Refs #11.
2026-10-30 14:20:55 +01:00
Codex 17ac426039 Fix English desktop mapping and host file input issues (by Codex)
Correct setup sprites, balance colour and shortcut controls; restore native filename focus, normalize displayed directory separators and guard setup mouse releases. Refs #7, #8, #9, #10.
2026-10-30 14:20:55 +01:00
Codex c3704878d6 Restore direct-installation Classic baseline for OpenBMH 1.0 (by Codex) 2026-10-30 14:19:25 +01:00
ClaudeandClaude Opus 5.5 c8f04d0099 Reschedule undo clears the calendar replay bit (#16)
UndoReschedule of the original clears bit 0x4000 of the calendar day
(high byte & 0xbf) when no replay of another club stays on it; the
engine kept the bit, so the day and its neighbour were no longer offered
as targets after a move was taken back. The test checks the same target
days after the undo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 15:17:10 +01:00
ClaudeandClaude Opus 5.5 b879d5be00 Install the engine's message texts in standalone tools (fixes #14)
The six texts the engine posts from the game image (contract warning,
Masters, indoor entry bonus, league title bonus, friendly share) were
set only by the career sessions. week_check and the other standalone
tools left them empty, so the indoor entry bonus mail held only the
venue and the replays failed from the first public commit on.
install_message_texts(exe) now sets them for both sessions and in the
test executable loader.

Classic regression: the ten turns of #14 (game 1: 18, 21, 65, 88, 109,
201, 247; 2P: 24, 29, 34) pass again; no other turn changed against the
0.3 M0 baseline. The divergence the issue saw in the youth teams block
(bd4bc, since 310e3e2) is among the tolerated block differences.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 12:20:28 +02:00
Codex 6a3e51038c Correct large-window dropdown QA capture bounds (by Codex)
OBW Editor / editor (linux-x64, ubuntu-24.04) (push) Waiting to run
OBW Editor / editor (macos-arm64, macos-14) (push) Waiting to run
OBW Editor / editor (windows-x64, windows-2022) (push) Waiting to run
2026-10-23 14:51:41 +02:00
Codex 354baf2e6f Center editor dropdown chevrons and release 0.5.5 (by Codex) 2026-10-23 14:49:13 +02:00
Codex fe307dea41 Add editor browser navigation, idle rendering and Modern pickers (by Codex)
OBW Editor / editor (linux-x64, ubuntu-24.04) (push) Waiting to run
OBW Editor / editor (macos-arm64, macos-14) (push) Waiting to run
OBW Editor / editor (windows-x64, windows-2022) (push) Waiting to run
2026-10-23 13:48:32 +02:00
363 changed files with 3877 additions and 21118 deletions

No files matched your search

+34 -11
View File
@@ -3,7 +3,7 @@ name: Build without game data
on:
push:
branches: [main, assist/codex-0.2-launcher]
branches: [main, release/1.0, poc/1.1-international]
pull_request:
workflow_dispatch:
workflow_call:
@@ -21,7 +21,7 @@ jobs:
platform: linux-x64
- runner: windows-2022
platform: windows-x64
- runner: macos-14
- runner: macos-15
platform: macos-arm64
runs-on: ${{ matrix.runner }}
timeout-minutes: 90
@@ -36,8 +36,14 @@ jobs:
- name: Install Linux build dependencies
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y build-essential git cmake ninja-build pkg-config libgtk-3-dev libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxfixes-dev libxss-dev libasound2-dev libpulse-dev libgl1-mesa-dev libudev-dev
# Audit the selected tree shipped in source archives. Full repository
# history auditing is available separately with --history.
- name: Verify source export
run: python3 tools/public_release/check_public_tree.py --root . --history --revision HEAD
run: |
python3 tools/public_release/check_public_tree.py --root .
python3 tools/ci/test_build_runnable_tests.py
python3 tools/package/test_verify_ci_release.py
python3 -m unittest discover -s tools/poc -p "test_*.py"
- name: Set up MSVC x64
if: runner.os == 'Windows'
uses: ilammy/msvc-dev-cmd@a102174a2b586eec2ea151a69e6fd14404a8ce7c # v1.13.0
@@ -62,18 +68,35 @@ jobs:
run: |
test "$(uname -m)" = arm64
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0 -DBMH_DATA= -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
- name: Build every target
run: cmake --build build --config Release --parallel 2
- name: Build products and every runnable test
run: python3 tools/ci/build_runnable_tests.py --build build --config Release --parallel 2
- name: Run synthetic tests and report data tests as skipped
run: ctest --test-dir build -C Release --output-on-failure --output-junit test-results.xml
- name: Windows Server launcher with WARP software graphics
if: runner.os == 'Windows'
env:
SDL_VIDEODRIVER: windows
OPENBMH_RML_DRIVER: warp
run: build/launcher_gui_smoke.exe
- name: Verify product versions
shell: python
run: |
import pathlib, subprocess, sys
build = pathlib.Path('build').resolve()
version = (build / 'product-version.txt').read_text().strip()
suffix = '.exe' if sys.platform == 'win32' else ''
cli = subprocess.run([str(build / ('openbmh_cli' + suffix)), '--version'], check=True, capture_output=True, text=True)
assert cli.stdout.strip() == 'OpenBMH console ' + version
subprocess.run([str(build / ('OpenBMH' + suffix)), '--version'], check=True)
- name: Package products and licenses
run: python3 tools/package/make_package.py --build build --out dist --platform ${{ matrix.platform }}
- name: Package native Windows editor
if: runner.os == 'Windows'
shell: pwsh
run: |
$game = (Get-ChildItem dist/OpenBMH-*-windows-x64.zip | Select-Object -First 1).FullName
python3 tools/package/make_editor_package.py --build build --game $game --out editor-dist
- name: Upload native editor
if: runner.os == 'Windows'
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
with:
name: obdeddi-windows-x64
path: editor-dist/*.zip
if-no-files-found: error
- name: Package corresponding source and pinned dependencies
if: runner.os == 'Linux'
run: python3 tools/package/make_source_package.py --source . --build build --out source-dist
-127
View File
@@ -1,127 +0,0 @@
# SPDX-License-Identifier: GPL-3.0-only
name: OBW Editor
on:
push:
branches: [main, feat/obw-editor-poc]
tags: ['editor-v*']
workflow_dispatch:
permissions:
contents: read
concurrency:
group: obw-editor-${{ github.ref }}
cancel-in-progress: true
jobs:
editor:
strategy:
fail-fast: false
matrix:
include:
- runner: ubuntu-24.04
platform: linux-x64
- runner: windows-2022
platform: windows-x64
- runner: macos-14
platform: macos-arm64
runs-on: ${{ matrix.runner }}
timeout-minutes: 45
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
fetch-depth: 0
persist-credentials: false
- name: Check public sources
run: python3 tools/public_release/check_public_tree.py --root . --history --revision HEAD
- name: Existing package boundaries
if: runner.os == 'Linux'
run: python3 tests/package_tests.py
- name: Linux dependencies
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y ninja-build pkg-config libgtk-3-dev libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxfixes-dev libxss-dev libgl1-mesa-dev xvfb xauth xdotool
- name: MSVC x64
if: runner.os == 'Windows'
uses: ilammy/msvc-dev-cmd@a102174a2b586eec2ea151a69e6fd14404a8ce7c
with:
arch: x64
- name: Configure
shell: bash
run: |
args=()
if [[ "$RUNNER_OS" == "macOS" ]]; then args+=(-DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0); fi
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DOPENBMH_BUILD_EDITOR=ON -DBMH_DATA= "${args[@]}"
- name: Check portable Windows WebP instructions
if: runner.os == 'Windows'
shell: python
run: |
import json, pathlib, re
commands = json.loads(pathlib.Path('build/compile_commands.json').read_text())
simd = [c for c in commands if 'libwebp' in c['file'] and re.search(r'_sse(?:2|41)\.c$', c['file'])]
assert simd, 'No WebP runtime-dispatched SIMD sources found'
assert all(not re.search(r'/arch:AVX', c['command'], re.I) for c in simd), 'WebP SSE paths must run without AVX'
print('WebP SSE paths retain the Windows x64 baseline and runtime CPU detection')
- name: Build editor and synthetic tests
run: cmake --build build --target openbmh_editor launcher_gui_smoke editor_core_tests editor_comparison_tests editor_regulations_tests --parallel 2
- name: Native editor core and MCP tests
run: ctest --test-dir build -C Release -R "^editor_(core_tests|comparison_tests|regulations_tests|version)$" --output-on-failure --output-junit editor-tests.xml
- name: Linux native GUI smoke
if: runner.os == 'Linux'
run: |
xvfb-run -a -s '-screen 0 1600x1000x24' python3 tests/editor_gui_smoke.py build/OpenBMHEditor
xvfb-run -a -s '-screen 0 1600x1000x24' build/OpenBMHEditor --demo --page players --settings build/test-options.json --screenshot build/editor.png --quit-after-ms 1800
xvfb-run -a -s '-screen 0 1600x1000x24' python3 tests/editor_startup_smoke.py build/OpenBMHEditor --launcher build/launcher_gui_smoke
- name: Windows Server native GUI and WARP fallback
if: runner.os == 'Windows'
run: python3 tests/editor_startup_smoke.py build/OpenBMHEditor.exe --launcher build/launcher_gui_smoke.exe
- name: Package editor
shell: bash
run: |
args=()
if [[ "$RUNNER_OS" == "Linux" ]]; then args+=(--source-package); fi
python3 tools/package/make_editor_package.py --build build --out dist --platform ${{ matrix.platform }} "${args[@]}"
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
with:
name: OpenBMHEditor-${{ matrix.platform }}
path: dist/*.zip
if-no-files-found: error
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
if: always()
with:
name: editor-checks-${{ matrix.platform }}
path: |
build/editor-tests.xml
build/editor.png
release:
if: startsWith(github.ref, 'refs/tags/editor-v')
needs: editor
runs-on: ubuntu-24.04
permissions:
contents: write
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
persist-credentials: false
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093
with:
pattern: OpenBMHEditor-*
path: dist
merge-multiple: true
- name: Prepare editor release for review
shell: python
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ github.ref_name }}
run: |
import os, pathlib, re, subprocess
tag = os.environ['RELEASE_TAG']
match = re.fullmatch(r'editor-v([0-9]+)\.([0-9]+)\.[0-9]+', tag)
if not match:
raise SystemExit('Invalid editor release tag')
version = tag.removeprefix('editor-v')
notes = pathlib.Path('docs/release') / ('editor-' + match[1] + '.' + match[2]) / 'RELEASE_NOTES.md'
packages = sorted(pathlib.Path('dist').glob('*.zip'))
expected = {'OpenBMHEditor-' + version + '-' + kind + '.zip'
for kind in ('windows-x64', 'linux-x64', 'macos-arm64', 'source')}
if {p.name for p in packages} != expected or not notes.is_file():
raise SystemExit('Missing or mismatched editor release files')
subprocess.run(['gh', 'release', 'create', tag, *map(str, packages), '--draft',
'--verify-tag', '--title', 'OpenBMH Editor ' + version,
'--notes-file', str(notes)], check=True)
+36 -20
View File
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: GPL-3.0-only
name: Prepare release packages
name: Prepare verified release
on:
push:
@@ -7,43 +7,59 @@ on:
permissions:
contents: read
actions: read
jobs:
build:
uses: ./.github/workflows/ci.yml
draft:
needs: build
runs-on: ubuntu-24.04
permissions:
contents: write
actions: read
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
fetch-depth: 0
- name: Locate successful CI for this exact revision
id: ci
env:
GH_TOKEN: ${{ github.token }}
EXPECTED_SHA: ${{ github.sha }}
run: |
gh api "repos/$GITHUB_REPOSITORY/actions/workflows/ci.yml/runs?status=success&event=push&per_page=100" > ci-runs.json
python3 - <<'PY'
import json, os
runs = json.load(open('ci-runs.json'))['workflow_runs']
matches = [r for r in runs if r['head_sha'] == os.environ['EXPECTED_SHA'] and
r['conclusion'] == 'success' and r['event'] == 'push' and
r['head_repository']['full_name'].lower() == os.environ['GITHUB_REPOSITORY'].lower()]
if not matches:
raise SystemExit('Run the full CI successfully for this revision before tagging a release')
with open(os.environ['GITHUB_OUTPUT'], 'a') as output:
output.write('run_id=' + str(matches[0]['id']) + '\n')
PY
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
github-token: ${{ github.token }}
run-id: ${{ steps.ci.outputs.run_id }}
pattern: OpenBMH-*
path: dist
merge-multiple: true
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
github-token: ${{ github.token }}
run-id: ${{ steps.ci.outputs.run_id }}
pattern: tests-*
path: test-reports
- name: Verify archives, corresponding source and platform reports
env:
RELEASE_TAG: ${{ github.ref_name }}
CI_RUN: ${{ steps.ci.outputs.run_id }}
run: |
python3 tools/package/verify_ci_release.py --dist dist --reports test-reports --tag "$RELEASE_TAG" --source-sha "$GITHUB_SHA" --ci-run "$CI_RUN" --repository "$GITHUB_REPOSITORY"
- name: Create draft for review
shell: python
env:
GH_TOKEN: ${{ github.token }}
RELEASE_TAG: ${{ github.ref_name }}
run: |
import os, pathlib, re, subprocess
tag = os.environ['RELEASE_TAG']
match = re.fullmatch(r'v([0-9]+)\.([0-9]+)\.[0-9]+(?:[-+][A-Za-z0-9.-]+)?', tag)
if not match:
raise SystemExit('Invalid release tag')
notes = pathlib.Path('docs/release') / (match[1] + '.' + match[2]) / 'RELEASE_NOTES.md'
packages = sorted(pathlib.Path('dist').glob('*.zip'))
expected = {'OpenBMH-' + tag[1:] + '-' + kind + '.zip'
for kind in ('windows-x64', 'linux-x64', 'macos-arm64', 'source')}
if {p.name for p in packages} != expected:
raise SystemExit('Missing, unexpected or mismatched release package')
if not notes.is_file():
raise SystemExit('Release notes missing for ' + tag)
subprocess.run(['gh', 'release', 'create', tag, *map(str, packages), '--draft',
'--verify-tag', '--title', 'OpenBMH ' + tag, '--notes-file', str(notes)], check=True)
gh release create "$RELEASE_TAG" dist/*.zip dist/SHA256SUMS dist/QA-REPORT.json --draft --verify-tag --title "OpenBMH $RELEASE_TAG" --notes-file docs/release/1.0/RELEASE_NOTES.md
+95 -32
View File
@@ -1,13 +1,19 @@
# SPDX-License-Identifier: GPL-3.0-only
cmake_minimum_required(VERSION 3.24)
project(OpenBMH VERSION 0.2.1 LANGUAGES CXX C)
project(OpenBMH VERSION 1.1.0 LANGUAGES CXX C)
if(APPLE)
# Enable native languages before dependencies/subdirectories inherit rules.
enable_language(OBJC OBJCXX)
set(CMAKE_OBJCXX_STANDARD 20)
set(CMAKE_OBJCXX_STANDARD_REQUIRED ON)
endif()
set(OPENBMH_PRERELEASE "beta.2" CACHE STRING "Prerelease identifier; empty for final release")
set(OPENBMH_PRODUCT_VERSION "${PROJECT_VERSION}")
if(OPENBMH_PRERELEASE)
string(APPEND OPENBMH_PRODUCT_VERSION "-${OPENBMH_PRERELEASE}")
endif()
file(GENERATE OUTPUT "${CMAKE_BINARY_DIR}/product-version.txt" CONTENT "${OPENBMH_PRODUCT_VERSION}\n")
# the one place of the version: --version of both programs and the window title (src/version.hpp)
add_compile_definitions(OPENBMH_VERSION="${PROJECT_VERSION}")
file(GENERATE OUTPUT "${CMAKE_BINARY_DIR}/generated/openbmh_build_version.hpp"
CONTENT "// SPDX-License-Identifier: GPL-3.0-only\n#pragma once\n#define OPENBMH_VERSION \"${OPENBMH_PRODUCT_VERSION}\"\n")
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -201,23 +207,21 @@ bmh_add_data_test(NAME highscore_tests REQUIRED_OPTIONS BMH_TEST_HIGHSCORE_TESTS
# Engine core: file formats and game logic, no platform dependencies
add_library(bmhcore STATIC
src/formats/binary.cpp
src/formats/content.cpp
src/formats/native_state.cpp
src/formats/native_file.cpp
src/cli/json.cpp
src/formats/resource_bundle.cpp
src/formats/palette.cpp
src/formats/vga.cpp
src/formats/font.cpp
src/formats/textd.cpp
src/formats/fbm.cpp
src/formats/le.cpp
src/formats/rule_base.cpp
src/formats/data_profile.cpp
src/formats/m3d.cpp
src/formats/savestate.cpp
src/game/schedule.cpp
src/game/league_pairings.cpp
src/game/source_tip.cpp
src/game/table_forecast.cpp
src/game/profile_runtime.cpp
src/game/state.cpp
src/game/rating.cpp
src/game/match.cpp
@@ -248,6 +252,7 @@ add_library(bmhcore STATIC
src/game/weekly.cpp
src/game/messages.cpp
src/game/table.cpp
src/game/calendar.cpp
src/game/week.cpp
src/game/lineup.cpp
src/game/national.cpp
@@ -273,10 +278,10 @@ else()
target_compile_options(bmhcore PRIVATE -Wall -Wextra)
endif()
add_executable(openbmh_inspect src/main.cpp)
target_link_libraries(openbmh_inspect PRIVATE bmhcore ${BMH_SDL_TARGET})
add_executable(openbmh src/main.cpp)
target_link_libraries(openbmh PRIVATE bmhcore ${BMH_SDL_TARGET})
if(MSVC)
target_compile_options(openbmh_inspect PRIVATE /utf-8)
target_compile_options(openbmh PRIVATE /utf-8)
endif()
# --- Game data launcher (src/launch): find, unpack and check the original game data ---------
@@ -301,6 +306,7 @@ FetchContent_MakeAvailable(miniz lzma_sdk nfd)
add_library(bmh_miniz STATIC ${miniz_SOURCE_DIR}/miniz.c)
target_include_directories(bmh_miniz PUBLIC ${miniz_SOURCE_DIR})
target_link_libraries(bmhcore PRIVATE bmh_miniz)
set(BMH_LZMA_C ${lzma_sdk_SOURCE_DIR}/C)
add_library(bmh_7z STATIC
${BMH_LZMA_C}/7zAlloc.c ${BMH_LZMA_C}/7zArcIn.c ${BMH_LZMA_C}/7zBuf.c ${BMH_LZMA_C}/7zCrc.c
@@ -325,12 +331,6 @@ if(MSVC)
endif()
add_subdirectory(src/ui)
add_subdirectory(src/import)
option(OPENBMH_BUILD_EDITOR "Build the standalone OBW editor" OFF)
if(OPENBMH_BUILD_EDITOR)
add_subdirectory(src/editor)
endif()
target_link_libraries(bmhui PUBLIC bmh_content)
add_executable(driver_barrier_tests tests/driver_barrier_tests.cpp)
target_link_libraries(driver_barrier_tests PRIVATE bmhcore)
add_test(NAME driver_barrier_tests COMMAND driver_barrier_tests)
@@ -453,15 +453,11 @@ add_executable(openbmh_play
src/app/main.cpp
${BMH_APP_CONTROLLER_SOURCE}
${BMH_APP_SESSION_SDL_SOURCE})
target_link_libraries(openbmh_play PRIVATE bmhui bmh_launcher bmhlaunch_dialog openbmh_audio ${BMH_SDL_TARGET})
target_link_libraries(openbmh_play PRIVATE bmhui bmhlaunch_dialog openbmh_audio ${BMH_SDL_TARGET})
# a game without a console window on double-click (SDL2main provides WinMain); started from a
# console it attaches to that one for --version, --help and start errors (src/app/main.cpp)
set_target_properties(openbmh_play PROPERTIES WIN32_EXECUTABLE TRUE OUTPUT_NAME OpenBMH)
if(CMAKE_CONFIGURATION_TYPES)
add_custom_command(TARGET openbmh_play POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_BINARY_DIR}/assets/launcher"
"$<TARGET_FILE_DIR:openbmh_play>/assets/launcher")
endif()
target_include_directories(openbmh_play PRIVATE "${CMAKE_BINARY_DIR}/generated")
if(MSVC)
target_compile_options(openbmh_play PRIVATE /utf-8)
# App sources also compile in headless tests/helpers without target /utf-8.
@@ -641,7 +637,8 @@ add_executable(openbmh_cli
src/cli/seat_hub.cpp
src/cli/json.cpp
${BMH_APP_SESSION_SOURCE})
target_link_libraries(openbmh_cli PRIVATE bmh_launcher bmhui bmhlaunch)
target_include_directories(openbmh_cli PRIVATE "${CMAKE_BINARY_DIR}/generated")
target_link_libraries(openbmh_cli PRIVATE bmhui bmhlaunch)
if(WIN32)
target_link_libraries(openbmh_cli PRIVATE ws2_32) # --listen (Winsock)
endif()
@@ -1068,15 +1065,12 @@ bmh_add_data_test(NAME sportschau_app_tests REQUIRED_OPTIONS BMH_TEST_SPORTSCHAU
install(TARGETS openbmh_play openbmh_cli RUNTIME DESTINATION . COMPONENT Runtime)
install(FILES README.md LICENSE THIRD_PARTY_NOTICES.md ACKNOWLEDGEMENTS.md CONTRIBUTING.md
DESTINATION . COMPONENT Runtime)
install(DIRECTORY docs/ DESTINATION docs COMPONENT Runtime PATTERN "qa" EXCLUDE)
install(DIRECTORY docs/ DESTINATION docs COMPONENT Runtime)
if(MSVC)
set(CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION .)
set(CMAKE_INSTALL_SYSTEM_RUNTIME_COMPONENT Runtime)
set(CMAKE_INSTALL_UCRT_LIBRARIES TRUE)
include(InstallRequiredSystemLibraries)
if(OPENBMH_BUILD_EDITOR)
install(PROGRAMS ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} DESTINATION . COMPONENT Editor)
endif()
endif()
add_executable(tax_animation_unit_tests tests/tax_animation_unit_tests.cpp)
@@ -1119,10 +1113,8 @@ bmh_add_data_test(NAME english_fixture_table_data_tests DATA_DIR "${BMH_ENGLISH_
COMMAND fixture_table_tests "${BMH_ENGLISH_DATA}")
# Private build paths are inputs to the source-package tool, never shipped in its manifest.
FetchContent_GetProperties(rmlui)
FetchContent_GetProperties(freetype)
set(package_dependencies "{}")
foreach(dependency IN ITEMS SDL2 miniz lzma_sdk nfd rmlui freetype)
foreach(dependency IN ITEMS SDL2 miniz lzma_sdk nfd)
string(REPLACE "\\" "/" dependency_path "${${dependency}_SOURCE_DIR}")
if(dependency STREQUAL "SDL2" AND sdl2_SOURCE_DIR)
set(dependency_path "${sdl2_SOURCE_DIR}")
@@ -1131,3 +1123,74 @@ foreach(dependency IN ITEMS SDL2 miniz lzma_sdk nfd rmlui freetype)
string(JSON package_dependencies SET "${package_dependencies}" "${dependency}" "\"${dependency_path}\"")
endforeach()
file(GENERATE OUTPUT "${CMAKE_BINARY_DIR}/package-dependencies.json" CONTENT "${package_dependencies}\n")
add_executable(classic_rules_unit_tests tests/classic_rules_unit_tests.cpp)
target_link_libraries(classic_rules_unit_tests PRIVATE bmhcore)
add_test(NAME classic_rules_unit_tests COMMAND classic_rules_unit_tests)
add_executable(season_player_reset_tests tests/season_player_reset_tests.cpp)
target_link_libraries(season_player_reset_tests PRIVATE bmhcore)
add_test(NAME season_player_reset_tests COMMAND season_player_reset_tests)
set_tests_properties(season_player_reset_tests PROPERTIES TIMEOUT 10)
add_executable(lineup_foreign_limit_tests tests/lineup_foreign_limit_tests.cpp)
target_link_libraries(lineup_foreign_limit_tests PRIVATE bmhcore)
add_test(NAME lineup_foreign_limit_tests COMMAND lineup_foreign_limit_tests)
add_executable(calendar_epoch_tests tests/calendar_epoch_tests.cpp)
target_link_libraries(calendar_epoch_tests PRIVATE bmhui)
add_test(NAME calendar_epoch_tests COMMAND calendar_epoch_tests)
add_executable(video_session_tests tests/video_session_tests.cpp)
target_include_directories(video_session_tests PRIVATE src)
target_link_libraries(video_session_tests PRIVATE ${BMH_SDL_TARGET})
add_test(NAME video_session_tests COMMAND video_session_tests)
if(APPLE)
add_executable(mac_video_picker_tests tests/mac_video_picker_tests.mm)
set_target_properties(mac_video_picker_tests PROPERTIES OBJCXX_STANDARD 20 OBJCXX_STANDARD_REQUIRED YES)
target_include_directories(mac_video_picker_tests PRIVATE src)
target_link_libraries(mac_video_picker_tests PRIVATE ${BMH_SDL_TARGET} nfd::nfd "-framework Cocoa")
add_test(NAME mac_video_picker_tests COMMAND mac_video_picker_tests)
endif()
add_executable(desktop_feedback_tests tests/desktop_feedback_tests.cpp)
target_link_libraries(desktop_feedback_tests PRIVATE bmhui)
bmh_add_data_test(NAME desktop_feedback_tests COMMAND desktop_feedback_tests "${BMH_DATA}")
add_executable(data_profile_tests tests/data_profile_tests.cpp)
target_link_libraries(data_profile_tests PRIVATE bmhcore)
add_test(NAME data_profile_tests COMMAND data_profile_tests)
# Offline private package preparation; never installs Original data.
add_executable(export_community_runtime tools/poc/export_runtime.cpp)
target_link_libraries(export_community_runtime PRIVATE bmhcore)
add_executable(resource_bundle_tests tests/resource_bundle_tests.cpp)
target_link_libraries(resource_bundle_tests PRIVATE bmhcore bmh_miniz)
add_test(NAME resource_bundle_tests COMMAND resource_bundle_tests)
# Small native OBD editor. Its model is tested on every platform; UI is Win32 only.
add_library(obdeddi_hash STATIC ${BMH_LZMA_C}/Sha256.c ${BMH_LZMA_C}/Sha256Opt.c)
target_include_directories(obdeddi_hash PUBLIC ${BMH_LZMA_C})
target_link_libraries(obdeddi_hash PRIVATE bmh_7z)
add_library(obdeddi_model STATIC src/obdeddi/document.cpp src/cli/json.cpp)
target_include_directories(obdeddi_model PUBLIC src)
target_link_libraries(obdeddi_model PUBLIC bmhcore PRIVATE bmh_miniz obdeddi_hash)
if(WIN32)
add_executable(obdeddi WIN32 src/obdeddi/main_win32.cpp src/obdeddi/logo_win32.cpp src/obdeddi/logo_transform_win32.cpp)
target_link_libraries(obdeddi PRIVATE obdeddi_model comctl32 comdlg32 user32 gdi32 shell32 gdiplus)
if(MSVC)
target_compile_options(obdeddi PRIVATE /utf-8)
target_compile_options(obdeddi_model PRIVATE /utf-8)
endif()
install(TARGETS obdeddi RUNTIME DESTINATION . COMPONENT Editor)
endif()
add_executable(obdeddi_tests tests/obdeddi_tests.cpp)
target_link_libraries(obdeddi_tests PRIVATE obdeddi_model bmh_miniz)
add_test(NAME obdeddi_tests COMMAND obdeddi_tests)
if(WIN32)
add_executable(obdeddi_logo_tests tests/obdeddi_logo_tests.cpp src/obdeddi/logo_transform_win32.cpp)
target_include_directories(obdeddi_logo_tests PRIVATE src)
target_link_libraries(obdeddi_logo_tests PRIVATE gdiplus)
add_test(NAME obdeddi_logo_tests COMMAND obdeddi_logo_tests)
endif()
+17 -30
View File
@@ -1,15 +1,10 @@
# OpenBMH
The separate [OpenBMH Editor 0.5.3](docs/EDITOR.md) uses native RmlUI,
supports German/English, three themes, image editing and a local MCP server.
Download its own `editor-v0.5.3` release or build with
`-DOPENBMH_BUILD_EDITOR=ON`. Edited worlds are independent of the Classic runtime.
This is the **1.1 community development branch**. A prepared community package starts directly from `COMMUNITY.OBD`, without BMH.exe or a DOS installation. Original loose Classic installations remain supported. The stable 1.0 line stays on main. See [standalone community data](docs/poc-1.1/STANDALONE.md).
A modern and faithful open source rebuild of the *Bundesliga Manager Hattrick* engine.
A faithful, standalone community reconstruction of *Bundesliga Manager Hattrick*, using the player's original installation and SDL2 interface.
OpenBMH is a standalone C++20 engine with an SDL2 interface for *Bundesliga Manager Hattrick* (1994/95) and its English edition, *Football Limited*. The project develops a playable reconstruction alongside a platform for new rules, content and interfaces. Keeping the familiar game enjoyable and making it easier to extend are equally important goals.
Version 0.2 imports a game installation supplied by the player into a portable Classic mod. The running game reads the converted OBW content. Game data, artwork, music, manuals and the original executable are not distributed with OpenBMH. Its aim is recognisable behaviour and plausible results; documented compatibility decisions and safety fixes take precedence over reproducing every original fault.
OpenBMH 1.0 builds on v0.1.2 with reviewed bug fixes and starts directly with the original game data. Original game files, graphics, audio and manuals are not distributed. German CD-compatible BMH and verified Diamond editions are the primary release targets. Football Limited remains experimental; the older floppy executable is not supported.
This is an independent community project, with no affiliation with or endorsement by the original rights holders, the DFL or the Bundesliga. It is an engine implementation, not an official source release or a remaster.
@@ -17,38 +12,30 @@ This is an independent community project, with no affiliation with or endorsemen
Check the [releases page](https://github.com/Weyoune/openbmh/releases) for available packages and their platform notes. A Windows package uses the name `OpenBMH-<version>-windows-x64.zip`. Availability and native validation are stated for each release; source build instructions do not establish platform support on their own.
These instructions describe **0.2.1**, released separately from the editor. See the [0.2 release notes](docs/release/0.2/RELEASE_NOTES.md).
1. Have your own supported game installation available.
2. Extract the OpenBMH package into a separate directory, or alongside the game files.
3. Start `OpenBMH` (`OpenBMH.exe` on Windows). Select the game directory or executable when prompted. A ZIP or 7z containing one game installation can also be selected.
1. Extract OpenBMH into a writable directory.
2. Start `OpenBMH.exe` on Windows, or `OpenBMH` on Linux/macOS. Its RmlUI launcher initially has an empty **Name | Art** list. The night-stadium design uses a small version label in the lower-right corner.
3. Choose **Add**, select your own BMH or Football Limited installation, and enter a unique mod name and starting display year. The default names are `BMH-classic` and `FTDL-classic` (the English format identifier is `FLTD-classic`).
4. Optionally transfer saved games and settings from the installation or another folder. The import reports files it could not migrate.
5. Select the resulting Classic mod and choose **Start**. After import, its original installation is no longer needed for play.
Converted contents live in `mods/<name>/content.obw` next to the program. Saves (`.obs`), settings (`.obsettings`), desktop layouts (`.oblayout`) and high scores (`.obscore`) live separately in `userdata/<content-id>/`. **Delete** asks before removing a mod and retains personal data; importing identical contents reconnects them. **Rename** renames the mod directory. Externally modified Classic packages are rejected; import the installation again to repair them. Keep backups of the portable directory.
For direct startup or the console:
From a terminal in the extracted package on Linux or macOS:
```sh
./OpenBMH --mod "mods/BMH-classic/content.obw"
./openbmh_cli --console --mod "mods/BMH-classic/content.obw"
./OpenBMH --data "path/to/game" --save-directory "path/to/saves"
./openbmh_cli --console --data "path/to/game" --saves "path/to/saves"
```
Both frontends use native content and saves. Use **Add** to migrate older files rather than passing an original executable or `.FBM` to the running game. The starting year changes the Classic year display; original weekday and scheduling rules are preserved. Modern worlds are reserved for a later version.
In Windows PowerShell, use `.\OpenBMH.exe` and `.\openbmh_cli.exe` instead.
The launcher uses SDL2 and RmlUI, with Direct3D 11 and automatic WARP software fallback on Windows, OpenGL 3.3 on Linux and OpenGL 4.1 on macOS; keep its `assets` directory next to the executable. Folder selection uses the operating system's dialog. See the [0.2 migration contract](docs/formats/obw/runtime-0.2.md) for compatibility and validation limits. Platform builds and automated tests are separate from human interactive acceptance on Windows and macOS.
Use a writable save directory and keep backups of existing games. German editions are the primary compatibility target. **Football Limited / English data support is experimental**; original V2.20 save import and some edition-specific behaviour remain limited. See the [release notes](docs/release/1.0/RELEASE_NOTES.md).
## Features and direction
The graphical client and console share career management, matches, transfers, contracts, finances, training, stadium management and save handling. The console supports command batches, structured views and multiple manager clients. Audio is decoded from the user's installation where supported.
Version 0.1 establishes the playable engine and development interfaces. Later milestones introduce an open data format and typed model, configurable rules, a scalable interface and independently distributable content. These are goals rather than delivery dates; the [roadmap](docs/ROADMAP.md) describes their dependencies.
The standalone [`openbmh_import` tool](docs/formats/obw/import.md) produces the same complete Classic content packages, including media and frozen player portrait recipes. A mod directory contains its sealed `content.obw`; legacy save migration is performed through the launcher.
OpenBMH focuses on original-game compatibility, stability and community contributions. See the [contribution guide](CONTRIBUTING.md) and [maintenance roadmap](docs/ROADMAP.md).
## Build from source
The following recipes target version 0.2. They require Git, CMake 3.24 or newer and a C++20 compiler. The first configure fetches pinned open-source dependencies. Native build and package results are documented for each release; these instructions do not claim an untested platform result.
The following recipes build OpenBMH 1.0. They require Git, CMake 3.24 or newer and a C++20 compiler. The first configure fetches pinned open-source dependencies. Native build and package results are documented for each release; these instructions do not claim an untested platform result.
Clone the public repository, then run the commands for your system:
@@ -65,7 +52,7 @@ Install Visual Studio 2022 or its Build Tools with **Desktop development with C+
cmake -S . -B build-windows -G "Visual Studio 17 2022" -A x64
cmake --build build-windows --config Release
ctest --test-dir build-windows -C Release --output-on-failure
.\build-windows\Release\OpenBMH.exe
.\build-windows\Release\OpenBMH.exe --data "path/to/game" --save-directory "path/to/saves"
```
### Linux
@@ -77,7 +64,7 @@ sudo apt install build-essential git cmake ninja-build pkg-config libgtk-3-dev l
cmake -S . -B build-linux -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build-linux
ctest --test-dir build-linux --output-on-failure
./build-linux/OpenBMH
./build-linux/OpenBMH --data "path/to/game" --save-directory "path/to/saves"
```
Use a newer CMake if your distribution ships a version older than 3.24. A Linux binary can still require system libraries such as GTK3; a ZIP is not a guarantee of portability across distributions.
@@ -92,7 +79,7 @@ brew install cmake ninja
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
./build-macos/OpenBMH
./build-macos/OpenBMH --data "path/to/game" --save-directory "path/to/saves"
```
On Intel Macs omit the arm64 setting or select `x86_64`. These commands build terminal executables; they do not create a signed application bundle.
@@ -118,6 +105,6 @@ The implementation grew from study of file formats and behaviour of a legally ob
OpenBMH's own code and documentation are licensed under **GNU GPL version 3 only**, SPDX **GPL-3.0-only**. [LICENSE](LICENSE) contains the unchanged GPLv3 text; the example wording in its appendix does not change this project's version choice. Game content has separate ownership and is not covered by this license.
Release source is identified by the matching version tag: [v0.1.2](https://github.com/Weyoune/openbmh/tree/v0.1.2) for the published 0.1.2 version. This branch develops 0.2; it is not a published release. Binary releases must accompany or offer the corresponding source and build/relinking materials required by the applicable licenses. The tag identifies application source; it does not replace required materials for linked third-party components.
Every published binary release identifies its matching source tag and provides a corresponding source archive. Binary releases must accompany or offer the corresponding source and build/relinking materials required by the applicable licenses. The tag identifies application source; it does not replace required materials for linked third-party components.
Bundled components retain their own licenses, including Nuked OPL3 under LGPL-2.1-or-later. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) and [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md).
+1 -13
View File
@@ -10,21 +10,9 @@ OpenBMH's own code and documentation use GPL-3.0-only. This does not replace the
| [miniz](https://github.com/richgel999/miniz/releases/tag/3.0.2) | 3.0.2 amalgamation | MIT; embedded public-domain notices remain in its source | [miniz.txt](docs/licenses/miniz.txt), [source notices](docs/licenses/miniz-source-notices.txt) |
| [LZMA SDK decoder files](https://github.com/ip7z/7zip/tree/24.09/C) | Selected C files from 7-Zip 24.09 | Public domain, as marked in the selected files | [LZMA-SDK.txt](docs/licenses/LZMA-SDK.txt) |
| [nativefiledialog-extended](https://github.com/btzy/nativefiledialog-extended/tree/v1.2.1) | 1.2.1 | zlib license | [nativefiledialog-extended.txt](docs/licenses/nativefiledialog-extended.txt) |
| [RmlUi](https://github.com/mikke89/RmlUi/tree/6.3) | 6.3, Core and SDL2/OpenGL backend | MIT | [RmlUi.txt](docs/licenses/RmlUi.txt), [containers](docs/licenses/RmlUi-containers.txt), [Khronos notice](docs/licenses/RmlUi-Khronos.txt) |
| [FreeType](https://github.com/freetype/freetype/tree/VER-2-13-3) | 2.13.3 | FreeType License (FTL) | [license choices](docs/licenses/FreeType.txt), [FTL](docs/licenses/FreeType-FTL.txt), [BDF](docs/licenses/FreeType-BDF.txt), [PCF](docs/licenses/FreeType-PCF.txt), [internal gzip/zlib](docs/licenses/FreeType-zlib.txt) |
| LatoLatin Regular and Bold | Unmodified fonts included with RmlUi 6.3 | SIL Open Font License 1.1 | [font notices](docs/licenses/RmlUi-fonts.txt) |
| nlohmann/json (optional editor) | 3.12.0 | MIT | [notice](docs/licenses/nlohmann-json.txt) |
| cpp-httplib (optional editor) | 0.63.0, local HTTP without TLS | MIT | [notice](docs/licenses/cpp-httplib.txt) |
| SDL2_image (optional editor) | 2.8.8, selected static codecs | zlib | [notice](docs/licenses/SDL2_image.txt) |
| stb_image (SDL2_image PNG/JPEG decoder) | Version supplied by SDL2_image 2.8.8 | MIT option | [verbatim alternatives](docs/licenses/stb-image.txt) |
| libwebp (optional editor) | SDL2_image's pinned `1.0.3-SDL` fork, commit `05b15cb8`, including upstream backported fixes | BSD-3-Clause and patent grant | [license](docs/licenses/libwebp.txt), [patents](docs/licenses/libwebp-PATENTS.txt) |
| LunaSVG / bundled PlutoVG (optional editor) | LunaSVG 3.5.0 and its tracked PlutoVG sources | MIT | [LunaSVG](docs/licenses/LunaSVG.txt), [PlutoVG](docs/licenses/PlutoVG.txt) |
| pugixml (optional editor) | 1.15 | MIT | [notice](docs/licenses/pugixml.txt) |
| [Nuked OPL3](https://github.com/nukeykt/Nuked-OPL3/tree/765ec962e473aeb767e4cba74ffdc8f588ffbfe8) | Commit `765ec962e473aeb767e4cba74ffdc8f588ffbfe8` | LGPL-2.1-or-later | [LGPL-2.1.txt](docs/licenses/LGPL-2.1.txt), [copyright and source notice](docs/licenses/Nuked-OPL3-notices.txt) |
The miniz implementation provides a zlib-compatible API; it is not the zlib library. FreeType's internal gzip module includes its bundled zlib code; an external zlib library is not linked by the pinned build. SDL2 and nativefiledialog-extended use the **zlib license**, which is distinct from using zlib code. A system-library build or distributor's package can have additional runtime dependencies; its notices must match the libraries actually included.
Portions of this software are copyright © the FreeType Project (www.freetype.org). All rights reserved. The pinned build uses the FreeType License option, with the included module notices retained. RmlUi and FreeType are linked statically; their corresponding pinned source is included in the source package.
The miniz implementation provides a zlib-compatible API; it is not the zlib library. OpenBMH does not directly link a separate zlib dependency. SDL2 and nativefiledialog-extended use the **zlib license**, which is distinct from using zlib code. A system-library build or distributor's package can have additional runtime dependencies; its notices must match the libraries actually included.
Only the public-domain C decoding subset is taken from the 7-Zip source package. This statement does not describe all of 7-Zip: other parts of that upstream project have different licenses and are not included here.
-14
View File
@@ -1,14 +0,0 @@
<!-- SPDX-License-Identifier: GPL-3.0-only -->
<rml>
<head><title>OpenBMH Editor</title><link type="text/rcss" href="theme.rcss"/></head>
<body id="app" class="midnight">
<div id="shell">
<header><div class="brand"><div class="brand-mark">O<span>B</span></div><div><h2>OpenBMH <span>Editor</span></h2><small id="tagline"></small></div></div><div id="world-caption"></div><div id="top-actions"></div></header>
<div id="main"><aside><div class="eyebrow" id="nav-label"></div><div id="navigation"></div><div class="aside-foot"><div class="small-pitch"><div></div></div><span>OBW 1.1</span><small id="profile-note"></small></div></aside>
<section id="workspace"><div id="page-heading"><div><div class="eyebrow" id="page-kicker"></div><h1 id="page-title"></h1><p id="page-subtitle"></p></div><div id="page-actions"></div></div>
<div id="toolbar"></div><div id="page-content"></div><div id="pagination"></div></section>
</div>
<footer><div id="state"></div><div id="status-message"></div><div id="bottom-actions"></div></footer>
</div>
<div id="overlay"><div id="modal"><div class="modal-head"><h2 id="modal-title"></h2><button data-action="cancel-modal" class="close">×</button></div><div id="modal-content"></div><div id="modal-error"></div><div id="modal-buttons"></div></div></div>
</body></rml>
-288
View File
@@ -1,288 +0,0 @@
/* SPDX-License-Identifier: GPL-3.0-only */
/* The submenu palettes are shared by every surface and control. RmlUI 6.3
resolves these inherited custom properties when the body class changes. */
body {
--text: #dce3e9;
--muted: #a8b8c8;
--accent: #a9dccb;
--window-top: #303c49;
--window-bottom: #1a2531;
--chrome: #d5e3ed0a;
--sidebar: #111a2426;
--panel: #111a2433;
--wash: #e3edf605;
--control-top: #c1d1e31c;
--control-bottom: #869eb312;
--input: #17232e99;
--popup: #293744;
--hover: #d0e2f226;
--selected: #a9d4c526;
--selected-hover: #a9d4c53d;
--selected-text: #e8f5ef;
--border: #e2ebf02b;
--divider: #d4e1eb12;
--accent-border: #a9d4c55c;
--focus: #8cc8ff;
--danger: #f0aaa7;
--danger-border: #f0aaa75c;
--warning: #e1c68b;
--positive: #b5dfcf;
--note: #a9d4c50a;
--modal: #283542;
--overlay: #0b11189c;
--image-stage: #1b2733;
--crop: #a9dccb;
--crop-wash: #a9dccb16;
--scrollbar: #a8b8c860;
--scrollbar-hover: #a8b8c899;
--toggle-off: #617483;
--toggle-on: #a9dccb;
margin: 0; width: 100%; height: 100%; overflow: hidden;
font-family: LatoLatin; font-size: 15dp; color: var(--text);
background-color: var(--window-bottom);
decorator: linear-gradient(155deg, var(--window-top), var(--window-bottom));
}
body.silver {
--text: #233443;
--muted: #526779;
--accent: #25617a;
--window-top: #f0f5f9;
--window-bottom: #d4e0ea;
--chrome: #ffffff45;
--sidebar: #42627d09;
--panel: #f1f6fa80;
--wash: #42627d09;
--control-top: #ffffffb0;
--control-bottom: #bfd0e259;
--input: #ffffffad;
--popup: #f3f7fc;
--hover: #9eb9d43b;
--selected: #a3c3dd54;
--selected-hover: #a3c3dd88;
--selected-text: #193b52;
--border: #6c879c4a;
--divider: #6c879c28;
--accent-border: #356f966e;
--focus: #2b729a;
--danger: #a23f45;
--danger-border: #a23f4566;
--warning: #805b18;
--positive: #2e6953;
--note: #2e69530a;
--modal: #eaf1f7;
--overlay: #21324166;
--image-stage: #cfdae3;
--crop: #25617a;
--crop-wash: #25617a16;
--scrollbar: #6c879c88;
--scrollbar-hover: #526779bb;
--toggle-off: #91a8b8;
--toggle-on: #25617a;
}
body.matchday {
--text: #efeded;
--muted: #b7b4b9;
--accent: #efb2aa;
--window-top: #343338;
--window-bottom: #202126;
--chrome: #ffffff07;
--sidebar: #1d1e2426;
--panel: #1d1e2466;
--wash: #f8e7e00a;
--control-top: #e8d6dc12;
--control-bottom: #a1a0aa0d;
--input: #191a208a;
--popup: #303037;
--hover: #d5b3b423;
--selected: #d48c7b26;
--selected-hover: #d48c7b3d;
--selected-text: #ffe5de;
--border: #ead9da29;
--divider: #ead9da16;
--accent-border: #e5a19770;
--focus: #efb2aa;
--danger: #f0a6a7;
--danger-border: #f0a6a75c;
--warning: #e1c68b;
--positive: #afd1be;
--note: #afd1be0a;
--modal: #2c2c32;
--overlay: #1111149c;
--image-stage: #23242a;
--crop: #efb2aa;
--crop-wash: #efb2aa16;
--scrollbar: #827c8199;
--scrollbar-hover: #b7b4b999;
--toggle-off: #68646c;
--toggle-on: #efb2aa;
}
* { box-sizing: border-box; }
div, h1, h2, p, label, header, aside, section, footer { display: block; }
span { display: inline-block; }
#shell { width: 100%; height: 100%; display: flex; flex-direction: column; }
header { height: 86dp; flex-shrink: 0; display: flex; align-items: center; padding: 0 28dp; background-color: var(--chrome); border-bottom: 1dp var(--border); }
.brand { display: flex; align-items: center; width: 300dp; }
.brand-mark { width: 43dp; height: 43dp; line-height: 43dp; font-size: 21dp; font-weight: bold; text-align: center; border: 1dp var(--accent-border); border-radius: 13dp; color: var(--accent); background-color: var(--wash); margin-right: 13dp; }
.brand-mark span { color: var(--text); }
h1, h2, p { margin: 0; }
h2 { font-size: 20dp; font-weight: bold; }
h2 span { font-weight: normal; color: var(--muted); }
small { display: block; font-size: 12dp; color: var(--muted); margin-top: 4dp; }
#world-caption { flex: 1; font-size: 14dp; color: var(--muted); overflow: hidden; white-space: nowrap; }
#top-actions, #bottom-actions, #page-actions, .button-row { display: flex; align-items: center; gap: 8dp; }
button { font-family: LatoLatin; font-size: 14dp; color: var(--text); background-color: transparent; decorator: linear-gradient(var(--control-top), var(--control-bottom)); border: 1dp var(--border); border-radius: 8dp; padding: 9dp 14dp; cursor: pointer; text-align: center; white-space: nowrap; tab-index: auto; }
button:hover { background-color: var(--hover); decorator: none; }
button.primary { background-color: var(--selected); decorator: none; color: var(--selected-text); border-color: var(--accent-border); font-weight: bold; }
button.primary:hover { background-color: var(--selected-hover); }
button.danger { color: var(--danger); border-color: var(--danger-border); }
button:disabled { opacity: 0.35; cursor: unavailable; }
button.quiet { border-color: transparent; background-color: transparent; decorator: none; }
button.quiet:hover { background-color: var(--hover); }
#main { flex: 1; display: flex; min-height: 0; }
aside { width: 220dp; flex-shrink: 0; padding: 28dp 14dp 18dp; display: flex; flex-direction: column; background-color: var(--sidebar); border-right: 1dp var(--divider); }
.eyebrow { font-size: 11dp; font-weight: bold; letter-spacing: 1.5dp; color: var(--muted); text-transform: uppercase; }
#nav-label { padding: 0 14dp 18dp; }
#navigation { display: flex; flex-direction: column; gap: 5dp; min-height: 0; overflow-y: auto; }
.nav { width: 100%; display: flex; align-items: center; padding: 11dp 13dp; text-align: left; border-color: transparent; background-color: transparent; decorator: none; font-size: 15dp; }
.nav .glyph { width: 20dp; height: 20dp; margin-right: 16dp; flex-shrink: 0; }
.nav.selected { background-color: var(--selected); color: var(--accent); border-color: var(--accent-border); }
.aside-foot { margin-top: auto; padding: 24dp 14dp 0; font-size: 12dp; color: var(--muted); }
.aside-foot small { line-height: 1.45; }
.small-pitch { height: 50dp; width: 84dp; border: 1dp var(--border); border-radius: 4dp; margin-bottom: 15dp; position: relative; }
.small-pitch div { position: absolute; width: 20dp; height: 20dp; border: 1dp var(--border); border-radius: 10dp; left: 31dp; top: 14dp; }
#workspace { flex: 1; padding: 28dp 30dp 16dp; display: flex; flex-direction: column; min-width: 0; }
#page-heading { display: flex; justify-content: space-between; align-items: center; margin-bottom: 23dp; flex-shrink: 0; }
h1 { font-size: 28dp; font-weight: bold; margin-top: 7dp; }
#page-subtitle { color: var(--muted); margin-top: 7dp; font-size: 14dp; }
#toolbar { display: flex; gap: 10dp; margin-bottom: 16dp; flex-shrink: 0; align-items: center; }
input, select, textarea { font-family: LatoLatin; font-size: 14dp; background-color: var(--input); color: var(--text); border: 1dp var(--border); border-radius: 7dp; padding: 9dp 10dp; height: 38dp; tab-index: auto; }
input[type=checkbox] { width: 18dp; height: 18dp; padding: 2dp; background-color: var(--toggle-off); }
input[type=checkbox]:checked { background-color: var(--toggle-on); decorator: none; }
input[type=range] { height: 24dp; padding: 0; }
input[type=range] track { height: 4dp; background-color: var(--scrollbar); margin: 9dp 0; border-radius: 2dp; }
input[type=range] bar { width: 16dp; height: 16dp; border-radius: 8dp; background-color: var(--accent); margin-top: 3dp; }
select { padding-right: 25dp; }
select selectvalue { padding: 0; }
select selectarrow { width: 9dp; height: 9dp; margin-right: 9dp; margin-top: 11dp; decorator: none; border-bottom: 2dp var(--muted); border-right: 2dp var(--muted); transform: rotate(45deg); }
select selectbox { background-color: var(--popup); color: var(--text); border: 1dp var(--border); border-radius: 8dp; padding: 5dp; max-height: 290dp; overflow-y: auto; }
select option { font-size: 14dp; padding: 8dp; border-radius: 4dp; }
select option:hover, select option:checked { background-color: var(--selected); color: var(--selected-text); }
#search { width: 250dp; margin-right: auto; }
#filter-nation, #filter-league { width: 205dp; }
#filter-team { width: 240dp; }
#page-content { flex: 1; min-height: 0; display: flex; }
.split { width: 100%; display: flex; gap: 20dp; min-height: 0; }
.list-panel { flex: 1; min-width: 0; border: 1dp var(--border); border-radius: 12dp; overflow: hidden; background-color: var(--panel); display: flex; flex-direction: column; }
.table-header { display: flex; align-items: center; height: 42dp; flex-shrink: 0; padding: 0 16dp; background-color: var(--wash); border-bottom: 1dp var(--divider); }
.table-header button { flex: 1; text-align: left; padding: 0; border: 0; background-color: transparent; decorator: none; font-size: 12dp; color: var(--muted); }
.table-header button:hover { color: var(--text); }
.table-header button:first-child { flex: 2; }
.table-scroll { flex: 1; overflow-y: auto; }
.comparison-layout { flex: 1; display: flex; flex-direction: column; min-width: 0; min-height: 0; }
.comparison-bar { display: flex; align-items: center; gap: 12dp; margin-bottom: 14dp; flex-shrink: 0; }
.comparison-bar label, .comparison-bar span { color: var(--muted); font-size: 12dp; }
.comparison-bar span { margin-left: auto; }
#comparison-set { width: 310dp; }
.comparison-panel { min-height: 0; }
.comparison-x { flex: 1; min-height: 0; overflow-x: auto; overflow-y: hidden; display: flex; }
.comparison-table { flex-shrink: 0; display: flex; flex-direction: column; min-height: 0; }
.comparison-head { display: flex; flex-shrink: 0; align-items: stretch; background-color: var(--wash); border-bottom: 1dp var(--border); padding-right: 20dp; }
.comparison-head button { border: 0; border-radius: 0; decorator: none; background-color: transparent; color: var(--muted); font-size: 13dp; padding: 12dp 10dp; white-space: normal; }
.comparison-head button:disabled { opacity: 1; cursor: default; }
.comparison-head small { font-size: 11dp; }
.comparison-direction { width: 7dp; height: 7dp; border-bottom: 1.5dp var(--accent); border-right: 1.5dp var(--accent); transform: rotate(45deg); margin-left: 8dp; margin-bottom: 3dp; }
.comparison-direction.ascending { transform: rotate(225deg); margin-bottom: 0; }
.comparison-body { flex: 1; min-height: 0; overflow-y: auto; }
.comparison-row { display: flex; align-items: center; border: 0; border-bottom: 1dp var(--divider); border-radius: 0; decorator: none; background-color: transparent; padding: 0; min-height: 47dp; text-align: left; }
.comparison-cell { flex-shrink: 0; padding: 14dp 10dp; text-align: right; font-size: 14dp; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
.comparison-cell.text { text-align: left; }
.comparison-name-text { display: block; overflow: hidden; text-overflow: ellipsis; }
.comparison-note { flex-shrink: 0; margin-top: 12dp; font-size: 12dp; line-height: 1.6; color: var(--muted); }
.comparison-choices { display: flex; flex-wrap: wrap; max-height: 430dp; overflow-y: auto; margin-top: 16dp; gap: 6dp; }
.comparison-choices label { width: 31%; display: flex; align-items: center; padding: 10dp 4dp; font-size: 14dp; }
.comparison-choices input { flex-shrink: 0; margin-right: 10dp; border-radius: 4dp; }
.record { display: flex; align-items: center; width: 100%; min-height: 49dp; padding: 9dp 16dp; border: 0; border-bottom: 1dp var(--divider); border-radius: 0; background-color: transparent; decorator: none; text-align: left; }
.record:hover { background-color: var(--hover); }
.record.selected { background-color: var(--selected); border-left: 3dp var(--accent); padding-left: 13dp; }
.record .cell { flex: 1; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; padding-right: 10dp; font-size: 13dp; color: var(--muted); }
.record .cell:first-child { flex: 2; font-size: 14dp; color: var(--text); display: flex; align-items: center; }
.record.selected .cell { color: var(--selected-text); }
.mini-logo { width: 27dp; height: 27dp; margin-right: 12dp; flex-shrink: 0; }
.inspector { width: 370dp; flex-shrink: 0; border: 1dp var(--border); border-radius: 12dp; background-color: var(--panel); display: flex; flex-direction: column; overflow: hidden; }
.inspector-head { padding: 22dp; border-bottom: 1dp var(--divider); display: flex; align-items: center; flex-shrink: 0; }
.hero-image { width: 70dp; height: 70dp; margin-right: 16dp; }
.inspector-head h2 { font-size: 19dp; }
.inspector-head small { font-size: 10dp; margin-top: 7dp; }
.inspector-scroll { flex: 1; overflow-y: auto; padding: 20dp 22dp; }
.form-field { margin-bottom: 15dp; }
.form-field label { display: block; font-size: 12dp; color: var(--muted); margin-bottom: 6dp; }
.form-field input, .form-field select, .form-field textarea { width: 100%; }
textarea { height: 110dp; font-size: 12dp; line-height: 1.5; }
.form-section { padding-top: 8dp; margin-bottom: 15dp; font-size: 12dp; font-weight: bold; color: var(--accent); }
.form-help { font-size: 11dp; color: var(--muted); line-height: 1.5; margin-top: 6dp; }
.inspector-actions { padding: 16dp 20dp; border-top: 1dp var(--divider); display: flex; gap: 8dp; flex-shrink: 0; }
.inspector-actions button { flex: 1; }
.empty { margin: auto; padding: 45dp; text-align: center; color: var(--muted); line-height: 1.7; }
#pagination { display: flex; justify-content: space-between; align-items: center; flex-shrink: 0; padding-top: 14dp; color: var(--muted); font-size: 12dp; }
footer { height: 57dp; padding: 0 28dp; display: flex; align-items: center; gap: 20dp; flex-shrink: 0; border-top: 1dp var(--divider); background-color: var(--sidebar); font-size: 12dp; }
#state { width: 210dp; color: var(--positive); }
#status-message { flex: 1; color: var(--muted); }
#bottom-actions button { font-size: 12dp; padding: 7dp 11dp; }
.dashboard { width: 100%; overflow-y: auto; padding-right: 7dp; }
.hero { padding: 32dp; border: 1dp var(--border); border-radius: 16dp; background-color: var(--wash); margin-bottom: 22dp; }
.hero h1 { font-size: 32dp; margin: 0 0 12dp; }
.hero p { color: var(--muted); line-height: 1.6; max-width: 700dp; margin-bottom: 23dp; }
.metrics { display: flex; flex-wrap: wrap; gap: 14dp; }
.metric { width: 23%; flex-grow: 1; min-width: 180dp; min-height: 106dp; padding: 20dp; border: 1dp var(--border); border-radius: 12dp; background-color: var(--panel); decorator: none; text-align: left; }
.metric span { display: block; font-size: 28dp; font-weight: bold; color: var(--text); margin-top: 9dp; }
.note { margin-top: 22dp; padding: 18dp 20dp; background-color: var(--note); border: 1dp var(--accent-border); border-radius: 10dp; color: var(--positive); font-size: 13dp; line-height: 1.6; }
.source-json { font-size: 11dp; line-height: 1.5; white-space: pre-wrap; color: var(--muted); margin: 14dp 0; }
.regulation-layout { flex: 1; display: flex; gap: 20dp; min-width: 0; min-height: 0; }
.regulation-list { width: 270dp; flex: none; }
.regulation-choice { display: block; width: 100%; text-align: left; white-space: normal; padding: 15dp 18dp; border-radius: 0; border: 0; border-bottom: 1dp var(--divider); }
.regulation-choice small { font-size: 11dp; }
.regulation-detail { min-width: 0; }
.regulation-scroll { flex: 1; overflow-y: auto; padding: 25dp; }
.regulation-scroll p { margin-top: 12dp; font-size: 15dp; line-height: 1.55; }
.regulation-scroll h2 { line-height: 1.4; }
.regulation-section { margin: 27dp 0; padding-top: 22dp; border-top: 1dp var(--divider); }
.regulation-section h2 { font-size: 18dp; margin-bottom: 13dp; }
.regulation-clause { padding: 15dp 18dp; border: 1dp var(--border); border-radius: 10dp; background-color: var(--wash); margin-bottom: 12dp; }
.regulation-clause p { margin-top: 8dp; }
.regulation-scroll .source-json { font-size: 13dp; line-height: 1.55; }
.history-row, .diagnostic { padding: 15dp 20dp; border-bottom: 1dp var(--divider); line-height: 1.6; }
.diagnostic.error { color: var(--danger); }
.diagnostic.warning { color: var(--warning); }
.badge { display: inline-block; font-size: 11dp; border: 1dp var(--accent-border); color: var(--positive); border-radius: 5dp; padding: 3dp 6dp; }
#overlay { display: none; position: absolute; left: 0; top: 0; width: 100%; height: 100%; background-color: var(--overlay); align-items: center; justify-content: center; }
#modal { width: 620dp; max-height: 91%; padding: 27dp; border: 1dp var(--border); border-radius: 18dp; background-color: var(--modal); display: flex; flex-direction: column; }
#modal.wide { width: 880dp; }
.modal-head { display: flex; justify-content: space-between; align-items: center; margin-bottom: 22dp; flex-shrink: 0; }
.close { padding: 0 7dp; background-color: transparent; decorator: none; border-color: transparent; font-size: 25dp; }
#modal-content { overflow-y: auto; line-height: 1.6; }
#modal-buttons { margin-top: 23dp; display: flex; justify-content: flex-end; gap: 9dp; flex-shrink: 0; }
#modal-error { color: var(--danger); font-size: 13dp; margin-top: 10dp; }
.image-layout { display: flex; gap: 24dp; }
.image-stage { flex: 1; min-height: 360dp; background-color: var(--image-stage); border: 1dp var(--border); border-radius: 10dp; display: flex; align-items: center; justify-content: center; overflow: hidden; }
.hero-image, .mini-logo { cursor: pointer; }
.readonly-stage { height: 500dp; }
.image-caption { margin-top: 12dp; word-break: break-all; }
#crop-canvas { position: relative; }
#edit-preview { display: block; }
#crop-box { position: absolute; border: 2dp var(--crop); background-color: var(--crop-wash); pointer-events: none; }
.image-controls { width: 215dp; }
.pair { display: flex; gap: 8dp; }
.pair .form-field { flex: 1; min-width: 0; }
.check-label { display: flex; align-items: center; gap: 10dp; font-size: 14dp; margin: 14dp 0; }
scrollbarvertical { width: 7dp; margin: 3dp; }
scrollbarvertical slidertrack { background-color: transparent; }
scrollbarvertical sliderbar { background-color: var(--scrollbar); border-radius: 4dp; min-height: 30dp; }
scrollbarvertical sliderbar:hover { background-color: var(--scrollbar-hover); }
scrollbarvertical sliderarrowdec, scrollbarvertical sliderarrowinc { height: 0; }
scrollbarhorizontal { height: 10dp; margin: 3dp; }
scrollbarhorizontal slidertrack { background-color: transparent; }
scrollbarhorizontal sliderbar { background-color: var(--scrollbar); border-radius: 4dp; min-width: 40dp; }
scrollbarhorizontal sliderbar:hover { background-color: var(--scrollbar-hover); }
scrollbarhorizontal sliderarrowdec, scrollbarhorizontal sliderarrowinc { width: 0; }
button:focus, input:focus, select:focus, textarea:focus { border-color: var(--focus); }
.nav:focus { border-color: var(--focus); }
-45
View File
@@ -1,45 +0,0 @@
<!-- SPDX-License-Identifier: GPL-3.0-only -->
<rml>
<head>
<title>OpenBMH</title>
<link type="text/rcss" href="theme.rcss"/>
</head>
<body>
<img id="stadium" src="stadium.tga"/>
<div class="shade"/>
<div class="brand">
<div class="pitch"><div class="halfway"/><div class="circle"/><div class="goal left"/><div class="goal right"/></div>
<div class="wordmark">Open<span>BMH</span></div>
</div>
<div class="workspace">
<div class="library panel">
<h1>Deine Spiele</h1>
<div class="subtitle">Bundesliga Manager Hattrick · Football Limited</div>
<div class="table">
<div class="column-head"><span class="name">Name</span><span class="type">Art</span></div>
<div id="mod-list" tabindex="0"/>
</div>
<div id="mod-count" class="count">0 Mods</div>
</div>
<div class="actions panel">
<button id="start" class="action primary" data-action="start" disabled="disabled"><span class="icon play"/><span>Start</span></button>
<button id="add" class="action" data-action="add"><span class="icon plus"><span/></span><span>Add</span></button>
<button id="delete" class="action" data-action="delete" disabled="disabled"><span class="icon bin"><span/></span><span>Delete</span></button>
<button id="rename" class="action" data-action="rename" disabled="disabled"><span class="icon pencil"/><span>Rename</span></button>
<button id="end" class="action" data-action="end"><span class="icon exit"><span/></span><span>End</span></button>
</div>
</div>
<div id="version" class="version"/>
<div id="overlay">
<div id="modal" class="panel">
<h2 id="modal-title"/>
<div id="modal-body"/>
<div id="modal-error"/>
<div class="modal-buttons">
<button id="cancel" data-action="cancel">Abbrechen</button>
<button id="accept" class="primary" data-action="accept">OK</button>
</div>
</div>
</div>
</body>
</rml>
-20
View File
@@ -1,20 +0,0 @@
{
"asset": "stadium.tga",
"sha256": "8bd89b7db8dbd0e92707240c5367cb92f8f32c2903e08157d0f278ac2599d6cf",
"origin": "Independently generated night-stadium artwork for OpenBMH. No original game assets.",
"method": "Built-in image_gen edit; exported as uncompressed 24-bit TGA without changing pixels.",
"distribution": "Project-supplied launcher artwork, distributed with OpenBMH under GPL-3.0-only.",
"revision": {
"previous_sha256": "08f82783a357d5b0722f3737de54844150bc14d98036845f1aaee3211608e1c8",
"changes": [
"Replaced the city skyline above the stadium rim with dusk sky.",
"Added two netted goals and corrected the pitch markings, including a single center circle."
]
},
"prompt": "Use case: precise-object-edit.\nAsset type: clean stadium background artwork for the existing OpenBMH launcher, landscape approximately 16:10.\nEdit target: the provided image. Make only these two localized corrections; preserve the stadium bowl, seating tiers, roof and floodlights, camera framing, foreground railing, blue/navy palette, warm dusk glow, dreamlike cinematic style, overall exposure and dark middle area for the existing UI overlay.\n\n1. Remove the entire distant CITY SKYLINE above the far stadium rim: every building, tower, rooftop, tree silhouette and urban horizon. Seamlessly replace that band with the same dusk sky and clouds. Above the stadium's own roof/rim there must be SKY ONLY. Keep the stadium's structural roof supports and floodlights.\n\n2. Correct the FOOTBALL PITCH in the lower part of the image, preserving its overall placement and green lighting. It is a real association-football pitch seen from a slightly elevated MIDFIELD SIDELINE seat: the two short goal-line ends are LEFT and RIGHT, not near/far center. Draw one coherent rectangular pitch in consistent perspective with realistic football geometry (105 by 68 metres). Exactly ONE halfway line across the width at midfield, exactly ONE center circle centered on that line, appearing elliptical because of the low viewpoint. At EACH of the left and right short ends, add ONE clearly recognizable white football goal, with TWO uprights, ONE crossbar and netting receding behind the goal line. Goal width-to-height about 3:1 (7.32m x 2.44m); realistic size in relation to the pitch. Add correctly placed penalty areas, smaller six-yard goal areas, penalty spots and penalty arcs on BOTH ends, four corner arcs and subtle corner flags. Do not put penalty boxes across midfield. Do not add duplicate circles, fake stripes, random white line fragments, a center-front goal, or a running track. Adjust only the grass/lines/goal areas as needed to fit a sensible single pitch. Both goals and correct layout should be visible within the existing image framing, even if a future UI overlay may cover part of them.\n\nNo UI panels, lettering, logos, advertisements with text, watermarks, players or extra architecture. Keep the original stylized mood; accuracy of the football equipment and markings matters more than adding detail.\n\nGrass cleanup:\nEdit the attached stadium illustration. This is an intermediate cleanup of the grass only, before correct markings are added separately.\nCOMPLETELY REMOVE EVERY WHITE PAINTED LINE AND SPOT ON THE GRASS. The entire playing field in the bottom part of the image must be continuous UNMARKED GREEN GRASS. NO center circle, NO halfway line, NO penalty boxes, NO goal-area lines, NO arcs, NO white grass markings whatsoever. Repaint the whole grass surface, not just a thin stroke. White goal frames with nets at the left and right edges must remain, since these are objects, not paint on grass. Keep corner flags. Everything above the pitch and the foreground rail must be unchanged: sky without any city silhouette, stadium, stands, lights, same composition and night colors.\nThe immediate output must show two goals beside an EMPTY UNMARKED RECTANGLE OF GREEN TURF. No text, no UI.\n\nFinal markings:\nUse case: precise-object-edit.\nEdit only the unmarked GRASS in the supplied stadium image. Add a single realistic association-football pitch's thin white painted markings, in the existing perspective of a midfield sideline view, with the two goals at the LEFT and RIGHT ends.\nDraw one complete perspective rectangle for the touchlines and goal lines, the goal lines aligned with the two existing goal mouths. At its middle draw exactly ONE straight halfway line from far touchline to near touchline and exactly ONE complete elliptical center circle centered on it, with one small center spot. Draw a rectangular penalty area and a smaller six-yard goal area at EACH goal end, with a penalty spot and a penalty arc outside each penalty area facing midfield. Draw tiny quarter-circle corner arcs at the four corners. The lines must follow one coherent standard full-size football pitch layout and perspective; no extra arcs or duplicate midfield circles.\nThe middle of the field is between the two left/right goals; do not draw a second circle near the far sideline. The width-to-depth of the visible center ellipse should be about 5:1 due to foreshortening. All marks are thin, subtle white paint, grounded on the existing grass.\nPreserve the two existing netted goals, four corner flags, rail, sky with NO city, stands, floodlights, dark navy twilight style, composition, and every part above the grass exactly as they are. Do not add people, text, branding, UI or watermarks.",
"serialization": {
"format": "uncompressed 24-bit TGA, bottom-to-top rows",
"previous_sha256": "fb8e5f1f86afe60de87b70a2f533690d1ef470241fa24ee4384ff000149edaab",
"reason": "Compatible row stride in the pinned Direct3D 11 loader; decoded RGB pixels are unchanged."
}
}
Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 MiB

-74
View File
@@ -1,74 +0,0 @@
/* SPDX-License-Identifier: GPL-3.0-only */
body { margin: 0; width: 100%; height: 100%; overflow: hidden; font-family: LatoLatin; font-size: 18dp; color: #eef3fa; background: #07121e; }
div, h1, h2, label { display: block; box-sizing: border-box; }
h1, h2 { margin: 0; font-weight: bold; }
span { display: inline-block; }
#stadium { position: absolute; left: 0; top: 0; width: 100%; height: 100%; }
.shade { position: absolute; width: 100%; height: 100%; background-color: #06152525; }
.brand { position: absolute; left: 5.3%; top: 19%; display: flex; align-items: center; }
.wordmark { font-size: 44dp; font-weight: bold; margin-left: 18dp; }
.wordmark span { color: #76efc1; }
.pitch { width: 80dp; height: 57dp; border: 2dp #79efc2; border-radius: 3dp; position: relative; }
.halfway { position: absolute; left: 50%; top: 0; bottom: 0; border-left: 2dp #79efc2; }
.circle { position: absolute; left: 30dp; top: 18dp; width: 18dp; height: 18dp; border: 2dp #79efc2; border-radius: 9dp; }
.goal { position: absolute; top: 17dp; width: 10dp; height: 22dp; border: 2dp #79efc2; }
.goal.left { left: -2dp; } .goal.right { right: -2dp; }
.workspace { position: absolute; left: 4.5%; right: 4.5%; top: 31%; bottom: 15.5%; display: flex; }
.panel { background: #081522ee; border: 1dp #34495e; border-radius: 10dp; }
.library { flex: 1; min-width: 0; padding: 21dp 23dp 14dp; display: flex; flex-direction: column; }
h1 { font-size: 31dp; }
.subtitle { color: #a9bfd7; font-size: 16dp; margin: 4dp 0 16dp; }
.table { flex: 1; min-height: 50dp; border: 1dp #2d4358; border-radius: 6dp; overflow: hidden; display: flex; flex-direction: column; }
.column-head { display: flex; padding: 11dp 21dp; color: #a8bbd2; font-size: 17dp; background: #10203388; }
.name { flex: 1; min-width: 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
.type { width: 150dp; margin-left: 12dp; }
#mod-list { flex: 1; overflow-y: auto; overflow-x: hidden; }
.mod-row { display: flex; align-items: center; width: 100%; padding: 12dp 21dp; font-size: 18dp; color: #e8eff9; border-bottom: 1dp #20364c; border-left: 6dp transparent; background: transparent; text-align: left; }
.mod-row:hover { background: #203a4999; }
.mod-row.selected { background: #183b40bb; border-left-color: #78f0c2; }
.mod-row.invalid { color: #efc68c; }
.mod-row:focus { border-bottom-color: #78f0c2; }
.empty { padding: 24dp 15dp; color: #b8c8d9; font-size: 17dp; text-align: center; }
.empty-detail { color: #91a8c1; margin-top: 12dp; font-size: 15dp; }
.count { font-size: 14dp; color: #a8bdd5; margin-top: 12dp; }
.actions { margin-left: 10dp; width: 257dp; padding: 20dp 18dp 17dp; display: flex; flex-direction: column; justify-content: space-between; }
button { box-sizing: border-box; font-family: LatoLatin; font-size: 18dp; color: #f4f7fc; background: #091723bb; border: 1dp #6d86a3; border-radius: 7dp; padding: 10dp 17dp; cursor: pointer; tab-index: auto; }
button:hover { background: #203a4aee; border-color: #a7c3da; }
button:focus { border-color: #a0f7d6; }
button:active { background: #2b4b57; }
button:disabled { opacity: 0.40; cursor: default; }
.action { width: 100%; height: 55dp; display: flex; align-items: center; justify-content: center; font-weight: bold; }
.primary { background: #76edbe; color: #041712; border-color: #8df7cf; font-weight: bold; }
.primary:hover { background: #a1ffda; border-color: #c3ffe6; }
.primary:active { background: #58cfa2; }
.danger { border-color: #dc817f; color: #ffb6ad; background: #55262b; }
.icon { display: inline-block; width: 21dp; height: 21dp; margin-right: 21dp; position: relative; box-sizing: border-box; }
.play { width: 0; height: 0; border-left: 17dp #061911; border-top: 11dp transparent; border-bottom: 11dp transparent; }
.plus { border-top: 2dp #b1c6df; width: 21dp; height: 1dp; }
.plus span { position: absolute; height: 21dp; left: 9dp; top: -12dp; border-left: 2dp #b1c6df; }
.bin { width: 16dp; height: 20dp; border: 2dp #b1c6df; border-radius: 2dp; }
.bin span { position: absolute; left: -5dp; top: -6dp; width: 22dp; border-top: 2dp #b1c6df; }
.pencil { height: 22dp; width: 7dp; border: 2dp #b1c6df; transform: rotate(40deg); }
.exit { width: 14dp; border: 2dp #b1c6df; border-right-width: 0; }
.exit span { position: absolute; left: 6dp; top: 7dp; width: 15dp; border-top: 2dp #b1c6df; }
.version { position: absolute; right: 20dp; bottom: 14dp; font-size: 11dp; color: #8fa8c1; }
#overlay { display: none; position: absolute; width: 100%; height: 100%; background: #020810bb; }
#modal { position: absolute; left: 50%; top: 50%; transform: translate(-50%, -50%); width: 580dp; padding: 25dp; }
h2 { font-size: 25dp; margin-bottom: 19dp; }
#modal-body { font-size: 17dp; line-height: 1.45; max-height: 360dp; overflow: auto; }
label { color: #afc5dd; font-size: 15dp; margin: 12dp 0 6dp; }
input { box-sizing: border-box; display: block; width: 100%; height: 39dp; padding: 8dp 10dp; color: #eff6ff; background: #06111eee; border: 1dp #567088; border-radius: 4dp; font-size: 18dp; caret-color: #86f3cb; tab-index: auto; }
input:focus { border-color: #85f3ca; }
.fields { display: flex; } .fields .year { width: 160dp; }
.check-row { display: flex; align-items: center; margin: 18dp 0 7dp; }
input.checkbox { width: 20dp; height: 20dp; padding: 0; margin-right: 12dp; }
input.checkbox:checked { background: #78edbf; border-color: #78edbf; }
.check-row label { margin: 0; color: #e9f2fb; }
.browse-row { display: flex; } .browse-row input { flex: 1; min-width: 0; }
.browse-row button { margin-left: 9dp; font-size: 15dp; }
.modal-buttons { display: flex; justify-content: flex-end; margin-top: 23dp; }
.modal-buttons button { margin-left: 10dp; min-width: 110dp; }
#modal-error { color: #ffb7a5; font-size: 15dp; margin-top: 12dp; }
scrollbarvertical { width: 10dp; } scrollbarvertical sliderbar { background: #476077; border-radius: 4dp; }
selection { color: #051711; background-color: #76edbe; }
+17 -8
View File
@@ -1,6 +1,6 @@
# Building OpenBMH
Requirements: a C++20 compiler, CMake 3.24 or newer, Git and a supported build tool such as Ninja. The CMake project fetches pinned SDL2, miniz, 7-Zip C decoder, nativefiledialog-extended, RmlUi and FreeType sources. Network access is needed on the first configure unless these dependencies are supplied locally. Nuked OPL3 is included in the source tree.
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
@@ -10,7 +10,7 @@ ctest --test-dir build --output-on-failure
The public checkout does not include game data. Tests that require a game installation are conditional; configure with `-DBMH_DATA="path/to/game"` to make locally available data eligible. Private saved-game fixtures are not supplied by the project. Read the test output to distinguish executed and skipped checks.
Main programs are `OpenBMH` (native launcher and graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
Main programs are `OpenBMH` (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
@@ -26,7 +26,7 @@ With a Visual Studio generator, choose one actually provided by your installed C
## Linux
Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the folder-dialog backend. The RmlUI launcher uses SDL2/OpenGL; its native folder picker uses GTK3 on Linux. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config`, `libgl1-mesa-dev` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries. RmlUI and FreeType are built from pinned sources without installing them separately. Keep the generated `assets/launcher` directory alongside OpenBMH when copying a development build.
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.
@@ -42,13 +42,22 @@ ctest --test-dir build-macos --output-on-failure
Use native toolchain/dependency architectures consistently. A terminal executable and a Finder-launchable, signed `.app` package are different deliverables. The commands describe the build procedure, not a claim that a particular Windows or macOS binary has passed native acceptance.
## Import and run your data
Start the native launcher, choose **Add**, and select your original installation. Content and personal files are portable beside the executable. The original installation is needed only for import. See the [0.2 contract](formats/obw/runtime-0.2.md).
## Run with your data
```sh
build/OpenBMH
build/openbmh_cli --console --mod "build/mods/BMH-classic/content.obw" --seed 1
build/OpenBMH --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.
## Build the data-free CI subset
`cmake --build build` compiles every development helper and test. With no private integration data configured, CI builds both products and every executable actually referenced by CTest instead:
```sh
python3 tools/ci/build_runnable_tests.py --build build --config Release --parallel 2
ctest --test-dir build -C Release --output-on-failure
```
Tests whose inputs are unavailable still report a skip through the normal optional-data helper; they are not counted as passes. Supplying integration data during configuration causes their real programs to enter this build subset automatically. Source-export and build-discovery checks run separately in CI.
+1 -1
View File
@@ -1,6 +1,6 @@
# 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).
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/1.0/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.
+12 -34
View File
@@ -2,7 +2,7 @@
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.
- Content such as names, text, graphics and edition-specific tables is loaded from the user's installation. The loaded program retains its own rule-table values; loading no longer applies the former shared replacement profile.
- 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.
@@ -23,43 +23,21 @@ An unavailable native message box also cancels the request. This applies to
voluntary application exits, including quit events received during animations;
normal completed-career handling remains separate.
## Environment and presentation in 0.1.2
## Original edition rules in 1.0
The desktop environment provides three youth teams and three staff
budgets, each set to zero through six stars. Youth budgets are monthly, can be
changed throughout the season, and contribute to the finance preview, balance
plan and booked expenses. Youth tables develop on first-division matchdays;
promotion, relegation and age-group handover occur at the season change.
The two previously hidden youth groups are available across data editions.
Staff prices and the shared academy player-generation strength bands stay in
effect. Recruitment needs an active middle youth budget and an oldest youth team
within 25 strength points of the senior squad (the full-build mode bypasses the
strength gate). This deliberately
combines the six-budget environment with OpenBMH's existing player-generation rules.
Loaded executable images retain their own rule tables. Career strength ranges are read from all nine pairs of the supplied original table.
Old saved academy lump sums remain payable once and retain their paid status.
They are not multiplied into twelve monthly payments. Editing that tile replaces
the old amount with the selected monthly budget. There is no new save field.
The six-budget monthly environment implementation has been checked against the provided CD and Diamond 3.6/3.7 program code. Its budget increments are read from that program's own table. Capability recognition uses verified code fingerprints, never directory names. Unrecognized environment implementations cannot be edited or simulated through a guessed model; they require separate compatibility verification. Older Diamond academy patches are not silently treated as the monthly model. The old floppy executable remains unsupported, and Football Limited remains experimental.
Live match minutes use the loaded original delay setting (A9), including zero,
instead of an added fixed pause. A9 and the existing scene delays can be adjusted
in Settings; loaded saves and EIN files retain their chosen speeds. VGA retrace
animations use a 70-Hz reference instead of the host monitor's refresh rate.
`--live-frame-ms` and `BMH_LIVE_FRAME_MS` remain explicit diagnostic overrides.
Release acceptance of individual editions is recorded separately from their recognition. Source compatibility and automated tests do not establish full original-game or platform validation.
## Native data and saves in 0.2
## Diamond 3.7 foreign crests
Classic imports preserve the supported BMH and Football Limited structures in sealed OBW
packages. The normal runtime no longer reads the original installation. Package integrity
failures require reimport; Classic overlays and manual content editing are unsupported.
The supplied edition controls whether foreign league clubs use individual
original crests or the original neutral crest. OpenBMH recognizes the verified
Diamond 3.7 drawing gate and uses its database/save selectors and W atlases.
Older drawing gates retain their own behaviour; no external crest pack is needed.
Native saving and autosaving consume no random numbers. The FBM writer previously drew
four Watcom values for its encryption envelope, so future results after a legacy save
operation can differ. A native save/load pair preserves both generators and their draw
counts exactly. Original saves lack the clock-seeded Watcom state; migration derives its
initial value reproducibly from the source file and records the full state thereafter.
The automatic lineup installs the supplied foreign-player rule switch alongside the career tables. Where enabled, it restores the original three/two-player limit, reserve swaps with board-coordinate preservation and the short-lineup outcome when domestic reserves are unavailable. This does not consume additional random draws.
The launcher start year affects displayed years only. Classic weekdays and season timing
retain their existing cycle. Imported careers keep the valid year in their own save header.
The launcher exits without confirmation; the running game's existing exit confirmation
remains in effect and returns control to the launcher after a confirmed exit.
New careers correct the original all-zero EM qualification placeholders to the original national-team placeholders. Supplied nonzero seeds and restored savegame state are not rewritten by this initialization.
+2 -2
View File
@@ -4,12 +4,12 @@ The console is a local control interface for one running career. Human clients,
## Choose a transport
For a single process, start `openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
For 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 --mod "mods/BMH-classic/content.obw" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
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:
+4 -7
View File
@@ -6,22 +6,19 @@ See [Compatibility decisions](COMPATIBILITY.md) for the overall policy. These en
describe deliberate changes; they are not a list of every known compatibility limit.
- [src/app/career_session.cpp](../src/app/career_session.cpp): supports designated set-piece record initialization and validation.
- [src/app/career_session.cpp](../src/app/career_session.cpp): native saves do not consume gameplay randomness for encryption.
- [src/app/quit_confirmation.hpp](../src/app/quit_confirmation.hpp): confirms application exit with a localized native dialog, with cancellation selected by default.
- [src/formats/le.hpp](../src/formats/le.hpp): applies a shared supported rule profile when loading editions with different rule-table values.
- [src/formats/rule_base.cpp](../src/formats/rule_base.cpp): normalizes live-scene defaults, league strength ranges, option defaults, stadium prices and capacities, betting limits, and the foreign-player limit across supported editions.
- [src/formats/rule_base.hpp](../src/formats/rule_base.hpp): normalizes live-scene options, league strength ranges, option defaults, stadium prices and capacities, betting limits, and the foreign-player limit.
- [src/game/career.cpp](../src/game/career.cpp): skips reserved calendar positions when assigning a joining manager to a club.
- [src/game/career.hpp](../src/game/career.hpp): uses the supported player-generation ranges and excludes reserved calendar positions when assigning managers.
- [src/game/desk_actions.cpp](../src/game/desk_actions.cpp): uses the supported transfer-fee arithmetic and designated set-piece fields.
- [src/game/desk_actions.hpp](../src/game/desk_actions.hpp): supports designated set-piece records and the supported transfer-editor rules.
- [src/game/environment.hpp](../src/game/environment.hpp): uses six monthly environment budgets across data editions while retaining the shared staff prices and academy player-generation strength bands.
- [src/game/highscore.cpp](../src/game/highscore.cpp): reads the supported edition-specific high-score format from the loaded image.
- [src/game/lineup.cpp](../src/game/lineup.cpp): disables the foreign-player limit in the supported rule profile.
- [src/game/lineup.hpp](../src/game/lineup.hpp): disables the foreign-player limit and supports owner-bound designated set-piece selection.
- [src/game/lineup.hpp](../src/game/lineup.hpp): supports owner-bound designated set-piece selection.
- [src/game/match.hpp](../src/game/match.hpp): uses the enhanced injury selection and suspension rules.
- [src/game/match_engine.cpp](../src/game/match_engine.cpp): supports designated set-piece takers, the enhanced injury tables, and the extended suspension fields.
- [src/game/season.cpp](../src/game/season.cpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
- [src/game/season.cpp](../src/game/season.cpp): age/retire each player once, even when a temporary offer row references his club slot or regeneration moves him to a later free-agent slot.
- [src/game/season.cpp](../src/game/season.cpp): includes transfer-market players in retirement so the five-bit age cannot wrap to 16.
- [src/game/season.cpp](../src/game/season.cpp): initializes the empty EM qualifier seeds with national teams, preventing club zero from entering the EM.
- [src/game/season.hpp](../src/game/season.hpp): retains the enhanced academy player-generation strength bands with monthly youth budgets.
- [src/game/state.hpp](../src/game/state.hpp): retains designated set-piece selections in the supported manager-record extension.
- [src/game/week.cpp](../src/game/week.cpp): uses the enhanced training rules: focus strength is at least five below its target, and completed skills rotate to another focus.
-138
View File
@@ -1,138 +0,0 @@
# OpenBMH Editor 0.5.3
Der eigenständige, native Editor verwendet **RmlUI und SDL2**, unter Windows mit Direct3D 11, unter Linux/macOS mit OpenGL. Er bearbeitet Startdatenbanken, keine laufenden Spielstände. Das Spiel und seine Classic-Prüfung bleiben unverändert. Editor 0.5.3 hat eine eigene Versionsreihe und den Release-Tag `editor-v0.5.3`; die Spielversion ist 0.2.1.
## Windows-Start und Diagnose
Windows verwendet Direct3D 11 und wechselt bei fehlender Hardware automatisch auf
den integrierten WARP-Renderer. Der Editor und der Spiel-Launcher benötigen dort
keinen OpenGL-Treiber. Dieser Start wird auch mit erzwungenem WARP auf Windows
Server 2022 geprüft. Zum gezielten Testen lässt sich `OPENBMH_RML_DRIVER=warp`
setzen; die normale Auswahl erfolgt automatisch.
Startfehler erscheinen in einem nativen Dialog und werden zusätzlich unter
`%LOCALAPPDATA%\OpenBMH\OpenBMHEditor-startup.log` protokolliert. Bei einem
Aufruf aus PowerShell/CMD kann auch stderr umgeleitet werden. Headless- und
MCP-Aufrufe zeigen keinen modalen Fehlerdialog und behalten ihre Prozesscodes.
## Starten und Daten öffnen
Das vollständige Paket `OpenBMHEditor-0.5.3-<plattform>.zip` entpacken und `OpenBMHEditor.exe` (Windows) beziehungsweise `OpenBMHEditor` (Linux/macOS) starten. `assets/editor` muss beim Programm bleiben. Auf macOS kann die unsignierte Anwendung über **Rechtsklick → Öffnen** gestartet werden. Eine Signatur/Notarisierung ist nicht Bestandteil dieser Version. `OpenBMHEditor --version` zeigt die Editorversion ohne Grafikstart.
**Öffnen** bietet OBW-Dateien und entpackte Welten an. **BMH / FLTD importieren** liest einen Ordner mit einer unterstützten BMH- oder Football-Limited-Installation durch den bestehenden Konverter. Das Original wird nicht überschrieben. Eine bestehende Classic-OBW wird zunächst überprüft und dann in eine bearbeitbare Editorwelt übernommen.
**Demo öffnen** lädt ausschließlich synthetische Testdaten. Echte Vereine, Spielerdaten, Fotos und importierte Originalgrafiken gehören in getrennte, private Datenpakete.
## Bearbeiten
- Links einen Datenbereich auswählen; die Liste lässt sich durchsuchen, filtern, sortieren und seitenweise durchgehen. Rechts Änderungen mit **Anwenden** übernehmen. **Speichern** übernimmt auch die aktuellen Eingaben.
- **Doppelklick** auf ein Land zeigt seine Ligen, auf eine Liga ihre Vereine und auf einen Verein dessen Spieler. Land, Liga und Verein werden als Filter übernommen. Ein einfacher Klick wählt weiterhin den Datensatz zum Bearbeiten aus. Nicht übernommene Eingaben werden vor dem Wechsel abgefragt.
- Länder, Wettbewerbe, Vereine, Spieler, Kader, Stadien und Schiedsrichter lassen sich anlegen und bearbeiten. Referenzierte Datensätze werden erst nach Änderung ihrer Verknüpfungen gelöscht. Vereinswechsel zwischen Ligen aktualisieren auch deren Mitgliederlisten.
- Spielwerte behalten ihre **quellenspezifischen Wertebereiche**. Ein Classic-Wert wird nicht auf eine erfundene 1–10-Skala umgerechnet. Neue Spieler ohne belegte Werte bleiben zunächst unbewertet.
- Kader bleiben vollständig erhalten. Die Schaltfläche **24** schaltet lediglich die Seitengröße um. Spieler lassen sich über das Vereinsfeld verschieben, zum Tausch merken und mit einem anderen Spieler tauschen; die Pfeile ändern ihre Reihenfolge.
- **Prüfen** zeigt überlieferte Quellenkonflikte. Eine Auswahl übernimmt den gewählten Wert; die übrigen Quellen bleiben erhalten. Fehlende Daten sind Hinweise, fehlerhafte Verknüpfungen oder unzulässige Werte blockieren Änderungen und Speichern.
- Rückgängig/Wiederholen gilt gemeinsam für native Oberfläche und MCP. Noch nicht angewendete Eingaben werden bei externen Änderungen nicht automatisch ersetzt; eine veraltete Änderung muss nach Aktualisierung erneut geprüft werden.
- **Bilder** und die Bildaktionen am Datensatz unterstützen PNG, JPEG, WebP und eigenständige SVG. Vor dem Import: Ausschnitt ziehen oder Werte eingeben, frei drehen, spiegeln. Ein unveränderter Import behält seine Originalbytes. Bearbeitete Rasterbilder werden PNG, SVG bleibt Vektor. Das Original und die Transformationswerte bleiben für erneutes Bearbeiten im Paket. Classic-Porträts werden aus ihren eingefrorenen Rezepten angezeigt; eine Umbenennung ändert das Gesicht nicht.
- Bildänderungen am Spieler, Verein oder Wettbewerb erhalten eine eigene Zuordnung. Gemeinsame Platzhalter und Bilder anderer Datensätze bleiben dabei erhalten. Im Bereich **Bilder** kann ein gemeinsam verwendetes Bild bewusst zentral bearbeitet werden.
- Ein Klick auf ein Wappen, Porträt, einen Pokal oder ein Bild in der Liste öffnet eine große, schreibgeschützte **Bildvorschau**. **Zum Asset** öffnet den zugehörigen Eintrag im Bereich **Bilder**. Bei zusammengesetzten Classic-Porträts ohne einzelne Bilddatei führt die Schaltfläche zur allgemeinen Bildübersicht. Das Anschauen verändert keine Daten; beim Wechsel bleiben offene Eingaben durch die Übernehmen-/Verwerfen-Abfrage geschützt.
**Speichern** erzeugt ausschließlich `.obw` im Profil **`editor-world-v1`, Format 1.1**. Editorwelten sind **noch nicht im Classic-Spiel startbar**. Die Bezeichnung ist im Editor sichtbar. Unbekannte Erweiterungen, nicht bearbeitete Dokumente, Quellnachweise und Bilder bleiben erhalten. Noch nicht im Formular angebotene Regeln, Kalender- und Finanzdaten werden erhalten, aber nicht als vollständig editierbare Bereiche ausgegeben.
Shortcuts: Ctrl/Cmd+O, Ctrl/Cmd+S, Shift+Ctrl/Cmd+S, Ctrl/Cmd+Z und Shift+Ctrl/Cmd+Z. In Textfeldern gilt die lokale Text-Rückgängig-Funktion.
## Stärken und Gehälter vergleichen
**Wertevergleich** in der Seitenleiste (oder die gleichnamige Schaltfläche bei Spielern, Vereinen und Wettbewerben) öffnet eine Übersicht mit drei Ansichten: **Spieler**, **Mannschaften**, **Ligen**. Spieler zeigen ihre einzelnen Spielwerte und das Gehalt je Saison; Mannschaften und Ligen zeigen Durchschnittswerte, Spielergehaltssummen, das Durchschnittsgehalt und die Anzahl bekannter Gehälter. Ein Klick auf eine Zeile öffnet ihren Datensatz zur Bearbeitung.
- Auf einen Spaltenkopf klicken, um auf- oder absteigend zu sortieren. Sortiert wird der gesamte gefilterte Bestand vor der Aufteilung auf Seiten mit bis zu 200 Zeilen. Suche sowie Land-, Liga- und Vereinsfilter grenzen die Ansicht ein. Fehlende Zahlen stehen in beiden Sortierrichtungen hinten.
- **Spalten auswählen** blendet beliebige vorhandene Spielwerte ein. Bei vielen Spalten horizontal scrollen; Tabellenkopf und Werte bewegen sich gemeinsam. Die Wertebereiche stehen im Spaltenkopf, Gruppenwerte sind spielergewichtete Durchschnitte über bekannte Werte. Der gesamte Kader einschließlich Reserve zählt; reine Quellenduplikate mit `x-simulation.squad_role: source-only-duplicate` werden ausgeschlossen und ihre Anzahl angezeigt.
- Verschiedene Attributsysteme bleiben getrennt. Bei einem einzigen System werden dessen Spielwerte automatisch angezeigt. Bei mehreren ein **Attributsystem** wählen, um dessen Spieler und die daraus gebildeten Mannschafts-/Ligawerte zu vergleichen. Das FC-Attribut `strength` heißt in einem System mit `overall` **Körperkraft**; es wird nicht als Classic-Gesamtstärke interpretiert. Es wird keine neue Stärkeskala berechnet.
- **Gehälter gelten je Saison**, in der Währung und kleinsten Einheit aus dem OBW-Manifest. Berücksichtigt werden zum Saisonstart gültige Verträge des Spielers mit seiner aktuellen Mannschaft. Personalverträge, abgelaufene und zukünftige Verträge zählen nicht. Mehrere gleichzeitig gültige Verträge derselben Zuordnung sind unklar und werden nicht addiert. Ohne Vertragsangabe steht **—**, ein ausdrücklich gespeichertes Nullgehalt bleibt **0**.
- Unvollständige Gehaltssummen und Durchschnitte tragen ein **\***. Sie berücksichtigen nur bekannte Spielergehälter; die Spalte **Gehälter bekannt** zeigt die Abdeckung. Auch Spielwertdurchschnitte verwenden nur bekannte Werte (Anzahl per Tooltip). Classic-Grunddaten liefern häufig keine konkreten Verträge: Der Editor erfindet diese Gehälter nicht.
[Native Vorher-/Nachher-Bilder](qa/editor-comparison/README.md) dokumentieren die Ansichten und Spaltenauswahl.
Die Übersicht verändert weder Daten noch Undo-Historie. Änderungen und Rückgängig aktualisieren ihre Werte automatisch. Alle drei Themes und beide Sprachen werden unterstützt.
Über MCP liefert **`editor_compare`** dieselbe schreibgeschützte Übersicht. Beispielargumente:
```json
{"table":"players","sort":"attributes.overall","descending":true,"limit":200}
```
`table` ist `players`, `clubs` oder `leagues`. Weitere Sortierschlüssel sind `name`, `salary` (Spieler), `salary_total`, `salary_average`, `salary_known`, `player_count`, `club_count` sowie `attributes.<feld>`. `attribute_set` grenzt das System ein, `search`, `nation`, `competition`, `team` filtern, `offset`/`limit` blättern. Die Antwort enthält Originalskalen, Stichtag, Währung und Abdeckung. Gehälter bleiben Integer in kleinster Währungseinheit; das Durchschnittsgehalt wird auf diese Einheit gerundet. Das entsprechende Session-Kommando für Command-Scripts heißt `compare`.
## Optionen und MCP
**Optionen** bietet Deutsch/Englisch, Midnight Glass/Silver Glass/Matchday und den integrierten MCP-Server. Die Sprache ändert die Oberfläche; Namen und Quelldaten werden nicht übersetzt. Einstellungen werden im Benutzerprofil gespeichert.
Unter **Darstellung** stehen die drei Farbwelten der modernen Untermenüs zur Auswahl:
- **Midnight Glass:** Schiefergrau mit dezenten Mint-Akzenten.
- **Silver Glass:** helle silbergraue Flächen mit Petrol-Akzenten.
- **Matchday:** Graphit mit warmen Korall-Akzenten.
**Anwenden** wechselt das Theme ohne Neustart. Die Farbwahl gilt auch für Tabellen, Eigenschaften, Dropdowns, Meldungen und die Bildbearbeitung. [Native Vergleichsbilder](qa/editor-poc/README.md#theme-comparison) zeigen alle drei mit denselben synthetischen Daten.
Der MCP-Server ist standardmäßig aktiviert und bindet ausschließlich `127.0.0.1`, standardmäßig Port `8765`. Port `0` wählt einen freien Port. Status und tatsächlicher Port sind in Optionen sichtbar. **Verbindung kopieren** kopiert eine JSON-Konfiguration einschließlich Bearer-Token für HTTP-fähige MCP-Clients. Das Token bleibt lokal im Benutzerprofil und wird nur auf ausdrückliches Kopieren/CLI-Anfordern ausgegeben. Ein anderer bereits laufender Editor kann den Standardport belegen; dann einen anderen Port wählen.
Implementiert ist [MCP Streamable HTTP 2025-11-25](https://modelcontextprotocol.io/specification/2025-11-25/basic/transports), mit Aushandlung von 2025-06-18; JSON-Antworten, ohne optionale SSE-Sitzungen. Neuere MCP-Versionen werden nicht als unterstützt beworben. Der Server prüft Token, Host und gegebenenfalls Origin. Oberfläche und Agent bearbeiten dieselbe Welt, verwenden dieselbe Validierung und dieselbe Undo-Historie. Für konkurrierende Änderungen `expected_revision` aus `editor_info`/`editor_get` mitsenden.
Werkzeuge: `editor_info`, `editor_open`, `editor_new`, `editor_list`, `editor_compare`, `editor_regulations`, `editor_get`, `editor_apply`, `editor_rules`, `editor_validate`, `editor_history`, `editor_save`, `editor_undo`, `editor_redo`, `editor_roster_move`, `editor_roster_swap`, `editor_roster_order`, `editor_review_resolve`, `editor_image_import`, `editor_image_edit`, `editor_image_preview`, `editor_image_export`. Die eingeblendeten Tools enthalten Parameterschemata und Beschreibungen. Öffnen einer anderen Welt verwirft ungespeicherte Änderungen nur mit `discard: true`.
## Spiel- und Ligaregeln ansehen
**Regelwerk** zeigt Auf- und Abstieg, Ziel-Ligen, Relegation und internationale
Qualifikation. Wettbewerbe lassen sich durchsuchen und nach Land filtern.
**Spielregeln** zeigt die übernommenen Einträge aus `world/rules.json`, etwa
Wertebereiche, Kreditfaktoren, Trainingslager und Classic-Verfahren. Phasen und
weitere Originalfelder sind ebenfalls einsehbar. Dieser Bereich ist vollständig
schreibgeschützt; er verändert weder Welt noch Undo-Historie.
Explizite OBW-Regeln werden direkt dargestellt. Bei Classic-Importen kennzeichnet
die Ansicht die versionierten Classic-Verfahrensregeln. Parallel-Ligen behalten
Meister plus bedingte Relegationsplätze; die unterste Liga nutzt den Nachrückerpool.
Internationale Plätze folgen dem ursprünglichen Champions-League-/UEFA-/
Pokalsieger-Cup-Verfahren. Nicht festgelegte Regeln bleiben als solche sichtbar.
Das sind keine heutigen UEFA-Regeln und kein neuer Saison-Simulator.
`editor_regulations` bietet dieselben Informationen schreibgeschützt über MCP.
## Kompilieren
Voraussetzungen entsprechen dem Hauptprojekt: C++20-Compiler, Git, CMake ≥ 3.24 und Ninja. Windows: Visual Studio 2022 C++ Build Tools / x64 Native Tools Prompt; macOS ARM: Xcode Command Line Tools, CMake und Ninja; Linux: GTK3-, X11- und OpenGL-Entwicklungspakete wie im Haupt-README. Windows nutzt Direct3D 11 mit automatischem WARP-Software-Fallback; Linux benötigt OpenGL 3.3, macOS OpenGL 4.1.
```sh
cmake -S . -B build-editor -G Ninja -DCMAKE_BUILD_TYPE=Release -DOPENBMH_BUILD_EDITOR=ON
cmake --build build-editor --target openbmh_editor editor_core_tests editor_comparison_tests editor_regulations_tests --parallel 2
ctest --test-dir build-editor -C Release -R '^editor_(core_tests|comparison_tests|regulations_tests|version)$' --output-on-failure
```
macOS ARM zusätzlich bei der Konfiguration: `-DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0`. Unter Windows das Argument nach `-R` ohne einfache Shell-Anführungszeichen verwenden. Der Editor wird beim normalen Spiel-Build standardmäßig nicht mitgebaut.
```sh
build-editor/OpenBMHEditor --demo
build-editor/OpenBMHEditor --headless --open world.obw --validate
build-editor/OpenBMHEditor --headless --open world.obw --output edited.obw
build-editor/OpenBMHEditor --serve --open world.obw --mcp-port 8765
build-editor/OpenBMHEditor --stdio-mcp --open world.obw
```
Weitere Argumente: `--settings datei.json`, `--assets verzeichnis`, `--commands script.json`, `--print-mcp-config`. Ein Command-Script ist ein Array aus `{"command":"…","args":{…}}`, mit denselben Kommandos wie die gemeinsame Session (z. B. `get`, `apply`, `save`). `--headless` startet kein Fenster. `--stdio-mcp` bietet dieselben Werkzeuge über newline-delimited JSON-RPC; stdout enthält dabei ausschließlich Protokollnachrichten. Testaufnahmen: `--screenshot bild.png --quit-after-ms 1800 --page clubs` (unter Linux mit Xvfb möglich).
Pakete baut `tools/package/make_editor_package.py --build build-editor --out dist --platform linux-x64` (oder `windows-x64`, `macos-arm64`). `--source-package` ergänzt den zugehörigen Quellcode mit den tatsächlich verwendeten, gepinnten Abhängigkeiten. Die CI **OBW Editor** baut und prüft alle drei Plattformen. Tags `editor-v<version>` erzeugen nach erfolgreicher Prüfung einen Release-Entwurf. Die nativen Tests unterscheiden sich von einem späteren menschlichen GUI-Test auf Windows/macOS.
## English quick start
Extract the complete package and run **OpenBMHEditor**. Open an OBW archive or an unpacked world, import a supported BMH/Football Limited installation, or open the synthetic demo. Use the sidebar, searchable/filterable list and property inspector; **Apply** records one shared, undoable transaction. **Save** writes only an **OBW 1.1 editor world**, not a playable Classic mod or a legacy installation.
Use **Comparison** to inspect sortable player, team and league ratings and per-season salaries. Select attribute columns and filter by country, league, club or attribute system. Group ratings are player-weighted means; salary totals and means use known player contracts only and explicitly flag incomplete coverage. Missing values remain unknown. The read-only MCP tool `editor_compare` returns the same data.
Use **Regulations** to inspect promotion, relegation, playoffs, international qualification and stored game rules. Explicit OBW declarations and versioned Classic policies are distinguished; missing rules stay unspecified. This page and `editor_regulations` are read only.
The editor retains full squads, original image data, source claims and unknown extensions. Its 24-player view does not remove players. Image import offers normalized crop, arbitrary rotation and mirroring; re-editing uses the preserved source. Classic portraits keep their frozen appearance recipe. Unsupported editing areas are preserved rather than replaced.
Click a crest, portrait, trophy or list thumbnail to open a large read-only image preview. **View asset** opens its linked asset record; composed Classic portraits without a single image file lead to the image library. Viewing preserves the world and pending property edits.
In **Options**, switch the interface to **English**, choose one of the three themes, and enable/disable the integrated local MCP server. **Copy connection** provides the authenticated configuration. The server defaults to loopback port 8765; use port 0 for a free port. GUI and MCP share the same world, validation and undo history. It supports MCP Streamable HTTP 2025-11-25/2025-06-18 and optional stdio mode. Use `expected_revision` for concurrent edits.
Build with the three commands above, including `-DOPENBMH_BUILD_EDITOR=ON`. Windows uses Direct3D 11 with automatic WARP software fallback. Linux requires OpenGL 3.3; macOS requires OpenGL 4.1, plus the documented platform development dependencies. Editor 0.5.3 is unsigned and does not bundle any real-world dataset or proprietary game assets.
-190
View File
@@ -1,190 +0,0 @@
# Engine split: Classic, Classic Extended and Modern
Status: **concept and migration plan**. It prepares one shared match engine under the season engines of three game variants. Nothing in this document changes the behaviour of the current release.
## 1. Goal
OpenBMH will offer three game variants:
| Variant | Data | Season engine | Interface | State |
|---|---|---|---|---|
| **Classic** | Imported from the user's BMH or FLTD installation (OBW `runtime:classic-v1`) | Classic: fixed calendar, 9 leagues, original competition structure and rules | Classic 320×200 bitmap interface | Essentially complete |
| **Classic Extended** | Classic data, optionally extended where the classic screens can show it | Working idea: Classic engine plus features **backported from Modern**, step by step (§4) | Classic bitmap interface, extended by hand per feature | Open; after Modern |
| **Modern** | New OBW data set (imported and extended, or own worlds) | Modern: generated calendar, data-driven leagues and competitions, playable foreign leagues, leagues larger than 12 teams | New high-resolution interface (RmlUi), designed for many leagues | Interface in progress |
All three use **the same match engine**. A match between two given teams under the same rules is simulated by the same code in every variant; only what happens around it (calendar, competitions, finances, transfers, development) differs.
### 1.1 Where a change belongs
- **Classic** receives changes that work with the imported original assets and the original data layout: bug fixes, quality of life, small rule corrections, menus such as the environment menu of a later DIAMOND release.
- **Modern** is where new features are designed first, without the limits of the original screens or data layout: more leagues, foreign leagues with more than 12 teams, a free calendar, new competitions and systems.
- **Classic Extended** takes Modern features back into the Classic engine **one at a time**, where the bitmap interface can present them with reasonable manual work. The classic screens were never designed for variable structures, so Classic Extended will never offer every Modern feature; each backport is a decision of its own (§4).
## 2. Target architecture
```
Classic UI (bitmap) Classic UI + extra screens Modern UI (RmlUi)
| | |
+---------------- app / protocol layer (capabilities) -------+
| | |
season: classic season: classic + backported features season: modern
(GameState image) (GameState image + extension state) (typed OBW model)
| | \ / |
| | shared feature modules |
| | (bmh_features, ports) |
+------------------ match adapter (per engine) --------------+
|
match engine (bmh_match: typed contract)
|
random sources, attribute set bmh-classic@1
```
### 2.1 Libraries
| Target | Contents | May depend on |
|---|---|---|
| `bmh_match` | Minute simulation, events, chances, cards, injuries during the match, substitutions, live interventions, the Reality scene and reporter | `random`, the match contract types; **not** `GameState`, calendar, finances |
| `bmh_season_classic` | Today's `src/game` without the match core: turn driver, weekly/monthly/season processing, cups, transfers, finances, post-match effects | `bmh_match`, `bmhcore` formats |
| `bmh_season_classic_ext` | Classic Extended: registry of backported features, their state and hook points in the Classic turn (§4) | `bmh_season_classic`, `bmh_features` |
| `bmh_features` | Season features written once for Modern and reusable by Classic Extended, each against small **ports** (interfaces) instead of a concrete state model | the match contract types only |
| `bmh_season_modern` | New season engine on the typed OBW model (§5) | `bmh_match`, `bmh_features`, `bmh_world` |
| `bmh_world` | Typed OBW model, reader/writer, validator (`src/content`, `src/import`) | `bmhcore` formats |
The dependency rules: **the match engine knows no season engine**; no season engine reaches into the state of another; **no season engine knows an interface**; a feature in `bmh_features` knows neither `GameState` nor the OBW model, only its ports.
### 2.2 Writing Modern features so they can be backported
Backporting is cheap only if a feature is written for it from the start:
- The rules of a feature (for example youth development, a staff system, sponsor negotiation) live in `bmh_features` and read and write the game only through a port: `PlayerRoster`, `ClubFinance`, `Calendar`, `Mailbox`, `RandomSources` and similar narrow interfaces.
- Modern implements the ports on the typed model. Classic Extended implements the same ports as adapters on `GameState` plus its extension state.
- A feature declares what it needs (ports, data fields, calendar events) and which presentation it needs (screens, messages). This declaration is the checklist for a backport: if the Classic adapter cannot provide a port, or no classic screen can show the result, the feature stays Modern-only.
- Features that depend on Modern-only structures (generated calendar, generic competition stages, leagues of variable size) are marked as such and are not candidates.
## 3. The match contract
Today the match core reads and writes the memory image directly: `MatchGroup` holds raw descriptors, and `matchday.cpp` mixes the minute loop with season effects (`finish_match`, `update_club_table`, `update_morale`, `develop_players`, `book_money`, `injure_player`, `rate_manager`). The split replaces this with typed input and output.
### 3.1 Input: `MatchdaySetup`
The contract works per **matchday batch**, not per single match: the original walks all match groups and all matches every minute, so the random numbers of different matches are interleaved. A batch keeps that order exactly for Classic; Modern may pass a batch of one.
```
MatchdaySetup
rules per group: competition kind (league, cup, friendly, indoor),
half length (45 / 20), stoppage, extra time, penalties,
away-goals and away-penalty flags, leg and first-leg score
groups[] matches[]: home TeamSheet, away TeamSheet, venue, spectators
random RandomSources (see 3.3)
live optional LiveControl (see 3.4)
TeamSheet
team id, side, players on the pitch and bench (player id, position, slot,
attributes of set bmh-classic@1, condition, form, morale, cards already held),
formation, tactic items, attitude, captain, penalty and free-kick takers,
automation flags (computer-controlled tactics)
```
Everything a match needs is copied into the setup. The engine does not look anything up.
### 3.2 Output: `MatchdayResult`
```
per match: final score per phase (regular, extra time, penalties), end minute,
event list (minute, kind, team, players: goal, assist, chance,
card, injury with severity, substitution, tactical change),
player ratings and statistics, side records (typed form of the
18 legacy record bytes), live-intervention log
```
The engine reports **facts**. Consequences belong to the season engine: league tables, money, morale, player development, suspensions counted per competition, injury duration in days, manager ratings, mail and press. Classic applies them exactly as today; Modern applies its own rules to the same facts.
### 3.3 Random numbers
The match engine draws only through an injected `RandomSources` interface with the two streams the original uses (`WatcomRandom`, `GameRandom`, see `docs/RNG.md`).
- Classic passes the session's global streams, so consumption order and regression results stay identical.
- Modern passes streams seeded per matchday (or per match) from the world seed, so a match can be replayed on its own.
### 3.4 Live matches
`LiveControl` is the only channel for human influence during a match: pause points (half time, events that request a lineup), substitutions, tactic and attitude changes, and the minute clock barrier of multi-client sessions. The Reality scene (`reality_*`) is a presentation of the same simulation and moves with the match engine. Interfaces receive match progress as events; none of them calls into the minute loop directly.
### 3.5 Attribute set
The match engine consumes players in attribute set `bmh-classic@1` (OBW §5.3). Classic already stores exactly this. Modern may keep richer attributes for its own systems, but provides a `bmh-classic@1` projection for every player it sends into a match. A later, finer match model would be a **new version** of the match engine with its own attribute set, selectable per variant; it is not part of this plan.
### 3.6 Versioning
`bmh_match` carries a contract version (`match@1`). Saves record the version they were played with. A behavioural change to the match engine is a new version, noted in `docs/DIFFERENCES.md`, and is checked against all three variants before it lands.
## 4. Classic Extended
> **Working idea, not a decision.** Backporting Modern features into the Classic engine is the current idea for Classic Extended; the variant may take a different shape. What does not depend on it: the shared match engine (§3), the Modern engine driven only through the protocol, and features written against ports (§2.2), which keep several options open.
Classic Extended is the **Classic season engine plus backported Modern features**, presented in the classic bitmap interface.
- **Invariant:** with every backported feature switched off, Classic Extended produces exactly the Classic results. A test runs the Classic regression through the Extended engine with no features.
- Each backported feature is a module with an id and version, its own state (`x-extended/` in OBW saves), the Classic adapters for its ports and its classic-style screens. A career records which features it uses; features can be switched on at career start and, where safe, later.
- Features hook into defined points of the Classic turn (start/end of day, week, month and season; before/after a matchday; desk actions), never into the middle of a Classic routine.
- **Data:** Classic Extended starts from Classic data. A feature may bring additional data, but only in a shape the classic screens can show. Structures that change the size of what the screens list (more or larger leagues, new competitions) are Modern-only unless a specific screen is redesigned for them.
- **Interface cost per feature**, the main factor in each backport decision:
1. The result fits existing screens (a new value on the player card, a message, a desk action): small.
2. A new screen of fixed size in the classic style (a staff or youth screen): medium, new own artwork needed.
3. A screen whose content grows with the data (longer tables, more league selectors, calendar views): large, often not worth it.
- **Assets:** the original bitmaps of the user's installation plus new classic-style artwork. New artwork must be the project's own.
- Order of work: a feature is built and settled in Modern first, then backported if its ports and its presentation fit (§2.2).
## 5. Modern
Modern is a new season engine on the typed OBW model (`docs/formats/OBW.md`):
- **Data set:** an OBW world that goes beyond the original structure, for example foreign leagues with more than 12 teams, more leagues (up to 32) and real-world competition formats. It can start from an imported Classic world and be extended, or be a world of its own.
- **Calendar:** generated each season from `world/calendar.json` (series, windows, events) instead of a fixed day table; any season start, international windows, winter breaks per nation.
- **Competitions:** the generic stage model (league, groups, league phase, knockout, playoff, final) with declarative slots and promotion/relegation; foreign leagues are playable, not only simulated.
- **Systems:** finances, transfers, contracts, youth, staff and development are rewritten on the typed model, reusing Classic formulas where they fit and documenting where they differ.
- **Interface:** the RmlUi client through the app/protocol layer only.
- Matches always go through the shared match contract (§3).
Modern does not have to reproduce Classic results; its quality gate is plausibility (seasons simulated in bulk, agentic QA, fan expectations), not bit equality.
## 6. Variant selection and saves
- The world or save manifest names the runtime: `requires: ["runtime:classic-v1"]`, `["runtime:classic-extended-v1"]` (with the list of active features and their versions) or `["runtime:modern-v1"]`, plus `match@1`.
- `CareerSession` selects the season engine from the manifest; the protocol reports **capabilities** per engine and feature, so interfaces and console clients only offer supported actions.
- Conversions are **one-way**: Classic → Classic Extended (switch features on), Classic or Classic Extended → Modern (convert to the typed model; backported feature state maps to the Modern original of the feature). There is no way back, and the original file is kept.
- **All variants save only in the OBW format** (`.obs`). Legacy `.FBM` saves are an import source only: they are converted into a Classic `.obs` career and never written.
## 7. Migration plan
Each step keeps the game playable and the Classic regression (`tools/regression/checkonly.sh`, season simulations, long runs) unchanged.
| Step | Content | Gate |
|---|---|---|
| 0 | Freeze the Classic baseline: tag, record regression outputs and long-run statistics as reference | Reference recorded |
| 1 | Move the match core (`match_engine`, `match`, `reality_*`, reporter) into `src/match` and target `bmh_match`; no behaviour change | Regression identical |
| 2 | Introduce `RandomSources`; the match core no longer touches the global streams directly | Regression identical |
| 3 | Typed `MatchdaySetup`/`MatchdayResult`; Classic adapter builds the setup from `MatchGroup`/`GameState` and writes results back; move post-match effects out of the minute loop into `bmh_season_classic` | Regression identical; match contract tests |
| 4 | Remove the remaining `GameState` dependencies from `bmh_match` (enforced by the build: `bmh_match` does not link `GameState`) | Build rule; regression identical |
| 5 | Runtime field in manifests, engine selection in `CareerSession`, capability reporting in the protocol | Classic unchanged; capability tests |
| 6 | `bmh_features` with the first ports; Modern season engine on `bmh_world`, first with one nation and the shared match engine, then the competition model, then foreign leagues and larger leagues | Modern plausibility runs |
| 7 | Classic Extended skeleton: feature registry, hook points, `x-extended` state, Classic adapters for the first ports, "no features = Classic" test | Regression identical through Extended |
| 8 | Backports one feature at a time, each with its interface cost assessed (§4) | Per feature: Classic regression with the feature off, plausibility with it on |
| 9 | Classic → Modern conversion of worlds and careers | Converted careers playable |
Steps 1 to 4 are the actual split and the risky part; they are pure refactoring and must be done in small commits with the regression after each. Classic improvements continue in parallel on `bmh_season_classic`.
## 8. Tests
- **Match contract tests:** a fixed `MatchdaySetup` with fixed seeds yields a fixed `MatchdayResult` (golden files with synthetic teams, public).
- **Classic regression:** unchanged scripts and expected outputs; run after every step.
- **Extended identity:** the Classic regression through the Extended engine with no features.
- **Feature tests:** each module in `bmh_features` is tested once against fake ports, then through both adapters (Modern and Classic Extended).
- **Modern plausibility:** bulk season simulations with goal, points and money distributions compared to Classic as a reference band.
- **Dependency checks:** the build fails if `bmh_match` includes season or `GameState` headers, if `bmh_features` includes `GameState` or OBW model headers, or if a season engine includes interface headers.
## 9. Open decisions
- Which features become the first backport candidates (proposal: features of interface cost 1 or 2 that do not change league structure).
- Whether Modern keeps `bmh-classic@1` as its only player attribute set at first (proposal: yes, richer attributes later as a new match engine version).
- Ownership: the split and Classic (engine/integration), the Modern interface (UI), Modern features and their backports (shared, per feature).
+12 -30
View File
@@ -1,38 +1,20 @@
# Roadmap
# Community maintenance roadmap
OpenBMH combines a playable reconstruction with a foundation for extension. These milestones describe direction and dependencies, not promised dates.
OpenBMH reconstructs the original Bundesliga Manager Hattrick experience using the player's own game data. Development priorities are compatibility, reliability and accessible community maintenance.
## 0.1: a usable engine
## 1.0 acceptance
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).
- Validate German CD-compatible BMH and supported Diamond installations, including career setup, management, matches and season transitions.
- Preserve original data and save layouts; document intentional bug corrections.
- Check Windows x64, macOS ARM64 and Linux x64 builds and publish matching source archives, licenses and checksums.
- Keep release limitations and reproducible defects visible in the issue tracker.
## 0.15: broader English compatibility
## Continued maintenance
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.
Prioritize reproducible gameplay, save, rendering, input and platform bugs. Keep improvements focused and cover unsafe state transitions with regression tests. Contributions should preserve the familiar interface and the supplied edition's content and competition structure.
## 0.2: portable Classic content and native saves
Football Limited remains experimental. Improvements require independent checks of its original loading, presentation, competitions, audio and save compatibility; German acceptance does not establish English acceptance.
Import a supplied BMH or Football Limited installation through the launcher into a
sealed [OBW](formats/OBW.md) Classic mod. Run the original-style interface and
console exclusively from converted content, with native careers and preferences
stored separately. Legacy save migration is an import operation. See the
[0.2 release notes](release/0.2/RELEASE_NOTES.md) and
[runtime contract](formats/obw/runtime-0.2.md).
The SDL2 graphical client and console share the game/session layer. Community clients and automation should use the documented [console interface](CONSOLE_CLIENTS.md) and retain its ownership and revision checks.
Modern game screens are deferred. The Modern UI POC remains separate from the
0.2 distribution. Replacing the remaining compatibility blocks with typed clubs,
players, contracts and competitions is subsequent work, not a completed 0.2 claim.
## 0.3: configurable rules
Expose rule values and balance choices as configuration, with reproducible simulations to assess changes. Improve tactical automation, transfer decisions and scoring distributions through documented changes rather than hidden edition-specific branches.
## 0.4: adaptable interfaces and competitions
Add a scalable interface (RmlUi) through the shared application/protocol boundary. Make league sizes and competition structures data-driven. Define content-pack formats for independently licensed artwork, names and other resources; do not distribute third-party material without permission.
## 0.5: independently distributable content
Provide original or freely licensed graphics, sound and generated football worlds so that OpenBMH can be played without proprietary game data. Support editors, new competitions and multiplayer clients built on the same engine interfaces.
The typed model and open format are prerequisites for flexible competitions, configurable rules and new content. See [architecture](architecture.md) for the current boundaries and [compatibility decisions](COMPATIBILITY.md) for intentional departures.
See [architecture](architecture.md), [compatibility decisions](COMPATIBILITY.md) and [contributing](../CONTRIBUTING.md) before changing shared behaviour. No proprietary game content belongs in public code, tests or releases.
+1 -32
View File
@@ -12,9 +12,7 @@ OpenBMH is a C++20 engine with graphical and console frontends. The implementati
| `src/ui` | View projections, rendering and input interpretation for game screens |
| `src/cli` | Command language, structured protocol, console windows and multi-client seat routing |
| `src/audio` | Bank decoding, synthesis, playback and cues, without authority to change gameplay |
| `src/launch` | RmlUI launcher, portable mod library, child processes and legacy installation discovery |
| `src/content` | Sealed OBW content, native career containers and personal preferences |
| `src/import` | Legacy installation and save-layout conversion; original readers are used here |
| `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.
@@ -26,8 +24,6 @@ Some calendar operations need synchronous human decisions. Their presenters own
## Calendar and matches
The planned split into one shared match engine and the season engines of Classic, Classic Extended (Classic plus backported Modern features) and Modern is described in [ENGINE_SPLIT](ENGINE_SPLIT.md).
The turn driver moves between manager desks, match clocks and calendar events. Weekly, monthly and seasonal processing can produce decisions as well as simulation results. Match groups contain the day's competitions; a manager can intervene only in a group involving that manager's team. A multi-client match clock advances at a barrier shared by all seats.
## Compatibility state
@@ -41,30 +37,3 @@ Legacy saves serialize blocks in a fixed order and store name pools separately.
The [console reference](CLI_CONCEPT/README.md) documents window commands. [protocol.md](protocol.md) describes structured requests, and [CONSOLE_CLIENTS.md](CONSOLE_CLIENTS.md) explains safe client ownership and batching. Prefer shared projections/actions when adding another frontend.
Use synthetic data for public tests and locally supplied installations only for data-dependent checks. Renderer tests, simulation tests and target-platform runtime checks answer different questions; document what each validates. See [CONTRIBUTING.md](../CONTRIBUTING.md).
## 0.2 content boundary
Normal GUI and console entrypoints accept sealed Classic OBW packages. `content::Mount`
owns a shared immutable decoded store; existing path-shaped UI aliases identify resources
inside it, without creating VGA/FNT/EXE files or falling back to an installation on disk.
The only mutable mount setting is the presentation year of the selected career. Native
`.obs` checkpoints serialize named fields, compatibility memory blocks, both random
streams, Reality residues and the manager-desk driver. No host object, pointer or callback
is dumped. The session reconstructs content pointers and callbacks when loading.
The RmlUI launcher remains the parent process. Each game starts in a fresh child process
of `OpenBMH`, keeping edition-specific process globals isolated. Portable mod content and
personal files have independent lifetimes. See [runtime-0.2](formats/obw/runtime-0.2.md).
The launcher layout and theme live in `assets/launcher/launcher.rml` and `theme.rcss`.
They share the same RmlUI core, FreeType font engine and SDL2 platform layer.
Windows uses the pinned upstream Direct3D 11 renderer with hardware-to-WARP
fallback, while Linux/macOS keep the upstream OpenGL renderer. Both the editor
and launcher share window/device lifetime, resizing and capture through
`src/launch/rml_video.*`. The C++ view translates events into the existing launcher
interface; it does not own conversion rules or mod storage. This presentation layer
can be reused by future modern screens. Classic game screens retain their current UI.
The operating system supplies the folder picker through nativefiledialog-extended.
Release packages contain the complete launcher asset directory and unmodified Lato
fonts from the pinned RmlUI source. Background artwork is independently generated;
its provenance and approved digest are recorded with the project assets.
+10
View File
@@ -1991,3 +1991,13 @@ declarations change. Game text, resort, image and audio fallbacks belong outside
| `EnglishSixTeamFixtureTable` | `0x6eed4` | English image adapter |
| `EnglishTwelveTeamFixtureTable` | `0x6f0bc` | English image adapter |
| `EnglishTwentyTeamFixtureTable` | `0x6ee40` | English image adapter |
## Verified edition-dependent parameters
| Field | Address | Use |
|---|---|---|
| `CalendarDateSetup` | `0x21270` | Verified date setup: weekday byte at +4, initial year dword at +13. Original CD uses 1995/Saturday; checked Diamond editions use 2026/Wednesday. |
| `ForeignBadgeGateInstruction` | `0x10070` | Verified original drawing gate; operand at +3 selects neutral foreign crests or individual W-sheet selectors. |
| `EnvironmentBudgetSteps` | `0xa50ff` | Six budget increments in the verified monthly environment implementation. |
Calendar presentation, engine weekday processing and save-list headers share the supplied installation's epoch. The original four-year date arithmetic is preserved; this reader does not substitute a different calendar system or rewrite the installation. Unknown date setup instructions and invalid values are rejected.
-571
View File
@@ -1,571 +0,0 @@
# OBW: OpenBMH world, save and pack format
## Implemented profiles
| Profile | Format | Reader/writer | Playable |
|---|---|---|---|
| `classic-installation-v1` | OBW 1.0, `runtime:classic-v1` | Complete BMH/FLTD converter; OpenBMH 0.2 launcher, GUI and console | Yes, sealed Classic content |
| `editor-world-v1` | OBW 1.1, `editor:world-v1` | OpenBMH Editor 0.5: OBW/unpacked worlds and legacy import, OBW-only saving | No; editable start database |
| `legacy-database-v1` | OBW 1.0 development export | Converter's explicit `--database-only` option | No; partial legacy export |
`openbmh_import` produces `BMH-classic` and `FLTD-classic` worlds including
startup inputs, media and frozen portrait recipes. The
[import guide](obw/import.md) distinguishes them from the partial development
export. OpenBMH 0.2 reads the sealed content without the original installation
and writes separate native career checkpoints; see the
[runtime contract](obw/runtime-0.2.md).
The [1.1 editor profile](obw/editor-v1.md) adds editable worlds without relaxing
Classic seals. Opening Classic content in the editor preserves its sources;
saving creates an editor world rather than a newly sealed Classic world.
Names such as “Modern” are display names, not proof of runtime compatibility.
A modern-season data package can be structurally valid and fully editable while
its competition/season engine is still pending. See [the editor guide](../EDITOR.md).
The sections below define the general format and distinguish implemented
profiles from future capabilities. Generic calendar/rule authoring, modern
season simulation, network play and generic world-to-career generation are
not implemented merely because their data structures are documented here.
## 1. Goals and non-goals
Goals:
- One documented, versioned format for a game world (start database), a running career (save) and content packs.
- A typed model of nations, clubs, players, staff, contracts, finances and competitions that no longer depends on the memory image of a particular executable.
- Data-driven competitions: up to **32 leagues** (national and foreign leagues together), real-world European club cups (league phase plus knockout), and national-team competitions including qualification and a Nations-League-style tiered competition.
- Import from the supported German editions and from Football Limited (FLTD), both for a new career and for an existing `.FBM` save.
- Preparation for a high-resolution interface built with RmlUi: logical asset keys, high-resolution crests and icons, player photos, further languages and modern font formats.
- Forward compatibility: readers of the same major version accept files written by later minor versions.
Non-goals of version 1.0:
- The match engine and its parameters (reserved namespace `x-matchengine`, see §3.3).
- Network play and a binary encoding (reserved, see §2.4). The separate editor
uses the additive 1.1 profile described above.
- Layout or screen data. Interfaces are themes (§9.6), not part of a world.
## 2. Container and files
### 2.1 Container
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents and referenced binary assets. The 1.1 editor reader also supports ZIP64, with its own documented size limits. The versioned Classic extension additionally permits data-only compatibility regions and startup input records; it does not permit executable code or save state in a world. The readers use miniz for the container; the editor additionally uses its declared JSON/image dependencies. Generic editor JSON remains editable by hand or script; sealed Classic packages must retain their original bytes and seals.
| Extension | `kind` | Contents |
|---|---|---|
| `.obw` | `world` | Start database: everything needed to begin a career |
| `.obs` | `save` | A world plus the running state of a career |
| `.obp` | `pack` | Overlays and assets for worlds (names, crests, photos, texts) |
| `.obt` | `theme` | Interface theme for the RmlUi client (§9.6) |
An unpacked directory with the same layout is accepted wherever an archive is, which keeps development and version control simple.
### 2.2 Layout
```
manifest.json required, §3
world/nations.json nations and their national teams
world/clubs.json clubs (teams of type "club")
world/players.json players
world/staff.json managers, coaches, other staff
world/stadiums.json stadiums
world/contracts.json player and staff contracts
world/finance.json club finances, sponsors, advertising, loans, shares
world/competitions.json competition definitions, §6
world/calendar.json season calendar, §7
world/rules.json rule values (training camps, interest rates, ...)
state/... save only, §5.9
locale/<lang>/*.po texts, §9.3
assets/... local Classic worlds, packs and themes, §9
x-<name>/... extensions, §3.3
```
Every table file is an object `{"schema": "<table>@<major>.<minor>", "items": [...]}`. Tables with many rows (results, history, mail) may instead be stored as JSON Lines (`*.jsonl`, one item per line, first line the header object without `items`).
### 2.3 Encoding rules
- Text is UTF-8. Legacy single-byte text is converted on import (`iso646de_to_utf8`).
- Money is an integer in the smallest unit of the world currency (`manifest.currency`, e.g. `{"code": "DEM", "minor_units": 0}`); no floating point for money.
- Dates are ISO 8601 calendar dates (`"1995-07-01"`), in-game time is a date plus an optional `"minute"`.
- Percentages and ratings are integers on the scale declared by their attribute set (§5.3).
- Optional fields may be omitted; the schema gives their default.
### 2.4 Reserved
A compact binary encoding of large `state/` tables is reserved for a later minor version as an alternative representation of the same schema (`"encoding": "cbor"` in the table header). Readers of 1.0 reject unknown encodings with a clear error.
## 3. Versioning and migration
### 3.1 Manifest
```json
{
"format": "openbmh-world",
"format_version": "1.0",
"kind": "world",
"min_reader": "1.0",
"generator": "OpenBMH 0.2.0",
"created": "2026-10-17",
"title": {"default": "Season 1995/96"},
"provenance": "import:bmh-de",
"content_license": "local-import-only",
"currency": {"code": "DEM", "minor_units": 0},
"start_date": "1995-07-01",
"languages": ["de"],
"limits": {"leagues": 32},
"requires": [],
"extensions": []
}
```
- `format_version` is `major.minor`. A **minor** step only adds optional fields, tables, enum values that have a documented fallback, or new stage types guarded by `requires`. A **major** step may rename, remove or re-interpret fields.
- `min_reader` is the lowest reader version that can use the file correctly (a writer raises it when it uses a minor feature without a safe fallback).
- `requires` lists features without which the file cannot be played, e.g. `["stage:swiss"]`; a reader that lacks one refuses the file instead of guessing.
- `provenance` records where the content came from: `native`, `import:bmh-de`, `import:bmh-de-classic`, `import:fltd`, or `pack:<id>`. `content_license` is free text or an SPDX identifier; `local-import-only` marks data converted from a user's own installation (§8.4).
### 3.2 Reading and migration
- Readers ignore unknown fields and tables, keep them in memory and write them back unchanged (round trip), so a newer minor version survives an older tool.
- Missing optional fields take the schema default.
- Older major versions are upgraded on load through a chain of migrations (`migrate_1_to_2`, `migrate_2_to_3`, ...). Writers always write the newest version; a migrated save is written under a new name unless the player confirms the upgrade.
- Each table carries its own `schema` version, so a table can advance a minor step independently; the manifest version is the highest of them.
### 3.3 Extensions
Fields and directories whose name starts with `x-` belong to extensions (`x-matchengine`, `x-realnames`, `x-editor`). The core never interprets them, preserves them on round trip and lists active ones in `manifest.extensions` with a version, e.g. `{"id": "x-matchengine", "version": "1.0"}`.
### 3.4 Schemas
Each format version is published as JSON Schema (draft 2020-12) under `docs/formats/obw/schema/<major>.<minor>/`, one file per table. The schemas are the machine-readable specification and the basis of the validator (§10).
The schemas describe the intermediate `legacy-database-v1` profile and the completed `classic-installation-v1` content profile. The latter requires `runtime:classic-v1`: it contains initialization policies and data-region compatibility fields in addition to typed projections. A generic OBW reader cannot execute those fields without the Classic adapter. Save, pack, theme and fully generic playable-world schemas remain future work. Optional fields and unknown extensions remain allowed.
## 4. Identifiers and names
- Every entity has a stable string id `<type>:<key>`, e.g. `nation:de`, `club:0042`, `player:01873`, `comp:de-1`, `stadium:0042`. Keys are opaque: they never encode a real name, so a world and a pack can be published independently.
- Ids are unique within a world and never reused within a save. The engine assigns runtime indices; files never store them.
- Nation keys use ISO 3166-1 alpha-2 where one exists, otherwise a documented private key (`nation:x-eng` for England, `nation:x-sco`, ...).
- Every displayed name is a localized string: `{"default": "...", "en": "...", "short": {"default": "..."}}`. `default` is required; a language entry overrides it; `short` and `abbr` are optional display variants for narrow layouts.
- Packs overlay names, crests and photos by id (§9.5), never by position.
## 5. Entities
Field lists name the type and whether the field is required (R) or optional (O, with default). Only the main fields are listed; the schema is authoritative.
### 5.1 Nation (`world/nations.json`)
| Field | Type | | Meaning |
|---|---|---|---|
| `id` | string | R | `nation:<key>` |
| `name` | localized | R | |
| `confederation` | string | R | `uefa`, `conmebol`, `caf`, `afc`, `concacaf`, `ofc`, `other` |
| `coefficient` | integer | O 0 | Club-competition ranking points (§6.6) |
| `strength` | integer | O 0 | Rating of the national team when no squad is simulated |
| `national_team` | string | O | Team id of type `national` (§5.2) |
| `playable` | bool | O false | Whether its leagues are simulated in full |
### 5.2 Team (`world/clubs.json`)
Clubs and national teams share one entity type, distinguished by `type`.
| Field | Type | | Meaning |
|---|---|---|---|
| `id` | string | R | `club:<key>` or `nt:<nation key>` |
| `type` | enum | R | `club`, `national`, `amateur` (newcomer pool), `foreign` (strength only) |
| `name` | localized | R | |
| `nation` | string | R | |
| `stadium` | string | O | |
| `colors` | array | O | 1 to 3 `#rrggbb` values, used for generated crests and kits |
| `reputation`, `fans`, `strength` | integer | O | Club values on the attribute scale of the world |
| `founded` | integer | O | Year |
| `crest` | string | O | Asset key, default `asset:club/<key>/crest` (§9.1) |
| `x-*` | any | O | Extensions |
Teams without a squad (`foreign`, or `national` in a world that does not simulate national squads) carry `strength` instead of players.
### 5.3 Player (`world/players.json`)
| Field | Type | | Meaning |
|---|---|---|---|
| `id` | string | R | |
| `name` | object | R | `{"first": "...", "last": "...", "known_as": "..."}`, each a plain string; `known_as` optional |
| `born` | date | R unless `age_at_start` | Age is derived from the in-game date |
| `age_at_start` | object | Alternative to `born` | `{"years": 22, "on": "2026-07-01"}` when a legacy database gives an age but no exact birth date. Never invent a birthday. A consumer must explicitly support this precision. |
| `nationalities` | array | R | Nation ids, first entry is the sporting nationality (national-team eligibility) |
| `positions` | array | R | `gk`, `def`, `mid`, `fwd` in the classic set; finer positions in later attribute sets |
| `foot` | enum | O | `left`, `right`, `both` |
| `attribute_set` | string | O world default | e.g. `bmh-classic@1` |
| `attributes` | object | R | Values named by the attribute set, e.g. `{"strength": 7, "technique": 5, "condition": 9, "form": 6}` |
| `character` | object | O | Traits the attribute set defines |
| `team` | string | O | Current team id; absent for free agents |
| `squad_number` | integer | O | |
| `status` | object | O | Injury, suspension and card counters per competition (save only) |
| `photo` | string | O | Default `asset:player/<key>/photo` |
| `appearance` | object | O | Recipe of a composed portrait, see below |
**Composed portraits.** The original game stores no picture per player: it seeds a small random generator from the player's name and picks one of four backgrounds and one part for each of five layers from a parts sheet of the installation. OBW stores the outcome as a recipe instead of an image:
```json
"appearance": {"set": "bmh-classic@1", "background": 2, "layers": [5, 0, 3, 7, 1]}
```
- `set` names a portrait part set; it defines the number of backgrounds, the layers, the number of parts per layer and their placement. `bmh-classic@1` is the set of the original game.
- The importer computes the recipe once from the legacy name and **freezes** it. A later rename (for example by a name pack) keeps the face; the legacy name-derived generator is never re-run.
- Players created in OpenBMH (youth, generated players) receive a random recipe of the world's default set.
- The recipe holds indices only. The part graphics come from the user's installation or from a pack that provides the same set, possibly in higher resolution (§9.2), so a recipe does not embed a composed face. A local Classic import may include the original part set as local-only assets; distributable worlds need separately licensed artwork.
An attribute set is declared once in `world/rules.json` with its fields, scales and meaning, so a later, finer model can sit next to the classic one without breaking the format:
```json
{"id": "bmh-classic@1", "fields": {
"strength": {"min": 1, "max": 10},
"technique": {"min": 1, "max": 10},
"condition": {"min": 0, "max": 100},
"form": {"min": 1, "max": 10}}}
```
The exact list and scales of `bmh-classic@1` are fixed when the importer is written, from the fields the current engine uses (`Player` in `src/game/state.hpp`).
### 5.4 Staff and managers (`world/staff.json`)
Managers (human or computer), coaches and other employees: `id`, `name`, `born`, `nation`, `role` (`manager`, `coach`, `physio`, ...), `team`, `attributes`. In a save, `state/managers.json` adds the human manager profile: options, ratings, history, automation settings.
### 5.5 Contracts (`world/contracts.json`)
`id`, `person` (player or staff id), `team`, `start`, `end`, `salary` (money per season), `bonuses` (signing, per goal, ...), `release_clause` (O), `options` (O). One active contract per person and team; the history is kept in the save.
### 5.6 Stadiums (`world/stadiums.json`)
`id`, `name`, `capacity` split by area (`standing`, `seated`, `boxes`), `facilities` (floodlights, heating, scoreboard, ... as named levels), `pitch`, `owner` (team id or `null`).
### 5.7 Finance (`world/finance.json`)
Per team: balance, ticket prices, sponsors (shirt, boards, with duration and value), advertising, loans (amount, rate, due date), shares and other income or cost sources the engine models today. Rate tables such as the credit table live in `world/rules.json`.
### 5.8 Rules (`world/rules.json`)
Named rule values that are content of the world rather than of the engine: training-camp resorts (price, quality grades), credit-rate tables, attribute sets, points for a win, squad limits. Today these values are read from the executable of the selected edition; in OBW they are ordinary data (and the starting point of the configurable rules of roadmap 0.3).
### 5.9 Save state (`state/`, saves only)
| File | Contents |
|---|---|
| `state/career.json` | Current date, season, phase, active human managers, settings |
| `state/rng.json` | State of the random generator(s) (`docs/RNG.md`), so a load continues deterministically |
| `state/tables.json` | Standings per competition stage and group |
| `state/results.jsonl` | Every played or scheduled match: competition, stage, round, home, away, result, after extra time / penalties |
| `state/squads.json` | Lineups, formations, tactics per team |
| `state/history.jsonl` | Season history: champions, cup winners, top scorers, records |
| `state/mail.jsonl` | Messages and news |
| `state/market.json` | Transfer list, open bids, loan offers |
| `state/x-legacy.json` | Unmapped legacy values carried over by the importer (§8.3) |
## 6. Competitions
### 6.1 Model
A competition is an ordered list of **stages**. Each stage takes teams from **slots** (§6.4), plays a format and hands teams on (to the next stage, to another competition, or to a final ranking).
```json
{
"id": "comp:de-2",
"name": {"default": "2. Liga"},
"type": "league",
"nation": "nation:de",
"tier": 2,
"trophy": "asset:comp/de-2/trophy",
"season_cycle": 1,
"stages": [{
"id": "regular",
"format": "league",
"teams": 18,
"legs": 2,
"points": {"win": 3, "draw": 1, "loss": 0},
"tiebreakers": ["points", "goal_difference", "goals_for", "head_to_head", "draw_lots"],
"matchdays": "calendar:league-weekends"
}],
"movement": [
{"ranks": [1, 2], "to": "comp:de-1"},
{"ranks": [3], "to": "comp:de-1/playoff", "role": "challenger"},
{"ranks": [16, 18], "to": "comp:de-3"}
]
}
```
`type` is `league` (counts towards the league limit), `cup` (national cup), `club_international`, `national_team`, `friendly` or `indoor`.
### 6.2 Stage formats
| Format | Purpose | Main parameters |
|---|---|---|
| `league` | Round robin | `teams`, `legs` (1, 2, n), `points`, `tiebreakers`, fixture generator |
| `groups` | Several round robins | `groups`, `teams_per_group`, `legs`, seeding `pots`, draw constraints (e.g. no two teams of one nation) |
| `swiss` | League phase with a fixed number of games against drawn opponents | `teams` (e.g. 36), `matches` (e.g. 8), `pots`, `home_away_balance`, one common table |
| `knockout` | Ties | `legs` (1 or 2), `seeded`, `draw` (`open`, `seeded`, `bracket`), `extra_time`, `penalties`, `away_goals` (on/off), `neutral_venue`, `replay` (FA-Cup style) |
| `playoff` | Ties between teams of different competitions (relegation, qualification) | as `knockout` plus the roles of the participants |
| `final` | Single match or final tournament | `venue`, `teams` |
Common stage parameters: `extra_time` (minutes), `penalties`, `suspensions` (cards that lead to a ban, counted per competition or per stage), `substitutions`, `squad_registration` (size, home-grown quota), `prize_money` per round and result, `tv_money`, `gate_split`. New formats are added through a minor version with an entry in `manifest.requires`.
### 6.3 Fixture generation
A `league` or `groups` stage names a generator: `"generator": "round-robin"` (circle method, home/away balanced) works for every size. The legacy round tables of the original game remain available as `"generator": "legacy:<teams>"` for imported worlds, so imported careers keep their familiar order; they come from the user's installation, not from the format.
### 6.4 Slots and qualification
Participants are declared, not hard-coded:
```json
"slots": [
{"from": "comp:de-1", "ranks": [1, 4], "stage": "league-phase"},
{"from": "comp:de-cup", "winner": true, "to": "comp:uel", "stage": "league-phase",
"fallback": {"from": "comp:de-1", "next_unqualified": true}},
{"from": "coefficient", "nation_rank": [1, 4], "places": 4},
{"holder": "comp:ucl", "stage": "league-phase"}
]
```
A slot source is: a rank range of a stage, the winner/runner-up of a competition, the holder of a title, the next team not yet qualified (substitution rules), a coefficient ranking, or an explicit list. The engine resolves all slots at season end in the order given by `world/calendar.json`.
### 6.5 League pyramid
`movement` on a league connects tiers: promotion, relegation and playoffs between two leagues, several parallel lower leagues feeding one league (the two regional third divisions of the German editions), and a refill pool for the lowest tier (`"refill": {"from": "pool:amateur", "count": 2}`). This replaces the fixed per-edition tables in `src/game/schedule.hpp` (`kLeagueRelegation`, `kLeagueEurope`, `kGroupBelow`, `kNewcomerFirst`).
### 6.6 Coefficients
`world/rules.json` may define coefficient rankings (club and nation) with the points per result and per round reached and the number of seasons summed. They drive seeding pots and the number of European places per nation. A world may instead fix places per nation (`"places": {"nation:de": {"ucl": 4, "uel": 2}}`), which is how imported legacy worlds start.
### 6.7 Templates
The project ships competition templates under `docs/formats/obw/templates/`. They contain structure only, with neutral names:
- **Club competitions:** a champions cup with a 36-team league phase, a knockout playoff for places 9 to 24, round of 16 to final; a second and a third club cup in the same shape; a super cup; the knockout-only cups of the original game.
- **National teams:** a world cup with continental qualification groups and playoffs, a continental championship with qualification, and a **tiered nations league**. The nations league has leagues A to D with groups of three or four, promotion and relegation between tiers, a final tournament for the group winners of A, and playoffs that can feed continental-championship places.
- **National cups and side competitions:** knockout national cups (with or without replays and a qualifying round), an indoor tournament, friendlies.
### 6.8 National teams
A world that simulates national teams gives each `national` team a call-up rule: squad size, eligibility through `nationalities[0]`, selection by attribute set (best `n` by position) or by a human manager. International windows in the calendar (§7) suspend club play when the world asks for it (`"club_break": true`). Worlds without national squads use `strength` and simulate only results.
## 7. Calendar
`world/calendar.json` describes a season as dated events, independent of the executable's day table:
```json
{
"season_start": "07-01",
"season_length_days": 365,
"windows": [
{"id": "summer-transfer", "type": "transfer", "from": "07-01", "to": "08-31"},
{"id": "intl-sep", "type": "international", "from": "09-02", "to": "09-10", "club_break": true}
],
"series": [
{"id": "league-weekends", "weekday": "sat", "from": "08-08", "to": "05-20", "skip": ["winter-break", "intl-*"]},
{"id": "ucl-league-phase", "weekdays": ["tue", "wed"], "dates": ["09-16", "09-30"]}
],
"events": [
{"date": "06-30", "action": "season_end"},
{"date": "01-05", "action": "training_camp_window"}
]
}
```
Dates are month-day within the season; the engine maps them to concrete days each year, including leap years and seasons whose first day falls on a different weekday (the cases fixed in the current calendar code). Stages refer to a series by id. Imported worlds receive a calendar generated from the edition's day table, so the familiar rhythm stays.
## 8. Import from BMH and Football Limited
### 8.1 Sources
The importer (planned module `src/import/`) reuses the existing loaders:
| Source | Loader | Result |
|---|---|---|
| Master database `M3D.MAN` / `M3E.MAN` | `src/formats/m3d.cpp` | Clubs, players, staff, stadiums |
| Executable tables (league sizes, ladders, calendar, fixture tables, rule values) | `src/formats/le.cpp`, `src/launch/fltd.cpp`, `src/game/schedule.hpp` installers | Competitions, calendar, rules |
| Text database `TEXTD.BLK` / `TEXTE.BLK` | `src/formats/textd.cpp` | Local language layer `de-original` / `en-original` |
| Save `*.FBM` | `src/formats/fbm.cpp`, `savestate.cpp` | `state/` of a save |
| Crests and pictures `*.VGA`, `WAPPEN.LBM` | `src/formats/vga.cpp` | Low-resolution fallback assets, local only |
Edition detection is the one the launcher already performs (`src/launch/game_data.cpp`).
### 8.2 Mapping per edition
The standalone converter and its Classic contract are documented in [the edition mapping](obw/import.md) and [Classic v1](obw/classic-v1.md). The core league mapping is:
| Legacy league | German editions | Football Limited | OBW |
|---|---|---|---|
| 0 | 1st division, 18 teams | 1st division, 20 teams | `comp:<n>-1`, tier 1 |
| 1 | 2nd division, 18 | 2nd division, 20 | tier 2 |
| 2, 3 | Two parallel third divisions A and B, 18 each, one promotion group | 3rd and 4th division, 20 each | tier 3 (two leagues) / tiers 3 and 4 |
| 4 | Fourth tier, 18 | Fifth league, 10 teams, not played | tier 4 / tier 5 with `"played": false` |
| 5-8 | Four foreign leagues of 12 | Same four foreign leagues of 12 | `comp:<nation>-1` each, `nation.playable = true` |
| Newcomer pool | 30 amateur clubs | 12 further named clubs | `pool:amateur` |
Cups, European cups, the indoor tournament, the English FA Cup with its qualifying stage and the League Cup become competitions with the same rules the engine applies today. Relegation places, European places and promotion groups are taken from the installed tables (`kLeagueRelegation`, `kLeagueEurope`, `kGroupBelow`), not re-typed by hand.
### 8.3 Fidelity
The complete `classic-installation-v1` importer preserves all installation content without starting a career. Typed projections are complemented by the versioned `x-classic` startup contract and data-only regions, including original and effective rules. Installation tests reconstruct from OBW and compare first-season initialization bytes and both RNG streams with the existing loader. They do not establish a released OBW frontend or save continuation. The optional `--database-only` intermediate profile remains explicitly non-playable. `state/x-legacy.json` is reserved for converted saves.
- A new career imported from an installation must produce the same first season in the engine as the legacy start (same fixtures, same participants), verified by the regression runs.
- A converted `.FBM` must continue with the same results as the legacy save for a fixed number of turns.
- Values the typed model does not yet understand go to `state/x-legacy.json` with their legacy name, so nothing is lost while the model grows area by area.
### 8.4 Rights
Imported content stays on the player's machine. The importer marks it `"provenance": "import:..."` and `"content_license": "local-import-only"`; tools refuse to bundle such a world into a distributable pack. Only worlds and packs with their own licence may be shared.
## 9. Assets, languages, fonts and the RmlUi interface
### 9.1 Asset keys
Data never refers to file paths. It uses logical keys:
| Key | Meaning |
|---|---|
| `asset:club/<key>/crest` | Club crest |
| `asset:club/<key>/kit/home` | Kit |
| `asset:player/<key>/photo` | Player photo |
| `asset:staff/<key>/photo` | Staff photo |
| `asset:comp/<key>/logo`, `asset:comp/<key>/trophy` | Competition logo and trophy |
| `asset:nation/<key>/flag` | Flag |
| `asset:stadium/<key>/image` | Stadium picture |
| `asset:icon/<name>` | Interface icon |
**Competition trophies.** Every competition type may set the optional string
`trophy` to a logical key `asset:comp/<key>/trophy`. The key is stable and opaque;
it may be shared by several competitions, and never embeds a season, localized
name, file path, URL or runtime index. `<key>` is a nonempty sequence of ASCII
letters, digits, `.`, `_` or `-`, excluding `.` and `..`. A competition without
the field uses `asset:comp/<competition key>/trophy`, where the competition key is
its `id` without `comp:`. This also applies to additional foreign leagues and
international competitions; a fixed competition list is not part of the format.
Resolve that key from active packs by priority, then the world. If unavailable,
resolve `asset:comp/generic/trophy` through the same sources, then use the
client's built-in neutral trophy icon. The generic key is reserved for this
fallback. A missing trophy never prevents a competition from being played.
An invalid explicitly supplied key is an input error, not a request to guess a
file path. File presence is not mandatory because a pack or theme may supply
the image later. Asset-index metadata and rights requirements still apply.
Trophies are presentation only; they do not identify competition rules, stages
or historical winners.
This optional-field clarification remains compatible with 1.0 worlds: old
documents omit it, older readers ignore it, and no new `requires` feature is
needed. Classic converters emit the conventional per-competition key without
fabricating a trophy image or changing the original local media inventory.
### 9.2 Resolution and image formats
A resolver looks a key up in the active packs by priority (§9.5), then in the world, then falls back: original low-resolution graphics of the installation where one exists, a crest generated from `colors`, a silhouette for photos, a neutral icon.
- **Crests, logos, flags, icons:** SVG preferred (scales to every resolution). Otherwise PNG with alpha in size steps 64, 128, 256 and 512 px (`crest@128.png`). The resolver picks the smallest step not below the requested size.
- **Photos:** PNG, JPEG or WebP, aspect 3:4, reference size 300×400 px, larger allowed. Faces centred; the interface crops, it never stretches.
- **Pictures** (stadiums, backgrounds): PNG, JPEG or WebP, 16:9 reference 1920×1080.
- **Trophies:** SVG or PNG/WebP with alpha, preserving the full object and native
aspect ratio. A transparent generic trophy may be provided under the reserved
fallback key. No real trophy artwork is bundled by the format specification.
Asset metadata sits next to the files in `assets/index.json`: key, files per size, author, source and licence (required).
**Optional visual defaults (1.1).** A world may set
`manifest.presentation: "assets/presentation.json"`. The referenced document has
`schema: "asset-presentation@1"`, an optional `player_photo_fallback` asset key,
`trophy_fallback` (normally `asset:comp/generic/trophy`), and
`youth_photos: {assets: [<photo keys>], selection: "random-on-creation",
fallback: <photo key>}`. All keys resolve through the normal asset index. A
client supporting youth creation chooses once using its saved game RNG and
persists the selected key; it does not reroll a face on display or rename. This
document supplies pictures, never player records, ratings or generation rules.
Readers without this optional feature retain it and use their existing visual
fallbacks. The current editor preserves it without generating youth players.
An explicitly indexed player `photo` is displayed before composing a retained
`appearance` recipe. A visual overlay can therefore keep Classic appearance and
all game data intact while displaying a supplied photo or silhouette. Sealed
Classic rendering and runtime capabilities are unaffected.
**Player pictures** (`asset:player/<key>/photo`) resolve in this order:
1. A photo from an active pack.
2. The player's `appearance` recipe composed from a high-resolution part set (`assets/portrait-sets/<set>/` in a pack, same indices and layer order as the original set, with its own placement table for the larger size).
3. The same recipe composed from the original parts of the installation, scaled up.
4. A neutral silhouette.
Composed pictures may be cached in the user's cache directory; they are never written into a world, save or pack.
### 9.3 Languages
- Interface texts use gettext `.po` files under `locale/<lang>/openbmh.po` (`msgctxt` for context, plural forms, mature translator tools such as Poedit and Weblate). Message ids are stable English keys.
- Data names are localized strings inside the tables (§4); packs can add languages to them.
- The original text databases are imported into a local layer `de-original` or `en-original`, which the classic interface uses. New interfaces use the project's own texts.
- A fallback chain is configured by the player, e.g. `["en-GB", "en", "de"]`.
- Text is shaped as Unicode (RmlUi supports it); no single-byte substitutions outside the legacy layer.
### 9.4 Fonts
- TrueType and OpenType (`.ttf`, `.otf`); RmlUi renders them through FreeType. Variable fonts are allowed.
- A theme declares font families with weights, a fallback chain covering the languages it claims, and the licence of every font file (for example SIL OFL).
- The original bitmap fonts stay for the classic interface only.
### 9.5 Content packs (`.obp`)
```json
{
"format": "openbmh-world",
"format_version": "1.0",
"kind": "pack",
"id": "pack:example-crests",
"title": {"default": "Example crests"},
"targets": [{"world_provenance": "import:bmh-de"}],
"priority": 100,
"content_license": "CC-BY-4.0",
"overlays": ["names", "assets", "locale"]
}
```
- A pack contains `overlay/<table>.json` files with partial entities by id (only the fields it changes), `assets/` and `locale/`.
- Several packs stack; the higher `priority` wins per field and per asset key. A pack may not add or remove entities in 1.0 (that is a world, not a pack), which keeps saves valid when a pack is removed.
- `targets` restricts a pack to worlds by provenance or world id.
- The project distributes only the format, tools and its own or freely licensed material. Packs with real names, crests or photos are made and shared by their authors under their own responsibility. The team's internal real-name pack uses this format and stays private.
### 9.6 RmlUi themes (`.obt`)
- A theme contains `.rml` documents, `.rcss` style sheets, fonts, icons and its `locale/` texts, plus a manifest naming the client version it targets.
- Interfaces bind to a **view model**, not to the world files. The client exposes data models (RmlUi data bindings) built from the application/protocol layer (`docs/protocol.md`), with ids and asset keys as values. RmlUi loads images through a file interface that resolves `asset:` keys (§9.2).
- Neither worlds nor packs contain layout, so a theme works with every world, and the classic 320×200 interface keeps working next to it.
## 10. Validation and limits
The validator (planned `openbmh_cli --validate <file>`) checks, in this order:
1. Container, manifest, `format_version`, `min_reader`, `requires`.
2. Every table against its JSON Schema.
3. References: every id used exists and has the right type; no id is defined twice.
4. Competition logic: slot counts match stage sizes; movements between tiers are balanced; every stage can be scheduled in the calendar; fixture generators exist for the sizes.
5. Engine limits declared in `manifest.limits` and enforced by the engine of a version. For 1.0:
| Limit | Value |
|---|---|
| Competitions of type `league` (national and foreign) | **32** |
| Teams per league | 4 to 24 |
| Squad size per team | engine maximum of the attribute set |
| Groups per stage | 16 |
The format itself has no fixed limits; a later engine raises them by changing `limits` and its own checks, without a format change.
Errors name the file, the JSON path and the rule (`clubs.json: items[41].stadium: unknown id stadium:0999`).
## 11. Implementation steps
| Step | Roadmap | Content |
|---|---|---|
| 1 | 0.2 | Schemas 1.0, reader/writer, validator, round-trip tests with synthetic worlds |
| 2 | 0.2 | Importer for German editions and FLTD into `.obw`; adapter OBW → current `GameState`; regression: same first seasons |
| 3 | 0.2 | `.FBM` → `.obs` conversion and native OBW saves; area by area the engine reads typed data instead of the memory image (clubs, players, contracts, finances, then competitions) |
| 4 | 0.3 | `rules.json` drives the rule values; balance changes as data |
| 5 | 0.4 | Generic competition engine (stage formats, slots, pyramid, variable league sizes up to the limits); templates for the real-world club cups and national-team competitions |
| 6 | 0.4 | Asset resolver, packs, `.po` languages, RmlUi client with themes |
| 7 | 0.5 | Own worlds that need no original data |
Each step keeps the game playable and the regression runs green; the legacy formats stay readable as import sources.
-1
View File
@@ -19,7 +19,6 @@ Unless a page says otherwise, integer fields are little endian. Legacy strings u
| Audio containers | `S/2000` through `S/2003` | [SOUND](SOUND.md) | `src/audio/container.cpp`, `original.cpp` |
| Executable data | German LE and English X-32 images | [LE](LE.md), [executable layout](EXECUTABLE_LAYOUT.md) | `src/formats/le.cpp`, `src/launch/fltd.cpp` |
| IFF crest template | `WAPPEN.LBM` | [WAPPEN](WAPPEN.md) | Not loaded by OpenBMH |
| OpenBMH world, save and pack | `*.obw`, `*.obs`, `*.obp`, `*.obt` | [OBW](OBW.md), [initial importer](obw/import.md) | `src/import` converts installation data; game integration/save support planned for 0.2 |
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.
-206
View File
@@ -1,206 +0,0 @@
# Classic installation content contract, version 1
This contract completes the installation import for the two supported Classic
mods without making the 0.1 engine consume OBW. It is an additive OBW 1.0
extension, guarded by **`requires: ["runtime:classic-v1"]`**. Readers which do not
implement it must reject it. The mod IDs are `BMH-classic` and `FLTD-classic`.
The contract is a bridge for the 0.2 adapter. Core JSON gives stable identities
and useful typed projections; `x-classic` retains every remaining content byte
and binds initialization semantics to a version. It does not make a legacy cup
table into the generic competition engine planned for 0.4. Neither a DOS
executable nor an installed game is needed to reconstruct the imported content.
## Content and precedence
| Path | Contract |
|---|---|
| `manifest.json` | Profile `classic-installation-v1`, canonical mod ID, content ownership, season reference and required runtime |
| `world/*.json` | Core entities, source squad identities, initialization policies, league/cup projections and rule/calendar projections |
| `x-legacy/source-database.json` | Exact master database as hex, with `legacy-source@1.0`; preserves spare slots and packed fields |
| `x-legacy/database.json` | Named auxiliary tables and name pools |
| `x-legacy/texts.json` | Original text indices, decoded strings and raw bytes |
| `x-classic/startup.json` | `classic-startup@1.0`, edition, layout version, initializers, inputs and resource references |
| `x-classic/{source,effective}/*.bin` | Original and supported-profile DATA regions, never program code |
| `x-classic/{desktop,formation}-seed.bin` | The 864-byte desktop and 1,408-byte formation input records |
| `x-classic/text-blob.bin` | Exact text block after its seven-byte source header, including following bytes used by bounded legacy text reads; startup metadata preserves the header |
| `assets/classic/resources.json` | Image dimensions/indices/PNG paths, bitmap-font metrics, audio-container chunks and optional artwork |
| `assets/classic/palette.json` | All 256 ARGB colors, using the existing verified VGA-DAC expansion |
| `assets/index.json` | Logical keys, paths, kind, source and rights metadata |
| `assets/portrait-sets/bmh-classic@1/set.json` | Four backgrounds, five ordered layers, individual part keys and placement |
| `x-classic/inventory.json` | Every other entry's path, byte count and CRC32 |
`content_complete: true` means that all content needed by this particular runtime
is present. It does not identify a running game, an OBW-capable released client,
or a completely generic typed simulation. The adapter must preserve legacy
fields it does not otherwise use. Names/appearance/assets in the core projection
are the presentation values; original byte names and offsets remain available
for Classic initialization and compatibility. An adapter which supports editing
ratings, membership or competitions must explicitly apply those changes to its
initialization model; blindly replaying the preserved database would ignore them.
## Data regions
`openbmh-classic-layout@1` fixes the address layout already documented in
`src/formats/executable_layout.hpp` at the introduction of this contract:
- Common German-layout data: `[0xA0000, 0xC1000)`.
- Football Limited only, native English data: `[0x6B000, 0x776A8)`.
Only these allowlisted regions and four bounded text literals can be reconstructed.
The literals are the free-kick, penalty, corner and automatic-taker labels at
`0x80CC9`, `0x80CD2`, `0x80CDB`, `0x80CE3`, with bounds 9/9/8/5 bytes including
the terminator. They share a German LE code object, so they are extracted as
individual strings, never as the containing object. English normalized images
retain their existing values (empty where untranslated). All other locations of
the compatibility image are zero. DOS headers, program instructions and relocation
instructions are excluded. Pointer-valued data remain numbers; they are never executed.
`effective` is the existing loader's output with `openbmh-supported@1` rules.
`source` is the same loaded/translated data before applying that rule profile.
English translation still maps the edition's content into the common layout and
also retains its native data region. The two copies prevent shared rule
normalization from destroying source values. The current supported rule profile
is the default for both Classic mods; selecting unpatched rules requires a
separately versioned runtime/profile, not a silent behavioral change.
Raw regions include all content read through the current executable-data API:
cup/qualification tables, ladder, prices, training and credit data, stadium
configuration, player-generation settings, match parameters, embedded strings,
interface atlases/coordinates and audio tables. Some of these remain byte-based
compatibility fields rather than final generic rule objects. They are fully
preserved, not left to a future re-import from the executable.
## New-game initialization
The importer does **not** choose a manager, start a career, simulate a season,
consume either game RNG or import an FBM. The adapter receives two seeds, manager
choices, level, mode and competition options when starting a new game. It applies
these operations in order, retaining the existing engine's arithmetic, packed
field behavior and draw sequence:
| Initializer | Existing semantic operation |
|---|---|
| `classic-load-seeds@1` | `startup_state`: database/pools, saved static blocks, desktop/formation input, competition pointers and nationality transforms |
| `classic-player-ratings@1` | `startup_players`, with edition league structure and original extra-player slots |
| `classic-pending-offers@1` | Clear the four pending-offer words to their empty sentinel, as `new_career_before_dialog` |
| `classic-markets-and-moods@1` | `new_career_markets_and_moods`: funds/shares, provisional computer-manager names, market history and club moods |
| `classic-free-agents@1` | `new_career_players`: ages/skills and release of extra players |
| `classic-setup-options@1` | Apply level, mode, duration, manager count, competition/calendar masks, then `career_managers_begin` |
| `classic-confirm-managers@1` | `career_add_manager`: name/portrait, identity swaps, ratings, financial/contractual, lineup, stadium and sponsor initialization; then `career_managers_end` |
| `classic-season-setup@1` | `career_season_setup` and `career_first_steps`: entrants, international cycle, calendar, tickets, club accounts, player season and shuffled draw positions |
Extra runtime configuration mirrors `CareerSession`: currency suffix, training-camp
data, credit tables/divisor, edition scheduling, message strings and runtime
options all come from the imported content/current versioned Classic algorithm.
The adapter maps `manifest.start_date` to its calendar's season origin. The
current 0.1 engine uses a 2026 date label internally; the importer does not change
that engine. The installation equivalence test uses the same 2026 origin and
identical options/seeds on both paths. Other requested start years are retained
as world input for the 0.2 calendar adapter.
`classic-manager-finance@1`, `classic-player-contract@1` and
`classic-stadium@1` are **initialization policies**, not existing contracts,
balances or owned stadiums. Finance policies cover 138 league clubs; actual
human-manager accounts are created when a manager is assigned. Contract seeds
bind every assigned player to the source team with the packed source values.
Referees are staff entities; managers and other generated staff get identities
when a new game creates them. Stadium entities form the complete name pool.
No invented birth date, contract term or zero-capacity stadium fills a gap.
## Competition and calendar projections
All nine leagues use the edition's sizes, members and fixture draw-position
tables. German regional third divisions remain parallel. The English ten-club
fifth tier remains unplayed, with no invented fixture generator.
All 36 source cup entries remain in the data regions. Entries with a valid
competition ID 0–26 are also represented as stages grouped by competition ID;
sentinel entries remain data only. Their Classic fields record source entry,
flags, next/parallel links, round counts, qualification quota and group number.
Slots with `resolver: classic-entry@1` are dynamic fields populated by
`classic-season-entrants@1`, not explicit team lists. `teams` records the source
stage size and can be zero before initialization. The resolver must implement
the current edition's selection and qualification algorithm, including FA Cup
qualifying/proper rounds and League Cup for English data, or indoor/Masters for
German data. The generic `format` field alone is insufficient to execute a stage.
For inspection, `classic-season-entrants@1` assigns each first-division champion
to the Champions League. A holder in that league also qualifies (or the
runner-up if already champion). Domestic cup winners, with finalists as
replacements, enter the Cup Winners' Cup. Title-holder overlap affects the
remaining allocation. The regular UEFA-Cup quotas are `[4,4,4,4,3]` for source
league indices `[0,5,6,7,8]`, taking the next unqualified clubs by rank. Foreign
cup representatives follow the Classic selection procedure. The historical
`x-legacy.europe_places` field is a prediction/colouring value, not that quota.
The versioned Classic ladder uses its first four domestic groups. Relegation
counts come from each league's `x-legacy.relegation_places`. A single lower
league supplies the corresponding top-ranked clubs; parallel lower leagues
supply champions plus winners of the Classic playoffs. Without that playoff
result only the champions are exchanged. The last domestic group draws from
the newcomer pool, never a foreign league named by an unused `below` entry.
License withdrawals and the Classic protection of a human manager at the
bottom tier can affect the actual result. Foreign Classic leagues have no
regular promotion/relegation. These are compatibility policy summaries, not
independent typed modern rule declarations or permission to simulate them in
the editor.
`classic-calendar@1` retains the complete source day table and bindings.
`classic-season-calendar@1` applies options, season cycle, weekday alignment and
leap-year behavior using the Classic calendar algorithm at runtime. Cup series
bind calendar bit `competition_id + 5`; league series retain the edition's
calendar-group binding. Dated fixtures cannot be exported before manager/options
selection without changing the original start semantics.
## Artwork, portraits, fonts and audio
Every imported image has an indexed PNG for standard consumers plus a `.pixels`
payload for the Classic adapter's exact palette-index operations. Dimensions and
palette are explicit. The source VGA files themselves are not required. Crest
keys bind stable club identities; the original generic crest is used where the
Classic interface deliberately uses a fallback. Kit selectors and the complete
relevant sprite sheets remain available.
`appearance` contains the source-name-derived result, computed with the same
signed-byte/unsigned-seed arithmetic as `PlayerCardScreen::draw_portrait`, including
its discarded initial draw. It never consumes the game's RNG streams. A rename
changes the name, not the recipe. The set stores each part separately, preserving
linear source-stride wrap at row edges, transparent index zero, layer order and
offsets relative to the 38×38 background. It never stores composed faces.
Bitmap fonts store glyph locations, widths, advances, original alphabet bounds,
baseline and exact bitmap bytes. The zero-width replacement glyph may point
beyond the bitmap because it is never dereferenced. These fonts use the Classic
byte encoding; new modern interface fonts remain a separate theme concern.
The four original ALPTRAUM audio containers are local binary assets with chunk
metadata, consumed by the already implemented audio decoder. Music keeps its
instrument/sequence data rather than being destructively flattened to a recording.
Source frequency/operator tables remain in the Classic data regions. Optional
FLI/FLC and editor artwork is retained as identified local artwork, without
importing editor programs, user settings or saves.
## Reader, writer and checks
`bmh::obw::read` accepts ZIP/directory content and validates it. `load_classic`
returns the read-only input model (`Database`, data-only `LeImage`, full `TextDb`,
desktop/formation seeds, indexed images, palette, fonts and audio) independently
of either game frontend. It does not create `GameState` or `CareerSession`.
Binary payloads are byte strings, not UTF-8 JSON strings. Paths are authored
relative forward-slash paths. The reader rejects traversal, duplicate entries,
symlinks in a directory, excessive sizes and unknown required profiles. The
validator checks cross-references, complete stage/contract bindings, resource
shapes, portrait indices and inventory. CRC32 detects accidental damage, not
malicious modification. An editor deliberately changing a world must update its
inventory (`refresh_classic_inventory`) and validate it before writing.
The installation test reconstructs from an OBW ZIP, then compares a complete
first-season initialization in RAM against the existing legacy-load path:
native state bytes and both RNG seeds/counts. It also compares every exported
data-region byte and original atlas pixels, palette, fonts and audio. This proves
content/startup preservation for the supplied installation and chosen test start;
it does not claim an implemented 0.2 adapter, native-platform testing, a fully
played season or savegame conversion.
-160
View File
@@ -1,160 +0,0 @@
# OBW 1.1 editor-world-v1
This additive profile is a native editing interchange. It does **not** change
`classic-installation-v1`, its seals, the Classic runtime or save files.
It is implemented by OpenBMH Editor 0.5.x, whose application version is separate
from the OBW format version and the OpenBMH 0.2.0 game version.
## Identification
```json
{
"format": "openbmh-world",
"format_version": "1.1",
"min_reader": "1.1",
"kind": "world",
"title": {"default": "My world"},
"start_date": "2026-07-01",
"currency": {"code": "EUR", "minor_units": 2},
"requires": ["editor:world-v1"],
"extensions": [{"id": "x-editor", "version": "1"}],
"x-editor": {"profile": "editor-world-v1", "playable": false}
}
```
The required editor capability is deliberately different from
`runtime:classic-v1`. An edited world must not be resealed as a Classic world.
The display title and a label such as Modern do not grant a runtime capability.
On import the editor keeps the original manifest under
`x-editor.original_manifest`, leaves compatibility/source regions intact, and
requires Save As. An original Classic seal is historical evidence only in this
profile. The existing Classic reader/validator is not broadened to accept it.
## Tables and values
The existing `world/*.json` and `assets/index.json` structure remains. Each table
is an object with `schema` and `items`. Stable `id` identifiers (asset `key`)
are references, never array positions. Existing identifiers and unknown fields
are preserved. New identifiers have a namespace and opaque suffix.
The editor adds explicit club `competition`, competition `members` (club IDs),
and player `squad_order`. These are the editable projections of Classic league
slots/squad rows. Moving a club updates league membership in the same
transaction. The historical Classic slots stay source evidence; a future
playable format adapter must choose and implement its own generation rules.
Player `born` can be `null`; an imported `age_at_start` object remains an age,
not an invented birth date. `team: null` is an unassigned projection; an
`x-editor.membership_unresolved` or `membership_unassigned` marker distinguishes
missing/contradictory source facts from a verified free agent. Reported
nationalities and sporting eligibility remain separate. No full roster is
cut down to the 24 rows of a Classic compatibility view.
Attribute sets declare their actual numeric ranges in `world/rules.json`:
`type: "attribute_set"`, optional `attribute_set` alias, and `fields` mapping
attribute names to `{min,max,...}`. The Classic importer declares strength
0–99, form/condition/technique/bonus 0–127, skills 0–3. An FC set remains a
separate 0–99 system. Missing values are null/absent; `unrated@1` with empty
attributes does not invent a rating.
Competition `trophy` and optional fallback remain logical asset references;
images are indexed just like crests and portraits. Arbitrary new competitions
can use their own trophy or a package-supplied generic trophy.
### Read-only comparisons (Editor 0.5.1)
The editor's `compare` command / `editor_compare` MCP tool projects ratings and
salaries without writing an additional OBW table. Player attributes retain their
set and range. Club and league attributes are player-weighted means of known
values within one set; mixed sets require a filter. Full rosters include reserves,
except source evidence explicitly marked
`x-simulation.squad_role: "source-only-duplicate"`. League membership uses a club's
explicit league, or an unambiguous league `members` reference as fallback.
`contracts.salary` is per season, in integer `manifest.currency` minor units.
Only contracts active on `manifest.start_date` and matching the player's current
team count; absent bounds are open and explicit date bounds are inclusive.
Multiple matching active contracts are ambiguous, not summed. Missing or invalid
salary remains null, independently of an explicit zero. Club/league payrolls
exclude staff and use known player salaries only. `salary_known`,
`salary_unknown`, `salary_ambiguous`, `salary_complete` and `salary_overflow`
describe coverage; a missing/empty/overflowed sum is null. Means of known salaries
round to the nearest minor unit. Attribute means separately report their sample
sizes in `attribute_counts`. No current date, invented contract or foreign-club
strength-band interpretation is substituted for missing data.
### Read-only regulations (Editor 0.5.2)
The `regulations` command / `editor_regulations` MCP tool exposes the same
read-only projection as the Regulations page. It accepts `language` (de/en),
`search`, `nation` and `competition`. It returns `items`, all preserved `rules`,
the world date, `read_only: true` and the session revision. It creates no table,
edits, undo entries or runtime entrants.
Each item retains its full `record` and `stages`. Explicit `movement` entries
retain rank ranges and destination references; tier comparisons label promotion
and relegation, participant roles label playoffs. Competition/stage `slots`
retain their full selector, fallback, explicit destination and phase; they are
visible on both the source and destination competition. Fixed participant lists
are not reinterpreted as qualification rules.
Imported `classic_runtime.qualifications: classic-season-entrants@1` and
`legacy_ladder` records permit a labelled presentation of the existing Classic
policy, documented in [classic-v1](classic-v1.md). Explicit declared rules take
precedence. Unknown rules stay unspecified; the editor never substitutes modern
UEFA quotas or infers qualification from historical colouring fields. This
presentation registry does not implement a new season engine.
Optional `manifest.presentation` references the `asset-presentation@1` visual
defaults described in [OBW §9.2](../OBW.md#92-resolution-and-image-formats).
Youth pools, silhouette and generic trophy keys remain indexed assets. They are
preserved across editor saves, independent of Classic source recipes or seals.
## Sources, conflicts and images
- `x-source/` can contain unchanged or losslessly gzipped normalized source
tables, input hashes, source-to-projection identifiers and identity evidence.
References include package-local file paths and JSON pointers. Sources do
not become authoritative merely by being present.
- `x-editor/review.json` has `items` with `id`, `reason`, `resolved`, optional
`table`, `entity`, `field` (JSON pointer), and `alternatives` with `value` and
source descriptions. Choosing a value updates its target plus the review
record in one undoable transaction. Original alternatives remain.
- Raster and SVG sources are stored unchanged. Identity imports preserve exact
bytes. Edits use a normalized recipe: `angle` degrees, `flip_x`, `flip_y`,
`crop: {x,y,width,height}`. Mirroring precedes clockwise rotation; rotation
expands the canvas; crop coordinates refer to that expanded canvas. Values
are finite, crop dimensions positive and inside [0,1]. JSON floating-point
values must survive round trips.
- An edited asset's `x-editor` stores `original`, `original_sha256` and
`transform`. Originals live in `x-editor/originals/`, rendered files in
`assets/edited/`, addressed by SHA-256. Raster edits are PNG with transparent
expanded edges, SVG edits remain vectors. Import does not upscale portraits.
Referenced external SVG resources are refused. Originals and source recipes
remain available on re-edit; no repeated destructive resampling is needed.
- Portrait part sets and frozen `appearance` recipes remain valid. The editor
composes those layers for display; a rename never regenerates the recipe.
## Container, validation and saving
ZIP/ZIP64, stored or deflated entries; UTF-8 JSON; package-local paths without
absolute paths, `..`, backslashes or symlinks. The editor limits are 100,000
entries, 64 MiB per uncompressed entry and 2 GiB total uncompressed bytes. This
is independent of the smaller Classic 1.0 reader limits.
The editor checks identifier uniqueness, typed references, valid dates,
declared attribute ranges and assets. Missing facts/source questions are
warnings; structural errors block saving. A transaction either validates and
commits or is rolled back. `revision` increases monotonically, including
undo/redo. Undoing to the saved state clears the dirty flag.
Unknown entries, extensions, binary assets and untouched table bytes are
retained. Large assets remain lazily read from an immutable source snapshot.
Saving streams a temporary ZIP and atomically replaces the destination only
after finalization. Modified-on-disk sources require Save As. The editor never
writes legacy files or a running save.
The [1.1 editor schema](schema/1.1/editor-world.json) documents structural
constraints. Runtime validation additionally resolves cross-table references
and rule-declared scales. This is not a claim that the generic world can yet
be played by a game engine.
-158
View File
@@ -1,158 +0,0 @@
# BMH and Football Limited installation converter
`openbmh_import` imports the content of a supported, locally supplied installation
as **BMH-classic** or **FLTD-classic**. Football Limited's executable is named
`FLTD.EXE`; the spellings `FTDL-classic` and `FTLD-classic` are accepted as CLI
aliases and written as `FLTD-classic`.
The output is an `.obw` ZIP, or an equivalent directory. It contains the complete
**Classic installation content**, including graphics, portrait parts, fonts,
audio and the original data tables. It contains no running career or executable.
The existing 0.1 game does not read OBW. The 0.2 development branch implements the
versioned [Classic contract](classic-v1.md) through its
[native runtime and launcher](runtime-0.2.md). This remains separate from
migrating every engine rule to the future generic model.
## Build and use
Configure as described in [BUILDING](../../BUILDING.md), then:
```sh
cmake --build build --config Release --target openbmh_import
./build/openbmh_import --data "path/to/BMH" --output "BMH-classic.obw" \
--start-date 2026-07-01 --mod BMH-classic
./build/openbmh_import --data "path/to/FLTD.EXE" --output "FLTD-classic.obw" \
--start-date 1995-07-01 --mod FLTD-classic
./build/openbmh_import --validate "BMH-classic.obw"
```
On a Visual Studio multi-configuration build use
`build\Release\openbmh_import.exe`. `--mod` is optional: the tool detects the
edition. A mismatching explicit mod is an error. `--title TEXT` changes the
world's display title. `--directory` writes an unpacked world, which `--validate`
can read too. The source may be an installation directory, its executable, or a
parent with exactly one installation. File discovery ignores case. If both game
executables exist, select the intended executable explicitly.
A full import requires the same installation resources as the current launcher:
master database, text database, executable, `M3.MEN`, `M3.DAT`, palette, required
`KB`/`W` pictures, two fonts and four sound banks. A missing resource is an error.
Supported inputs are the German CD-family editions and Football Limited; the
1994 floppy `M3.EXE`/`M3PC.MAN` family and Amiga installations are not supported.
Source ZIP/7z and `.FBM` files are not input formats for this tool.
The date must be July 1 of an explicit year (1900–9998). Master data contain
ages without an unambiguous season year; the converter never uses today's date
or invents birth dates. Player age is recorded as `age_at_start`. Calendar setup
remains a Classic runtime operation using the selected season/options.
Existing destinations, including symlinks, are refused. The parent directory
must exist. The tool stages and validates output before publishing by rename;
source files are read only. Do not run competing writers for one destination.
## What a Classic world contains
The manifest names `mod: BMH-classic` or `FLTD-classic`, profile
`classic-installation-v1`, `requires: ["runtime:classic-v1"]` and
`content_license: local-import-only`. `content_complete: true` means all inputs
for that **specific Classic runtime** are present. It does not claim that the
0.1 client can load OBW or that every rule has already been migrated to a generic
0.2/0.4 schema. A reader without `runtime:classic-v1` must refuse the world.
| Area | Contents |
|---|---|
| Nations and teams | All named clubs/national teams, nine leagues, amateur pool, foreign nation blocks, encoded strength band/style, crest and kit selectors |
| Players | All 2,574 identities, squads, raw words/flags, attributes, age reference, nationality and frozen portrait recipe |
| Staff | Referee names, properties and strictness; human/computer manager setup is a runtime initializer |
| Contracts and finance | Contract seeds per assigned player and finance policies for all 138 league clubs; actual values are created by the same manager/season initialization as today |
| Stadiums | Entire name pool and stadium initializer, with all building, capacity, price and facility tables retained in Classic data regions |
| Competitions | Nine league definitions and fixture generators, plus every configured cup-table stage with links, flags, group/qualifying information and runtime participant resolvers |
| Calendar and rules | Day table, league bindings, cup series, ladder, training camps, credit factors, initialization sequence and all remaining data-region content |
| Text | UTF-8 original gettext layer, indexed strings, raw text blob and embedded executable-data texts |
| Artwork | Every numeric `KB/*.VGA` and `W/*.VGA` decoded as indexed PNG plus exact pixel indices; crest crops, original palette, portrait parts, bitmap fonts |
| Audio and optional art | Four original audio containers with chunk descriptors; optional FLI/FLC animation and WAPPEN.LBM when present |
| Preservation | Exact master-database bytes, named auxiliary tables/pools, original and effective data regions, resource metadata and CRC32 inventory |
A source database does **not** contain ready-made human-manager finances,
contracts or stadium capacities. Those depend on the selected club, game level,
mode and random seeds. The world specifies their initialization rather than
inventing a balance, contract term or stadium owner. Imported player attributes
are the master seeds; the existing Classic initialization changes ratings and
ages and can shuffle club draw positions. This consumes no RNG during import.
Player `appearance` is computed from the **raw legacy byte name**, before Unicode
conversion. It freezes the background and five layer indices once. Name overlays
must retain this field. The imported set stores individual transparent parts and
placement metadata; composed player faces are never stored. Packed atlas parts
which cross a source row boundary retain their original pixels.
The effective data use OpenBMH's existing supported rule profile. Unpatched
source data are preserved separately, including Football Limited's native data
segment. Neither copy includes a DOS header, executable code or relocation
instructions. `x-classic` is a documented compatibility bridge, not a claim that
the current address-based engine has already been replaced.
## Stable identities and original encodings
IDs derive from master identity slots: `club:00000`, `player:00000`,
`stadium:00000`; national teams use `nt:<nation-key>`. Recognized countries get
ISO keys, with private association keys for England/Scotland/Wales/Northern
Ireland. Unrecognized/duplicate country labels retain `nation:x-legacy-<index>`
and a report warning, preserving modded or historical identities.
Foreign club indices 168–356 form 27 blocks of seven teams corresponding to
nation slots 5–31. The nine league ranges retain their edition-specific sizes:
German 18/18/18/18/18 and four 12-team leagues; English 20/20/20/20/10 and four
12-team leagues. The English fifth division is an unplayed pool; no ten-team
fixture generator is invented. Unnamed English amateur slots remain in the
preserved source rather than becoming fabricated clubs.
Text follows ISO 646-DE substitutions and preserves extended bytes as Latin-1
Unicode code points; raw bytes remain available. Player names are kept whole in
`name.last`, without guessing first/last-name splits. Fixture tables describe
draw positions; qualified participants and final fixtures are resolved at the
same initialization phase as in the Classic engine.
## Validation and verification
`--validate` checks the profile, versions, safe paths, unique entity/asset IDs,
core references, squad/stage counts, complete cup bindings, contract ownership,
initialization contract, media shapes, portrait indices, resource files and the
inventory before accepting a world. Complete imports also carry a SHA-256 seal,
verified by this tool when present and required by the 0.2 Classic runtime.
ZIP and directory readers enforce size
limits; directory symlinks and injected `state/` content are rejected. CRC32
catches accidental damage; it is not a signature or proof of trustworthy content.
This is the Classic profile validator, not a general competition engine or a full
JSON Schema implementation. Draft 2020-12 schemas are provided for external tools.
`obw_import_tests` uses synthetic data to cover both editions, binary round trips,
frozen appearances, malformed input and damaged payloads. With `BMH_DATA`,
`obw_classic_installation_tests` imports an installation, writes/reopens its ZIP,
reconstructs the startup inputs without reading the source again, and compares
first-season initialization bytes and both RNG streams. It also compares data
regions, atlas pixels, palette, fonts and audio against the source. The same test
can be run with a Football Limited directory as its argument. It does not test
OBW integration in a released client or a complete played season.
## Partial development export
`--database-only` deliberately retains the previous `legacy-database-v1` export
for database investigations without media. Its manifest remains
`playable: false`, requires `import:legacy-database-v1`, and its report lists gaps.
It is **not** one of the completed Classic mods. Default imports never silently
fall back to this mode.
## Rights and excluded data
All imported content remains local and retains its original ownership. Do not
publish generated worlds or assets without appropriate rights. Public tests and
schemas contain only independently authored implementation and synthetic data.
The standalone installation converter does not migrate careers or personal
settings. The 0.2 launcher separately migrates supported `.FBM`, `.EIN` and `.MEN`
files into native personal files; see its [migration contract](runtime-0.2.md).
`SOUND.CFG`, high scores, backups, editor/program executables and external manuals
are not imported. In-game readme content is retained when available. Manager
choices and career RNG state belong to a new game or `.obs` save, not to this
installation conversion.
-107
View File
@@ -1,107 +0,0 @@
<!-- SPDX-License-Identifier: GPL-3.0-only -->
# Classic runtime and portable launcher (0.2 development)
This contract is for the 0.2 development branch. It is not a release validation claim.
## Portable layout and lifecycle
`OpenBMH.exe` (Windows) / `OpenBMH` (Linux and macOS) starts the operating system's
RmlUI launcher: one selected row, **Name | Art**, and **Start, Add, Delete, Rename, End**.
No installation is auto-selected on first launch. Add converts an externally owned
installation; original assets never belong in a distribution.
```
OpenBMH[.exe]
assets/launcher/*
mods/<name>/content.obw
userdata/<content-id>/*.obs
userdata/<content-id>/*.obsettings
userdata/<content-id>/*.oblayout
userdata/<content-id>/highscore-<signature>.obscore
```
The directory name is the launcher name, separate from `manifest.mod` (`BMH-classic`
or `FLTD-classic`). `FTDL-classic` is the requested English directory-name default.
Names must be portable single path components; duplicates are case-insensitive.
Classic files are sealed, not editable world overlays. Modern gameplay is not implemented.
Rename changes the directory only. Delete removes mod content after confirmation and
retains user data. Reimporting the same content and start year reconnects it. The content
identity excludes display title, generator version and the CRC inventory, but includes
runtime content and the starting-year configuration. It deliberately changes when content
actually changes. User data cannot be silently associated with a different database.
The launcher starts a child process of the same binary, with `--run-mod` and a separate
save directory, and remains available after the child exits. `--mod <content.obw>` bypasses
the launcher. A normal GUI/console invocation cannot fall back to original game files.
RML/RCSS define the launcher and its import, rename, delete and progress dialogs.
Only folder selection uses an OS dialog. The SDL2/OpenGL view keeps UI resources
relative to the executable, supports resizing and HiDPI input, and sleeps between
input or scheduled UI updates. The running child's match engine does not depend on
RmlUI. OpenGL 3.3 is required for the launcher (4.1 on macOS).
## Integrity and content access
The existing `classic-installation-v1` payload is complemented by
`x-classic/seal.json` (`classic-seal@1.0`): SHA-256 for every other archive entry plus
`content_id`. The earlier CRC inventory excludes the seal to avoid a circular digest.
A missing seal, changed entry or unexpected file in a Classic mod directory prevents start.
SHA-256 detects ordinary manual changes/corruption; it is not a signature or a promise
against a local owner modifying the validator.
The runtime decodes indexed images, fonts and palettes into an immutable store. Existing
UI aliases such as `KB/29.VGA` select the already decoded object; they are not files.
Embedded image palettes are imported separately, preserving the Sportschau/title colours.
Original single-byte readme content is preserved in the local package where available.
No original executable is reconstructed or executed.
## Native careers and personal files
A `.obs` ZIP contains the complete sealed starting world, with its original manifest at
`state/world-manifest.json`. The top manifest has `kind: save`,
`save_profile: classic-career-v1` and the content identity.
| Entry | Native contract |
|---|---|
| `state/career.json` | `classic-state@1.0`: named typed arrays/scalars, name bytes and explicitly addressed compatibility blocks |
| `state/rng.json` | `classic-rng@1.0`: both seeds and decimal-string draw counters |
| `state/session.json` | `classic-session@1.0`: runtime option bytes, stable desk arguments and manager mappings |
| `state/driver.json` | `classic-driver@1.0`: desk stage/order, match groups, referees, event counter and previous results |
| `state/information.json` | `classic-bytes@1.0`: Classic browser information fields |
| `state/integrity.json` | `save-integrity@1.0`: SHA-256 of every other state entry |
Only existing manager-desk save boundaries are supported. Runtime callbacks and host
pointers are reconstructed. Native saving is RNG-neutral; unlike the old FBM envelope it
needs no random encryption fields. Both generator seeds and draw counters resume exactly.
Names and compatibility bytes use hexadecimal encoding to retain single-byte values
without pretending they are UTF-8. Integer fields have explicit bounds.
`.obsettings`, `.oblayout` and `.obscore` are JSON documents with kind-specific schema
names (`classic-settings@1.0`, `classic-layout@1.0`, `classic-highscore@1.0`) and a
`classic-bytes@1.0` payload. They preserve existing availability bits, layout chains and
high-score fields. The existing application validators still govern settings and layouts.
Writes publish a complete temporary file atomically; overwrites require the existing
application confirmation.
## Legacy migration and Classic dates
Add defaults to transferring games/settings, with a separately selectable source directory.
The source is read-only. Existing personal files are retained rather than overwritten.
Individual failures appear in the import report.
German/OpenBMH V2.24 files use their documented block contract. Original Football Limited
V2.20 has its own block translator, including FA Cup, League Cup and additional-cup memory.
It is never accepted by merely changing a version string. Like the V2.20 loader, migration
rebuilds its unsaved current match groups without replaying daily finances or shuffling
saved manager order. Unknown/damaged versions fail explicitly.
Original FBM files do not contain the clock-seeded Watcom random state. Migration therefore
seeds that stream reproducibly from SHA-256 of the source file. A converted career cannot
promise the original machine's unknown random future; subsequent native checkpoints retain
both streams in full.
The selected start year changes only displayed years for new careers. Weekdays and the
original four-year calendar remain unchanged. Imported careers retain the year from their
saved information header when it is valid. This cosmetic origin is independent of the
immutable world's start configuration and is carried in the native career.
@@ -1,55 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/asset-index.json",
"properties": {
"schema": {
"const": "asset-index@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^asset:"
},
"files": {
"type": "object",
"minProperties": 1,
"additionalProperties": {
"type": "string"
}
},
"source": {
"type": "string"
},
"author": {
"type": "string"
},
"license": {
"const": "local-import-only"
},
"kind": {
"type": "string"
}
},
"required": [
"key",
"files",
"source",
"author",
"license",
"kind"
]
}
}
},
"required": [
"schema",
"items"
],
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
}
-58
View File
@@ -1,58 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/calendar.json",
"type": "object",
"properties": {
"schema": {
"const": "calendar@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^calendar:[a-zA-Z0-9._-]+$"
},
"season_start": {
"const": "07-01"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"legacy_calendar_bit": {
"type": "integer",
"minimum": 0,
"maximum": 31
}
},
"required": [
"id",
"legacy_calendar_bit"
],
"additionalProperties": true
}
}
},
"required": [
"id",
"season_start",
"series"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
@@ -1,20 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-bytes.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-bytes@1.0"
},
"hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
}
},
"required": [
"schema",
"hex"
],
"additionalProperties": false
}
@@ -1,402 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-driver.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-driver@1.0"
},
"stage": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"calendar_entry": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"manager_position": {
"type": "integer",
"minimum": 0,
"maximum": 4
},
"next_event_id": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 20
},
"loaded_matchday_resume": {
"type": "boolean"
},
"suppress_remaining_pre_match_offers": {
"type": "boolean"
},
"national_nomination_desk": {
"type": "boolean"
},
"enable_national_nomination_desks": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"desc": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 192,
"maxItems": 208
},
"fixtures": {
"type": "array",
"items": {
"type": "integer",
"minimum": -1,
"maximum": 4095
},
"minItems": 0,
"maxItems": 64
},
"results": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 32
},
"cup_results": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 32
},
"cup_other_leg": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 32
},
"records": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 576
},
"end_minute": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 32
},
"spectators": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"minItems": 0,
"maxItems": 32
},
"log": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"cup_addresses": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"minItems": 2,
"maxItems": 2
},
"phase": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"ended": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"kickoff_void_mask": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"desc",
"fixtures",
"results",
"cup_results",
"cup_other_leg",
"records",
"end_minute",
"spectators",
"log",
"cup_addresses",
"phase",
"ended",
"kickoff_void_mask"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 6
},
"referee_source": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 255
},
"referees": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 255
},
"last_results": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"date": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"calendar_entry": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"matchday": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"desc": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 192,
"maxItems": 208
},
"fixtures": {
"type": "array",
"items": {
"type": "integer",
"minimum": -1,
"maximum": 4095
},
"minItems": 0,
"maxItems": 64
},
"results": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 32
},
"cup_results": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 32
},
"cup_other_leg": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 32
},
"records": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 576
},
"end_minute": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 32
},
"spectators": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"minItems": 0,
"maxItems": 32
},
"log": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"cup_addresses": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"minItems": 2,
"maxItems": 2
},
"phase": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"ended": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"kickoff_void_mask": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"desc",
"fixtures",
"results",
"cup_results",
"cup_other_leg",
"records",
"end_minute",
"spectators",
"log",
"cup_addresses",
"phase",
"ended",
"kickoff_void_mask"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 6
},
"tournament_name": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 0,
"maxItems": 1000000
}
},
"required": [
"valid",
"date",
"calendar_entry",
"matchday",
"groups",
"tournament_name"
],
"additionalProperties": false
}
},
"required": [
"schema",
"stage",
"calendar_entry",
"manager_position",
"next_event_id",
"loaded_matchday_resume",
"suppress_remaining_pre_match_offers",
"national_nomination_desk",
"enable_national_nomination_desks",
"groups",
"referee_source",
"referees",
"last_results"
],
"additionalProperties": false
}
@@ -1,34 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-highscore.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-highscore@1.0"
},
"payload": {
"type": "object",
"properties": {
"schema": {
"const": "classic-bytes@1.0"
},
"hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 720,
"minLength": 720
}
},
"required": [
"schema",
"hex"
],
"additionalProperties": false
}
},
"required": [
"schema",
"payload"
],
"additionalProperties": false
}
@@ -1,41 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-inventory.json",
"properties": {
"schema": {
"const": "classic-inventory@1.0"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"crc32": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"path",
"bytes",
"crc32"
]
}
}
},
"required": [
"schema",
"entries"
],
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
}
@@ -1,34 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-layout.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-layout@1.0"
},
"payload": {
"type": "object",
"properties": {
"schema": {
"const": "classic-bytes@1.0"
},
"hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 1728,
"minLength": 1728
}
},
"required": [
"schema",
"hex"
],
"additionalProperties": false
}
},
"required": [
"schema",
"payload"
],
"additionalProperties": false
}
@@ -1,26 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-palette.json",
"properties": {
"schema": {
"const": "classic-palette@1.0"
},
"argb": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"minItems": 256,
"maxItems": 256
}
},
"required": [
"schema",
"argb"
]
}
@@ -1,200 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-resources.json",
"properties": {
"schema": {
"const": "classic-resources@1.0"
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"height": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"pixels": {
"type": "string"
},
"png": {
"type": "string"
}
},
"required": [
"name",
"width",
"height",
"pixels",
"png"
]
}
},
"fonts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"height": {
"type": "integer",
"minimum": 0
},
"baseline": {
"type": "integer",
"minimum": 0
},
"nominal_width": {
"type": "integer",
"minimum": 0
},
"flags": {
"type": "integer",
"minimum": 0
},
"lo_char": {
"type": "integer",
"minimum": 0
},
"hi_char": {
"type": "integer",
"minimum": 0
},
"modulo": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string"
},
"bitmap": {
"type": "string"
},
"glyphs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bit_offset": {
"type": "integer",
"minimum": 0
},
"bit_width": {
"type": "integer",
"minimum": 0
},
"advance": {
"type": "integer"
}
},
"required": [
"bit_offset",
"bit_width",
"advance"
]
}
}
},
"required": [
"name",
"height",
"baseline",
"nominal_width",
"flags",
"lo_char",
"hi_char",
"modulo",
"glyphs",
"bitmap"
]
},
"minItems": 2,
"maxItems": 2
},
"audio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"codec": {
"const": "original-alptraum@1"
},
"chunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"offset": {
"type": "integer",
"minimum": 0
},
"size": {
"type": "integer",
"minimum": 0
}
},
"required": [
"id",
"offset",
"size"
]
}
}
},
"required": [
"name",
"path",
"codec",
"chunks"
]
},
"minItems": 4,
"maxItems": 4
},
"optional": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"name",
"path"
]
}
}
},
"required": [
"schema",
"images",
"fonts",
"audio",
"optional"
]
}
@@ -1,56 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-rng.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-rng@1.0"
},
"watcom": {
"type": "object",
"properties": {
"seed": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"calls": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 20
}
},
"required": [
"seed",
"calls"
],
"additionalProperties": false
},
"game": {
"type": "object",
"properties": {
"seed": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"calls": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 20
}
},
"required": [
"seed",
"calls"
],
"additionalProperties": false
}
},
"required": [
"schema",
"watcom",
"game"
],
"additionalProperties": false
}
@@ -1,27 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-seal.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-seal@1.0"
},
"content_id": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"entries": {
"type": "object",
"additionalProperties": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
}
}
},
"required": [
"schema",
"content_id",
"entries"
],
"additionalProperties": false
}
@@ -1,72 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-session.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-session@1.0"
},
"runtime": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"value": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
},
"required": [
"address",
"value"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 8192
},
"desk_callargs": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 2,
"maxItems": 2
},
"minItems": 0,
"maxItems": 4
},
"managers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 3,
"maxItems": 3
},
"minItems": 0,
"maxItems": 4
}
},
"required": [
"schema",
"runtime",
"desk_callargs",
"managers"
],
"additionalProperties": false
}
@@ -1,34 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-settings.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-settings@1.0"
},
"payload": {
"type": "object",
"properties": {
"schema": {
"const": "classic-bytes@1.0"
},
"hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 360,
"minLength": 360
}
},
"required": [
"schema",
"hex"
],
"additionalProperties": false
}
},
"required": [
"schema",
"payload"
],
"additionalProperties": false
}
@@ -1,189 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-startup.json",
"properties": {
"schema": {
"const": "classic-startup@1.0"
},
"layout": {
"const": "openbmh-classic-layout@1"
},
"mod": {
"enum": [
"BMH-classic",
"FLTD-classic"
]
},
"english": {
"type": "boolean"
},
"rule_profile": {
"const": "openbmh-supported@1"
},
"data_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"base": {
"type": "integer"
},
"size": {
"type": "integer",
"minimum": 1
},
"path": {
"type": "string"
}
},
"required": [
"name",
"base",
"size",
"path"
]
},
"minItems": 1,
"maxItems": 2
},
"source_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"base": {
"type": "integer"
},
"size": {
"type": "integer",
"minimum": 1
},
"path": {
"type": "string"
}
},
"required": [
"name",
"base",
"size",
"path"
]
},
"minItems": 1,
"maxItems": 2
},
"desktop_seed": {
"type": "string"
},
"formation_seed": {
"type": "string"
},
"text_blob": {
"type": "string"
},
"initializers": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 8,
"maxItems": 8
},
"runtime_inputs": {
"type": "array",
"items": {
"type": "string"
}
},
"rng": {
"type": "object"
},
"embedded_literals": {
"type": "array",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "integer"
},
"bytes_hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})+$"
}
},
"required": [
"name",
"address",
"bytes_hex"
]
}
},
"source_literals": {
"type": "array",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "integer"
},
"bytes_hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})+$"
}
},
"required": [
"name",
"address",
"bytes_hex"
]
}
},
"text_header": {
"type": "array",
"minItems": 7,
"maxItems": 7,
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
},
"required": [
"schema",
"layout",
"mod",
"english",
"rule_profile",
"data_regions",
"source_regions",
"desktop_seed",
"formation_seed",
"text_blob",
"initializers",
"runtime_inputs",
"rng",
"embedded_literals",
"source_literals",
"text_header"
],
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
}
@@ -1,542 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-state.json",
"type": "object",
"properties": {
"schema": {
"const": "classic-state@1.0"
},
"indoor": {
"type": "boolean"
},
"level": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"chance_rain": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"chance_temperature": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"last_shooter": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"last_pick_quality": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"live_scene": {
"type": "boolean"
},
"sportschau_selection_available": {
"type": "boolean"
},
"sportschau_club_threshold": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"list_toggle": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"lineups_frozen": {
"type": "boolean"
},
"offer_answer": {
"type": "boolean"
},
"transfer_notice_suppressed": {
"type": "boolean"
},
"pools_open": {
"type": "boolean"
},
"autosave_months": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"autosave_month": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"display_start_year": {
"type": "integer",
"minimum": 1900,
"maximum": 9998
},
"date": {
"type": "integer",
"minimum": 0,
"maximum": 3000000
},
"season_start": {
"type": "integer",
"minimum": 0,
"maximum": 3000000
},
"development_balance": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"trend_rotation": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"season": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"team_morale": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"player_bonus": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"formations": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"manager_records": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"tactics": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"manager_options": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"club_table": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"club_heap_bc": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"club_heap_78": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"club_heap_b8": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"master_database_metadata": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"referee_names": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"stadium_names": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"tournament_name": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"manager_results": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"manager_ratings": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"position_history": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"league_rounds": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"results": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"stocks": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"foreign_strength": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"mailbox": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"club_names": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"player_names": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"squad_slots": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"team_flags": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"manager_teams": {
"type": "array",
"items": {
"type": "integer",
"minimum": -1,
"maximum": 4095
},
"minItems": 0,
"maxItems": 4
},
"live_matches": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 0,
"maxItems": 1000000
},
"sportschau_homes": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 10,
"maxItems": 10
},
"sportschau_priorities": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 10,
"maxItems": 10
},
"club_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"player_cards": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"player_name_offsets": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"minItems": 0,
"maxItems": 1000000
},
"players": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name_hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
},
"form": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"skills": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"identity": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"name_hex",
"form",
"skills",
"identity"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 4095
},
"memory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"hex": {
"type": "string",
"pattern": "^(?:[0-9a-f]{2})*$",
"maxLength": 33554432
}
},
"required": [
"address",
"hex"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 8192
},
"reality": {
"type": "object",
"properties": {
"initialized": {
"type": "boolean"
},
"deflected": {
"type": "boolean"
},
"card_kind": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"distance": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"actors": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 5,
"maxItems": 5
},
"grid": {
"type": "object",
"properties": {
"planes": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 1144,
"maxItems": 1144
},
"minItems": 2,
"maxItems": 2
},
"positions": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 2,
"maxItems": 2
},
"minItems": 24,
"maxItems": 24
},
"ball": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 2,
"maxItems": 2
},
"previous_ball": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"minItems": 2,
"maxItems": 2
}
},
"required": [
"planes",
"positions",
"ball",
"previous_ball"
],
"additionalProperties": false
}
},
"required": [
"initialized",
"deflected",
"card_kind",
"distance",
"actors",
"grid"
],
"additionalProperties": false
}
},
"required": [
"schema",
"indoor",
"level",
"chance_rain",
"chance_temperature",
"last_shooter",
"last_pick_quality",
"live_scene",
"sportschau_selection_available",
"sportschau_club_threshold",
"list_toggle",
"lineups_frozen",
"offer_answer",
"transfer_notice_suppressed",
"pools_open",
"autosave_months",
"autosave_month",
"display_start_year",
"date",
"season_start",
"development_balance",
"trend_rotation",
"season",
"team_morale",
"player_bonus",
"formations",
"manager_records",
"tactics",
"manager_options",
"club_table",
"club_heap_bc",
"club_heap_78",
"club_heap_b8",
"master_database_metadata",
"referee_names",
"stadium_names",
"tournament_name",
"manager_results",
"manager_ratings",
"position_history",
"league_rounds",
"results",
"stocks",
"foreign_strength",
"mailbox",
"club_names",
"player_names",
"squad_slots",
"team_flags",
"manager_teams",
"live_matches",
"sportschau_homes",
"sportschau_priorities",
"club_ids",
"player_cards",
"player_name_offsets",
"players",
"memory",
"reality"
],
"additionalProperties": false
}
-55
View File
@@ -1,55 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/clubs.json",
"type": "object",
"properties": {
"schema": {
"const": "clubs@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "common.json#/$defs/team_id"
},
"type": {
"enum": [
"club",
"national",
"amateur",
"foreign"
]
},
"name": {
"$ref": "common.json#/$defs/localized"
},
"nation": {
"$ref": "common.json#/$defs/nation_id"
},
"stadium": {
"type": "string",
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
},
"strength": {
"type": "integer"
}
},
"required": [
"id",
"type",
"name",
"nation"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
-42
View File
@@ -1,42 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/common.json",
"$defs": {
"localized": {
"type": "object",
"properties": {
"default": {
"type": "string"
}
},
"required": [
"default"
],
"additionalProperties": true
},
"nation_id": {
"type": "string",
"pattern": "^nation:[a-zA-Z0-9._-]+$"
},
"team_id": {
"type": "string",
"pattern": "^(club|nt):[a-zA-Z0-9._-]+$"
},
"person_id": {
"type": "string",
"pattern": "^(player|staff):[a-zA-Z0-9._-]+$"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
},
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
@@ -1,171 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/competitions.json",
"type": "object",
"properties": {
"schema": {
"const": "competitions@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^comp:[a-zA-Z0-9._-]+$"
},
"name": {
"$ref": "common.json#/$defs/localized"
},
"type": {
"enum": [
"league",
"cup",
"club_international",
"national_team",
"friendly",
"indoor"
]
},
"nation": {
"$ref": "common.json#/$defs/nation_id"
},
"tier": {
"type": "integer",
"minimum": 1
},
"played": {
"type": "boolean"
},
"stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"format": {
"enum": [
"league",
"groups",
"knockout",
"final",
"playoff"
]
},
"teams": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"legs": {
"type": "integer",
"minimum": 1
},
"generator": {
"type": "string"
},
"matchdays": {
"type": "string"
},
"slots": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"teams": {
"type": "array",
"items": {
"$ref": "common.json#/$defs/team_id"
},
"uniqueItems": true
}
},
"required": [
"teams"
]
},
{
"type": "object",
"properties": {
"resolver": {
"const": "classic-entry@1"
},
"entry": {
"type": "integer",
"minimum": 0,
"maximum": 35
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
},
"required": [
"resolver",
"entry",
"count"
]
}
]
},
"minItems": 1
}
},
"required": [
"id",
"format",
"teams",
"legs",
"slots"
],
"additionalProperties": true
},
"minItems": 1
},
"trophy": {
"type": "string",
"pattern": "^asset:comp/(?!\\.{1,2}/)[a-zA-Z0-9._-]+/trophy$",
"description": "Optional presentation key; default is asset:comp/<competition key>/trophy. Missing artwork resolves to asset:comp/generic/trophy and then a built-in neutral trophy icon."
}
},
"required": [
"id",
"name",
"type",
"played",
"stages"
],
"additionalProperties": true,
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "league"
}
}
},
"then": {
"required": [
"nation",
"tier"
]
}
}
]
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
}
@@ -1,49 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/contracts.json",
"type": "object",
"properties": {
"schema": {
"const": "contracts@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^contract:[a-zA-Z0-9._-]+$"
},
"person": {
"$ref": "common.json#/$defs/person_id"
},
"team": {
"$ref": "common.json#/$defs/team_id"
},
"salary": {
"type": "integer"
},
"start": {
"$ref": "common.json#/$defs/date"
},
"end": {
"$ref": "common.json#/$defs/date"
}
},
"required": [
"id",
"person",
"team"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
-39
View File
@@ -1,39 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/finance.json",
"type": "object",
"properties": {
"schema": {
"const": "finance@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^finance:[a-zA-Z0-9._-]+$"
},
"team": {
"$ref": "common.json#/$defs/team_id"
},
"balance": {
"type": "integer"
}
},
"required": [
"id",
"team"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
-235
View File
@@ -1,235 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/manifest.json",
"type": "object",
"properties": {
"format": {
"const": "openbmh-world"
},
"format_version": {
"const": "1.0"
},
"kind": {
"const": "world"
},
"min_reader": {
"const": "1.0"
},
"title": {
"$ref": "common.json#/$defs/localized"
},
"generator": {
"type": "string"
},
"provenance": {
"enum": [
"import:bmh-de",
"import:fltd"
]
},
"content_license": {
"const": "local-import-only"
},
"currency": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"minor_units": {
"const": 0
}
},
"required": [
"code",
"minor_units"
],
"additionalProperties": true
},
"start_date": {
"$ref": "common.json#/$defs/date"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"limits": {
"type": "object",
"properties": {
"leagues": {
"const": 32
}
},
"required": [
"leagues"
],
"additionalProperties": true
},
"requires": {
"oneOf": [
{
"const": [
"import:legacy-database-v1"
]
},
{
"const": [
"runtime:classic-v1"
]
}
]
},
"extensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"id",
"version"
],
"additionalProperties": true
}
},
"x-import": {
"oneOf": [
{
"type": "object",
"properties": {
"profile": {
"const": "legacy-database-v1"
},
"playable": {
"const": false
},
"rule_profile": {
"const": "openbmh-supported"
},
"default_attribute_set": {
"type": "string"
}
},
"required": [
"profile",
"playable",
"rule_profile"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"profile": {
"const": "classic-installation-v1"
},
"content_complete": {
"const": true
},
"runtime": {
"const": "runtime:classic-v1"
},
"rule_profile": {
"const": "openbmh-supported@1"
},
"source_rules_preserved": {
"const": true
},
"default_attribute_set": {
"const": "bmh-classic@1"
},
"default_portrait_set": {
"const": "bmh-classic@1"
}
},
"required": [
"profile",
"content_complete",
"runtime",
"rule_profile",
"source_rules_preserved",
"default_attribute_set",
"default_portrait_set"
],
"additionalProperties": true
}
]
},
"id": {
"type": "string"
},
"mod": {
"enum": [
"BMH-classic",
"FLTD-classic"
]
}
},
"required": [
"format",
"format_version",
"kind",
"min_reader",
"title",
"generator",
"provenance",
"content_license",
"currency",
"start_date",
"languages",
"limits",
"requires",
"extensions",
"x-import"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles.",
"allOf": [
{
"if": {
"properties": {
"requires": {
"const": [
"runtime:classic-v1"
]
}
}
},
"then": {
"required": [
"id",
"mod"
],
"properties": {
"x-import": {
"properties": {
"profile": {
"const": "classic-installation-v1"
}
}
}
}
},
"else": {
"properties": {
"x-import": {
"properties": {
"profile": {
"const": "legacy-database-v1"
}
}
}
}
}
}
]
}
-55
View File
@@ -1,55 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/nations.json",
"type": "object",
"properties": {
"schema": {
"const": "nations@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^nation:[a-zA-Z0-9._-]+$"
},
"name": {
"$ref": "common.json#/$defs/localized"
},
"confederation": {
"enum": [
"uefa",
"conmebol",
"caf",
"afc",
"concacaf",
"ofc",
"other"
]
},
"national_team": {
"type": "string",
"pattern": "^nt:[a-zA-Z0-9._-]+$"
},
"playable": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"confederation"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
-153
View File
@@ -1,153 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/players.json",
"type": "object",
"properties": {
"schema": {
"const": "players@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^player:[a-zA-Z0-9._-]+$"
},
"name": {
"type": "object",
"properties": {
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"known_as": {
"type": "string"
}
},
"required": [
"first",
"last"
],
"additionalProperties": true
},
"born": {
"$ref": "common.json#/$defs/date"
},
"age_at_start": {
"type": "object",
"properties": {
"years": {
"type": "integer",
"minimum": 16,
"maximum": 47
},
"on": {
"$ref": "common.json#/$defs/date"
}
},
"required": [
"years",
"on"
],
"additionalProperties": true
},
"nationalities": {
"type": "array",
"items": {
"$ref": "common.json#/$defs/nation_id"
},
"minItems": 1
},
"positions": {
"type": "array",
"items": {
"enum": [
"gk",
"def",
"mid",
"fwd"
]
},
"minItems": 1
},
"attribute_set": {
"const": "bmh-classic@1"
},
"attributes": {
"$ref": "common.json#/$defs/attributes"
},
"team": {
"$ref": "common.json#/$defs/team_id"
},
"appearance": {
"type": "object",
"properties": {
"set": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]*@[0-9]+$"
},
"background": {
"type": "integer",
"minimum": 0
},
"layers": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
}
},
"required": [
"set",
"background",
"layers"
],
"additionalProperties": true
}
},
"required": [
"id",
"name",
"nationalities",
"positions",
"attribute_set",
"attributes"
],
"additionalProperties": true,
"oneOf": [
{
"required": [
"born"
],
"not": {
"required": [
"age_at_start"
]
}
},
{
"required": [
"age_at_start"
],
"not": {
"required": [
"born"
]
}
}
]
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
@@ -1,85 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"additionalProperties": true,
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/portrait-set.json",
"properties": {
"schema": {
"const": "portrait-set@1.0"
},
"id": {
"const": "bmh-classic@1"
},
"width": {
"const": 38
},
"height": {
"const": 38
},
"transparent_index": {
"const": 0
},
"backgrounds": {
"type": "array",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "object",
"properties": {
"asset": {
"type": "string"
},
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"asset",
"x",
"y"
]
}
},
"layers": {
"type": "array",
"minItems": 5,
"maxItems": 5,
"items": {
"type": "object",
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
},
"parts": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"required": [
"x",
"y",
"parts"
]
}
}
},
"required": [
"schema",
"id",
"width",
"height",
"backgrounds",
"layers",
"transparent_index"
],
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
}
-35
View File
@@ -1,35 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/rules.json",
"type": "object",
"properties": {
"schema": {
"const": "rules@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
@@ -1,22 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-integrity.json",
"type": "object",
"properties": {
"schema": {
"const": "save-integrity@1.0"
},
"entries": {
"type": "object",
"additionalProperties": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
}
}
},
"required": [
"schema",
"entries"
],
"additionalProperties": false
}
@@ -1,31 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-manifest.json",
"type": "object",
"required": [
"format",
"format_version",
"kind",
"save_profile",
"content_id"
],
"properties": {
"format": {
"const": "openbmh-world"
},
"format_version": {
"const": "1.0"
},
"kind": {
"const": "save"
},
"save_profile": {
"const": "classic-career-v1"
},
"content_id": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
}
},
"additionalProperties": true
}
-52
View File
@@ -1,52 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/stadiums.json",
"type": "object",
"properties": {
"schema": {
"const": "stadiums@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
},
"name": {
"$ref": "common.json#/$defs/localized"
},
"owner": {
"oneOf": [
{
"$ref": "common.json#/$defs/team_id"
},
{
"type": "null"
}
]
},
"capacity": {
"type": "object"
},
"facilities": {
"type": "object"
}
},
"required": [
"id",
"name"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
-43
View File
@@ -1,43 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/staff.json",
"type": "object",
"properties": {
"schema": {
"const": "staff@1.0"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^staff:[a-zA-Z0-9._-]+$"
},
"name": {
"$ref": "common.json#/$defs/localized"
},
"role": {
"type": "string"
},
"team": {
"$ref": "common.json#/$defs/team_id"
}
},
"required": [
"id",
"name",
"role"
],
"additionalProperties": true
}
}
},
"required": [
"schema",
"items"
],
"additionalProperties": true,
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
}
@@ -1,41 +0,0 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://openbmh.org/schema/1.1/editor-world.json",
"title": "OBW 1.1 editor-world-v1 manifest",
"type": "object",
"required": ["format", "format_version", "min_reader", "kind", "title", "requires", "x-editor"],
"properties": {
"format": {"const": "openbmh-world"},
"format_version": {"const": "1.1"},
"min_reader": {"const": "1.1"},
"kind": {"const": "world"},
"title": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": {"type": "string"}}]},
"start_date": {"type": "string", "format": "date"},
"requires": {"type": "array", "contains": {"const": "editor:world-v1"}, "items": {"type": "string"}},
"x-editor": {
"type": "object", "required": ["profile", "playable"],
"properties": {"profile": {"const": "editor-world-v1"}, "playable": {"const": false}},
"additionalProperties": true
}
},
"additionalProperties": true,
"$defs": {
"table": {"type": "object", "required": ["schema", "items"], "properties": {"schema": {"type": "string"}, "items": {"type": "array", "items": {"type": "object"}}}, "additionalProperties": true},
"transform": {
"type": "object",
"properties": {
"angle": {"type": "number", "minimum": -360, "maximum": 360},
"flip_x": {"type": "boolean"}, "flip_y": {"type": "boolean"},
"crop": {"type": "object", "properties": {
"x": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "number", "minimum": 0, "maximum": 1},
"width": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}, "height": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}
}, "additionalProperties": true}
}, "additionalProperties": true
},
"review": {"type": "object", "required": ["id", "reason", "resolved", "alternatives"], "properties": {
"id": {"type": "string", "minLength": 1}, "reason": {"type": "string"}, "resolved": {"type": "boolean"},
"table": {"type": "string"}, "entity": {"type": "string"}, "field": {"type": "string", "pattern": "^/"},
"alternatives": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": true}}
}, "additionalProperties": true}
}
}
-152
View File
@@ -1,152 +0,0 @@
FreeType font driver for BDF fonts
Francesco Zappa Nardelli
<francesco.zappa.nardelli@ens.fr>
Introduction
************
BDF (Bitmap Distribution Format) is a bitmap font format defined by Adobe,
which is intended to be easily understood by both humans and computers.
This code implements a BDF driver for the FreeType library, following the
Adobe Specification V 2.2. The specification of the BDF font format is
available from Adobe's web site:
https://adobe-type-tools.github.io/font-tech-notes/pdfs/5005.BDF_Spec.pdf
Many good bitmap fonts in bdf format come with XFree86 (www.XFree86.org).
They do not define vertical metrics, because the X Consortium BDF
specification has removed them.
Encodings
*********
[This section is out of date, retained for historical reasons. BDF
properties can be retrieved with `FT_Get_BDF_Property`, character set ID
values with `FT_Get_BDF_Charset_ID`.]
The variety of encodings that accompanies bdf fonts appears to encompass the
small set defined in freetype.h. On the other hand, two properties that
specify encoding and registry are usually defined in bdf fonts.
I decided to make these two properties directly accessible, leaving to the
client application the work of interpreting them. For instance:
#include FT_INTERNAL_BDF_TYPES_H
FT_Face face;
BDF_Public_Face bdfface;
FT_New_Face( library, ..., &face );
bdfface = (BDF_Public_Face)face;
if ( ( bdfface->charset_registry == "ISO10646" ) &&
( bdfface->charset_encoding == "1" ) )
[..]
Thus the driver always exports `ft_encoding_none' as face->charmap.encoding.
FT_Get_Char_Index's behavior is unmodified, that is, it converts the ULong
value given as argument into the corresponding glyph number.
If the two properties are not available, Adobe Standard Encoding should be
assumed.
Anti-Aliased Bitmaps
********************
The driver supports an extension to the BDF format as used in Mark Leisher's
xmbdfed bitmap font editor. Microsoft's SBIT tool expects bitmap fonts in
that format for adding anti-aliased them to TrueType fonts. It introduces a
fourth field to the `SIZE' keyword which gives the bpp value (bits per
pixel) of the glyph data in the font. Possible values are 1 (the default),
2 (four gray levels), 4 (16 gray levels), and 8 (256 gray levels). The
driver returns either a bitmap with 1 bit per pixel or a pixmap with 8bits
per pixel (using 4, 16, and 256 gray levels, respectively).
Known problems
**************
- A font is entirely loaded into memory. Obviously, this is not the Right
Thing(TM). If you have big fonts I suggest you convert them into PCF
format (using the bdftopcf utility): the PCF font drive of FreeType can
perform incremental glyph loading.
When I have some time, I will implement on-demand glyph parsing.
- Except for encodings properties, client applications have no visibility of
the PCF_Face object. This means that applications cannot directly access
font tables and must trust FreeType.
- Currently, glyph names are ignored.
I plan to give full visibility of the BDF_Face object in an upcoming
revision of the driver, thus implementing also glyph names.
- As I have never seen a BDF font that defines vertical metrics, vertical
metrics are (parsed and) discarded. If you own a BDF font that defines
vertical metrics, please let me know (I will implement them in 5-10
minutes).
License
*******
Copyright (C) 2001-2002 by Francesco Zappa Nardelli
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*** Portions of the driver (that is, bdflib.c and bdf.h):
Copyright 2000 Computing Research Labs, New Mexico State University
Copyright 2001-2002, 2011 Francesco Zappa Nardelli
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE COMPUTING RESEARCH LAB OR NEW MEXICO STATE UNIVERSITY BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Credits
*******
This driver is based on excellent Mark Leisher's bdf library. If you
find something good in this driver you should probably thank him, not
me.
-169
View File
@@ -1,169 +0,0 @@
The FreeType Project LICENSE
----------------------------
2006-Jan-27
Copyright 1996-2002, 2006 by
David Turner, Robert Wilhelm, and Werner Lemberg
Introduction
============
The FreeType Project is distributed in several archive packages;
some of them may contain, in addition to the FreeType font engine,
various tools and contributions which rely on, or relate to, the
FreeType Project.
This license applies to all files found in such packages, and
which do not fall under their own explicit license. The license
affects thus the FreeType font engine, the test programs,
documentation and makefiles, at the very least.
This license was inspired by the BSD, Artistic, and IJG
(Independent JPEG Group) licenses, which all encourage inclusion
and use of free software in commercial and freeware products
alike. As a consequence, its main points are that:
o We don't promise that this software works. However, we will be
interested in any kind of bug reports. (`as is' distribution)
o You can use this software for whatever you want, in parts or
full form, without having to pay us. (`royalty-free' usage)
o You may not pretend that you wrote this software. If you use
it, or only parts of it, in a program, you must acknowledge
somewhere in your documentation that you have used the
FreeType code. (`credits')
We specifically permit and encourage the inclusion of this
software, with or without modifications, in commercial products.
We disclaim all warranties covering The FreeType Project and
assume no liability related to The FreeType Project.
Finally, many people asked us for a preferred form for a
credit/disclaimer to use in compliance with this license. We thus
encourage you to use the following text:
"""
Portions of this software are copyright © <year> The FreeType
Project (www.freetype.org). All rights reserved.
"""
Please replace <year> with the value from the FreeType version you
actually use.
Legal Terms
===========
0. Definitions
--------------
Throughout this license, the terms `package', `FreeType Project',
and `FreeType archive' refer to the set of files originally
distributed by the authors (David Turner, Robert Wilhelm, and
Werner Lemberg) as the `FreeType Project', be they named as alpha,
beta or final release.
`You' refers to the licensee, or person using the project, where
`using' is a generic term including compiling the project's source
code as well as linking it to form a `program' or `executable'.
This program is referred to as `a program using the FreeType
engine'.
This license applies to all files distributed in the original
FreeType Project, including all source code, binaries and
documentation, unless otherwise stated in the file in its
original, unmodified form as distributed in the original archive.
If you are unsure whether or not a particular file is covered by
this license, you must contact us to verify this.
The FreeType Project is copyright (C) 1996-2000 by David Turner,
Robert Wilhelm, and Werner Lemberg. All rights reserved except as
specified below.
1. No Warranty
--------------
THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE OR THE INABILITY TO
USE, OF THE FREETYPE PROJECT.
2. Redistribution
-----------------
This license grants a worldwide, royalty-free, perpetual and
irrevocable right and license to use, execute, perform, compile,
display, copy, create derivative works of, distribute and
sublicense the FreeType Project (in both source and object code
forms) and derivative works thereof for any purpose; and to
authorize others to exercise some or all of the rights granted
herein, subject to the following conditions:
o Redistribution of source code must retain this license file
(`FTL.TXT') unaltered; any additions, deletions or changes to
the original files must be clearly indicated in accompanying
documentation. The copyright notices of the unaltered,
original files must be preserved in all copies of source
files.
o Redistribution in binary form must provide a disclaimer that
states that the software is based in part of the work of the
FreeType Team, in the distribution documentation. We also
encourage you to put an URL to the FreeType web page in your
documentation, though this isn't mandatory.
These conditions apply to any software derived from or based on
the FreeType Project, not just the unmodified files. If you use
our work, you must acknowledge us. However, no fee need be paid
to us.
3. Advertising
--------------
Neither the FreeType authors and contributors nor you shall use
the name of the other for commercial, advertising, or promotional
purposes without specific prior written permission.
We suggest, but do not require, that you use one or more of the
following phrases to refer to this software in your documentation
or advertising materials: `FreeType Project', `FreeType Engine',
`FreeType library', or `FreeType Distribution'.
As you have not signed this license, you are not required to
accept it. However, as the FreeType Project is copyrighted
material, only this license, or another one contracted with the
authors, grants you the right to use, distribute, and modify it.
Therefore, by using, distributing, or modifying the FreeType
Project, you indicate that you understand and accept all the terms
of this license.
4. Contacts
-----------
There are two mailing lists related to FreeType:
o freetype@nongnu.org
Discusses general use and applications of FreeType, as well as
future and wanted additions to the library and distribution.
If you are looking for support, start in this list if you
haven't found anything to help you in the documentation.
o freetype-devel@nongnu.org
Discusses bugs, as well as engine internals, design issues,
specific licenses, porting, etc.
Our home page can be found at
https://www.freetype.org
--- end of FTL.TXT ---
-96
View File
@@ -1,96 +0,0 @@
FreeType font driver for PCF fonts
Francesco Zappa Nardelli
<francesco.zappa.nardelli@ens.fr>
Introduction
************
PCF (Portable Compiled Format) is a binary bitmap font format, largely used
in X world. This code implements a PCF driver for the FreeType library.
Glyph images are loaded into memory only on demand, thus leading to a small
memory footprint.
Information on the PCF font format can only be worked out from
`pcfread.c', and `pcfwrite.c', to be found, for instance, in the XFree86
(www.xfree86.org) source tree (xc/lib/font/bitmap/).
Many good bitmap fonts in bdf format come with XFree86: they can be
compiled into the pcf format using the `bdftopcf' utility.
Supported hardware
******************
The driver has been tested on linux/x86 and sunos5.5/sparc. In both
cases the compiler was gcc. When back in Paris, I will test it also
on linux/alpha.
Encodings
*********
Use `FT_Get_BDF_Charset_ID' to access the encoding and registry.
The driver always exports `ft_encoding_none' as face->charmap.encoding.
FT_Get_Char_Index() behavior is unmodified, that is, it converts the ULong
value given as argument into the corresponding glyph number.
Known problems
**************
- dealing explicitly with encodings breaks the uniformity of FreeType 2
API.
- except for encodings properties, client applications have no
visibility of the PCF_Face object. This means that applications
cannot directly access font tables and are obliged to trust
FreeType.
- currently, glyph names and ink_metrics are ignored.
I plan to give full visibility of the PCF_Face object in the next
release of the driver, thus implementing also glyph names and
ink_metrics.
- height is defined as (ascent - descent). Is this correct?
- if unable to read size information from the font, PCF_Init_Face
sets available_size->width and available_size->height to 12.
- too many english grammar errors in the readme file :-(
License
*******
Copyright (C) 2000 by Francesco Zappa Nardelli
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Credits
*******
Keith Packard wrote the pcf driver found in XFree86. His work is at
the same time the specification and the sample implementation of the
PCF format. Undoubtedly, this driver is inspired from his work.
-29
View File
@@ -1,29 +0,0 @@
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.3, August 18th, 2023
Copyright (C) 1995-2023 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
The data format used by the zlib library is described by RFCs (Request for
Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
(zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
*/
-46
View File
@@ -1,46 +0,0 @@
FREETYPE LICENSES
-----------------
The FreeType 2 font engine is copyrighted work and cannot be used
legally without a software license. In order to make this project
usable to a vast majority of developers, we distribute it under two
mutually exclusive open-source licenses.
This means that *you* must choose *one* of the two licenses described
below, then obey all its terms and conditions when using FreeType 2 in
any of your projects or products.
- The FreeType License, found in the file `docs/FTL.TXT`, which is
similar to the original BSD license *with* an advertising clause
that forces you to explicitly cite the FreeType project in your
product's documentation. All details are in the license file.
This license is suited to products which don't use the GNU General
Public License.
Note that this license is compatible to the GNU General Public
License version 3, but not version 2.
- The GNU General Public License version 2, found in
`docs/GPLv2.TXT` (any later version can be used also), for
programs which already use the GPL. Note that the FTL is
incompatible with GPLv2 due to its advertisement clause.
The contributed BDF and PCF drivers come with a license similar to
that of the X Window System. It is compatible to the above two
licenses (see files `src/bdf/README` and `src/pcf/README`). The same
holds for the source code files `src/base/fthash.c` and
`include/freetype/internal/fthash.h`; they were part of the BDF driver
in earlier FreeType versions.
The gzip module uses the zlib license (see `src/gzip/zlib.h`) which
too is compatible to the above two licenses.
The files `src/autofit/ft-hb.c` and `src/autofit/ft-hb.h` contain code
taken almost verbatim from the HarfBuzz file `hb-ft.cc`, which uses
the 'Old MIT' license, compatible to the above two licenses.
The MD5 checksum support (only used for debugging in development
builds) is in the public domain.
--- end of LICENSE.TXT ---
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-4
View File
@@ -8,11 +8,7 @@ These files preserve upstream license and attribution wording. They are not a gr
- [miniz](miniz.txt): the MIT license shipped with the 3.0.2 amalgamation. [Additional verbatim source notices](miniz-source-notices.txt), including the additional copyright attribution and public-domain dedication, are also retained.
- [LZMA SDK](LZMA-SDK.txt): the public-domain declaration from the 7-Zip 24.09 documentation. Only individually marked public-domain decoder files are used.
- [nativefiledialog-extended](nativefiledialog-extended.txt): version 1.2.1 zlib license.
- [RmlUi](RmlUi.txt): 6.3 MIT license, including the separate [container notices](RmlUi-containers.txt) and [Khronos backend notice](RmlUi-Khronos.txt).
- [FreeType](FreeType.txt): 2.13.3 license choices, with the [FTL](FreeType-FTL.txt) selected for this build and [BDF](FreeType-BDF.txt), [PCF](FreeType-PCF.txt) and [gzip/zlib](FreeType-zlib.txt) notices preserved.
- [Lato font notices](RmlUi-fonts.txt): unmodified Regular and Bold Latin fonts from RmlUi 6.3, under SIL OFL 1.1. The upstream sample-font notice is retained verbatim.
- [Nuked OPL3 copyright and license notice](Nuked-OPL3-notices.txt): unchanged leading notice from its vendored implementation.
- [LGPL version 2.1](LGPL-2.1.txt): full license supplied with Nuked OPL3. Its source notices permit version 2.1 or any later version.
- Optional native editor: [nlohmann/json](nlohmann-json.txt), [cpp-httplib](cpp-httplib.txt), [SDL2_image](SDL2_image.txt), [stb_image](stb-image.txt), [libwebp](libwebp.txt) with its [patent grant](libwebp-PATENTS.txt), [LunaSVG](LunaSVG.txt), [PlutoVG](PlutoVG.txt), and [pugixml](pugixml.txt). These are verbatim upstream notices for the pinned versions listed in the root notices.
[THIRD_PARTY_NOTICES.md](../../THIRD_PARTY_NOTICES.md) identifies the upstream versions and distribution requirements. Include this directory, that notice file and the root LICENSE with release packages. Preserve upstream attribution within these verbatim texts.
-22
View File
@@ -1,22 +0,0 @@
/*
** Copyright (c) 2008-2018 The Khronos Group Inc.
**
** Permission is hereby granted, free of charge, to any person obtaining a
** copy of this software and/or associated documentation files (the
** "Materials"), to deal in the Materials without restriction, including
** without limitation the rights to use, copy, modify, merge, publish,
** distribute, sublicense, and/or sell copies of the Materials, and to
** permit persons to whom the Materials are furnished to do so, subject to
** the following conditions:
**
** The above copyright notice and this permission notice shall be included
** in all copies or substantial portions of the Materials.
**
** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
*/
-58
View File
@@ -1,58 +0,0 @@
RmlUi Core contains thirdparty libraries. They are listed below along with
their full licenses - all MIT licensed.
---
robin_hood unordered map & set
https://github.com/martinus/robin-hood-hashing
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
SPDX-License-Identifier: MIT
Copyright (c) 2018-2020 Martin Ankerl <http://martin.ankerl.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
---
itlib
https://github.com/iboB/itlib
MIT License
Copyright(c) 2016-2019 Chobolabs Inc.
Copyright(c) 2020-2023 Borislav Stanimirov
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files(the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and / or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions :
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-316
View File
@@ -1,316 +0,0 @@
The RmlUi samples include fonts that are separately licensed. They are listed
below along with their licenses.
-----------------------------------------------------------
-----------------------------------------------------------
--- Lato ---
--- http://www.latofonts.com/ ---
--- ---
--- LatoLatin-Bold.ttf ---
--- LatoLatin-BoldItalic.ttf ---
--- LatoLatin-Italic.ttf ---
--- LatoLatin-Regular.ttf ---
-----------------------------------------------------------
-----------------------------------------------------------
Copyright (c) 2010-2015, Łukasz Dziedzic (dziedzic@typoland.com),
with Reserved Font Name Lato.
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
-----------------------------------------------------------
-----------------------------------------------------------
--- Noto Emoji ---
--- https://www.google.com/get/noto/ ---
--- ---
--- NotoEmoji-Regular.ttf ---
-----------------------------------------------------------
-----------------------------------------------------------
This Font Software is licensed under the SIL Open Font License,
Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font
creation efforts of academic and linguistic communities, and to
provide a free and open framework in which fonts may be shared and
improved in partnership with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply to
any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software
components as distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to,
deleting, or substituting -- in part or in whole -- any of the
components of the Original Version, by changing formats or by porting
the Font Software to a new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed,
modify, redistribute, and sell modified and unmodified copies of the
Font Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components, in
Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the
corresponding Copyright Holder. This restriction only applies to the
primary font name as presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created using
the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
-----------------------------------------------------------
-----------------------------------------------------------
--- RobotoMono ---
--- https://fonts.google.com/ ---
--- ---
--- RobotoMono-Bold.ttf ---
--- RobotoMono-BoldItalic.ttf ---
--- RobotoMono-Italic.ttf ---
--- RobotoMono-Regular.ttf ---
-----------------------------------------------------------
-----------------------------------------------------------
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
https://openfontlicense.org
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
-22
View File
@@ -1,22 +0,0 @@
MIT License
Copyright (c) 2008-2014 CodePoint Ltd, Shift Technology Ltd, and contributors
Copyright (c) 2019-2026 The RmlUi Team, and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-17
View File
@@ -1,17 +0,0 @@
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.
-22
View File
@@ -1,22 +0,0 @@
The MIT License (MIT)
Copyright (c) 2017 yhirose
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-23
View File
@@ -1,23 +0,0 @@
Additional IP Rights Grant (Patents)
------------------------------------
"These implementations" means the copyrightable works that implement the WebM
codecs distributed by Google as part of the WebM Project.
Google hereby grants to you a perpetual, worldwide, non-exclusive, no-charge,
royalty-free, irrevocable (except as stated in this section) patent license to
make, have made, use, offer to sell, sell, import, transfer, and otherwise
run, modify and propagate the contents of these implementations of WebM, where
such license applies only to those patent claims, both currently owned by
Google and acquired in the future, licensable by Google that are necessarily
infringed by these implementations of WebM. This grant does not include claims
that would be infringed only as a consequence of further modification of these
implementations. If you or your agent or exclusive licensee institute or order
or agree to the institution of patent litigation or any other patent
enforcement activity against any entity (including a cross-claim or
counterclaim in a lawsuit) alleging that any of these implementations of WebM
or any code incorporated within any of these implementations of WebM
constitute direct or contributory patent infringement, or inducement of
patent infringement, then any patent rights granted to you under this License
for these implementations of WebM shall terminate as of the date such
litigation is filed.
-30
View File
@@ -1,30 +0,0 @@
Copyright (c) 2010, Google Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Google nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2013-2025 Niels Lohmann
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.
-24
View File
@@ -1,24 +0,0 @@
MIT License
Copyright (c) 2006-2025 Arseny Kapoulkine
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.
-36
View File
@@ -1,36 +0,0 @@
ALTERNATIVE A - MIT License
Copyright (c) 2017 Sean Barrett
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.
------------------------------------------------------------------------------
ALTERNATIVE B - Public Domain (www.unlicense.org)
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.
------------------------------------------------------------------------------
+28
View File
@@ -0,0 +1,28 @@
# obdeddi 0.1.0
A small native Windows data editor for the standalone OpenBMH 1.1 COMMUNITY.OBD format. It uses Win32/common controls, not SDL, RmlUI or a browser. The model and archive-writing tests build on all supported platforms; the graphical editor is Windows x64 only.
## Use
Extract the separate editor package and start `obdeddi.exe`. Open a COMMUNITY.OBD with the Open button or Ctrl+O. A file path may also be passed on the command line. Search and sortable virtual lists cover players and clubs; the club filter applies to players. Artwork is decoded only on demand in the separate club-logo dialog.
Player fields include names, position, nationality, age, form/technique/condition, bonus and the seven Classic skills. Displayed strength is derived, not a second independent field. Club fields include names, the stored short-name span and existing kit selectors. League sizes and record counts stay fixed. Country rows and rules are not editable. Club logos can be imported from PNG/JPEG/BMP, cropped by source-pixel coordinates, freely rotated and mirrored. The before/after preview uses the actual 38×38 Original palette and bright background; shared crest cells are cloned into a free cell. Other artwork is not editable. League players can move between squads or swap places; temporary/reserve-table players cannot be reassigned as if they were ordinary roster members.
Classic new-career generation is deliberately retained: many stored player values are randomized/recalculated when a career starts. Editing the database does not modify an existing saved game. This limitation is visible in the player form.
Apply commits the current form to the in-memory document. Changing selection also validates the draft form. Ctrl+S writes the document to its original OBD after verification and backup. Closing or opening another file asks about unsaved changes.
## Save safety
- ZIP/resource limits and supplied hashes are checked on open. Original database order, IDs, unknown player bits and non-database resource bytes are preserved.
- The M3D writer validates a decode/encode roundtrip. Unsupported characters and full 16-bit string pools are rejected rather than silently replaced.
- Save serializes a temporary sibling archive and reopens it for validation. A cooperating editor lock prevents overlapping saves.
- The complete prior archive is copied to `backups/` and read back for verification. External modifications are checked before the transaction and again before replacement.
- Only then does the OS atomically replace the original. A failed backup, validation or replacement leaves the original intact; a temporary file is cleaned up. Successful saves update resource hashes and append an editor-history record.
- Saving an unchanged document is a no-op. Backups are independent OBD bytes and can be copied back while the application is closed.
## Performance and delivery
Owner-data lists request only visible cell text. Search is debounced, forms update on selection/change, and the native message loop does not render continuously while idle. Assets are retained as bytes for integrity and save roundtrips, without image/font/audio decoding.
The editor has its own ZIP/release. It is not inserted into the small Windows community game package. Corresponding full sources are offered separately. OpenBMH 1.1 Beta keeps a fixed `OpenBMH 1.1` window caption, fits 18/20-team strengths views above the controls and uses a 25% longer default scene-frame delay (at least 16 ms). Explicit frame-delay overrides remain available; simulation clocks and random streams are not changed.
+64
View File
@@ -0,0 +1,64 @@
# Classic-plus-1 profile
This opt-in experimental profile keeps the Classic competition types and indexed artwork formats. It is not a DOS patch. The original executable is read only; verified dimension data and the expanded calendar are prepared in memory. Unmarked installations retain Classic dimensions and save identity.
## Discovery and dimensions
`OBMHPROF.INI` contains exactly:
```ini
[OpenBMH]
profile=classic-plus-1
```
Unknown keys/profiles are rejected. The German executable and calendar are required.
| Table | Classic | Classic-plus-1 |
| --- | ---: | ---: |
| League sizes, German divisions | 18/18/18/18/18 | 18/18/18/18/18 |
| Spain/England/France/Italy | 12/12/12/12 | 18/20/18/18 |
| League clubs | 138 | 164 |
| Cup-only clubs | 30 | 30 |
| League and cup records | 168 | 194 |
| Other foreign clubs | 189 | 189 |
| National teams | 62 | 62 |
| All club/country entries | 419 | 445 |
| Players | 2,574 | 3,334 |
| Clubs with 24 roster slots | 90 | 164 |
| First market slot | 2,928 | 3,936 |
| First national roster slot | 3,072 | 4,080 |
| First extra-player slot | 3,096 | 4,104 |
| Total runtime slots | 3,150 | 4,158 |
Player identifiers still use twelve bits, with 4,095 reserved for empty. **An absolute roster slot is not a player identifier**: extended auxiliary slots exceed 4,095 and must not be masked. Club identifiers fit existing packed club fields and crest selectors fit nine bits.
## Master database and artwork
The M3D table order and encoding remain unchanged. Kit selectors scale with all club/country entries; short-name offsets and auxiliary words scale with league-plus-cup entries. The squad master has four fewer rows than runtime, because temporary transfer rows are inserted during career initialization. String pools retain unsigned 16-bit offsets. Imported names use ISO 646-DE, with explicit transliteration of unsupported letters.
The preparation script keeps original player words and original IDs, appends supplemental players and records the source-to-runtime club mapping. Existing twelve-club foreign cores are retained; additional clubs are ranked by donor mean player strength. Missing-person data are not silently fetched or invented. Every supplied provenance/fictional-field note is retained in the private import report.
Crests are fitted into 38-by-38 cells of 304-by-38 VGA sheets, using the supplied VGA palette. No PNG/SVG decoder is needed at runtime. Transparency is index zero for these generated crest cells. Existing protected crest cells remain intact. Repeated Original placeholder images are rejected rather than counted as real club crests. Missing crests use explicitly fictional vector monograms, and dark monochrome logos can use a light contrast variant; both are recorded per club. Asset source and rights notes remain separate from the application's GPL license.
The offline preparation utility accepts local paths:
```sh
python3 -m venv asset-tools
asset-tools/bin/pip install Pillow CairoSVG
asset-tools/bin/python tools/poc/prepare_international.py \
--source /path/to/supplied/german-game \
--supplement /path/to/supplied/season.obw \
--output /path/to/new/private-data
```
The destination must not exist. Inputs are never overwritten. Original content and private import reports must stay outside public source trees, issues and CI artifacts.
## Save and memory boundaries
Classic containers retain `V2.24`. Extended containers use `O1.1`, checked against the selected installation before state decoding. The table sequence remains familiar, with count-derived sizes for club records, manager/opponent histories, crests, kits and short-name offsets. Extended typed tables must not grow into adjacent globals in the guest-memory compatibility representation.
The result store already reserves nine leagues with 38 rounds and ten matches per round. Expanded scheduling uses each league's own fixture size. The shared foreign calendar supplies 38 dates; each league stops at its own 34 or 38 rounds. Domestic/cup/national flags are preserved. Dates are an experimental calendar policy, not a claim about real-world fixtures.
## Distribution
Public artifacts contain the implementation, build information and corresponding sources. The community data ZIP is prepared privately and separately; existing content provenance and rights are unchanged. The stable 1.0 release line is not replaced by this POC.
+21
View File
@@ -0,0 +1,21 @@
# Standalone community data
The 1.1 community edition can start from `COMMUNITY.OBD` without an installed DOS game. The stable main line and loose Classic installation support remain separate.
`COMMUNITY.OBD` is a compressed read-only resource bundle. It contains the master database, text, palette, formations, desktop layout, fonts, indexed pictures/crests and audio containers required by OpenBMH. These are game content, not application code. Saves, highscores and user layouts remain normal writable files outside the bundle.
The bundle's `RUNTIME.DAT` uses the `OBMHDAT1` schema: data-segment base/length, calendar epoch, resolved badge/environment policies, data-segment bytes and explicitly named auxiliary labels. The exporter discards the DOS header, DOS/4GW loader and machine-code objects. Calendar and verified edition policies are values, rather than retained code fingerprints. This is not a renamed or embedded BMH executable.
The Classic address-view adapter still supplies the existing engine/UI table readers. It reads resource entries directly from the compressed bundle, without unpacking original executables or a cached DOS installation. Bundle paths are case-insensitive and reject duplicate/path-traversal entries; compressed/uncompressed limits bound allocations. Original loose installations retain their loading path.
Offline preparation from privately supplied resources:
```sh
cmake --build build --target export_community_runtime
python3 tools/poc/bundle_community.py --source /path/to/prepared-data \
--exporter /path/to/build/export_community_runtime --out /path/to/new/community-data
```
Only required resource types are included. DOS programs, installers, editor executables, original saves, backup directories, manuals and unused picture formats are excluded. Import provenance stays in `IMPORT-REPORT.json`; `PACKAGE.json` records the hashes of the bundled resources. A bundled `OBMHPROF.INI` selects the expanded league profile, so no additional loose Original files are needed.
Generated foreign crests now use the supplied Original domestic crest background texture. Transparent edges are composited onto that bright texture before palette reduction; actual black logo details remain black. The previous black rectangles and the light-on-dark monochrome workaround are removed.
+22
View File
@@ -0,0 +1,22 @@
# International-league POC
Working branch: `poc/1.1-international`, based on `v1.0.2`. Stable main remains separate.
Implemented:
- Explicit `OBMHPROF.INI` metadata; unmarked installations retain Classic dimensions.
- Five German divisions unchanged; international sizes 18/20/18/18, 164 league clubs.
- Twenty starting players and 24 slots per league club; 4,158 runtime roster/auxiliary slots.
- Profile-aware master-database and executable-data views, preserving executable bytes on disk.
- Count-derived club records, opponent histories, kit/short-name and fair-play tables.
- Per-league fixtures and 38 foreign calendar dates, with smaller leagues stopping at 34 rounds.
- Extended save identity `O1.1`; Classic retains `V2.24` and its existing dimensions.
- Offline private data preparation, provenance, crest fitting and Original-format VGA output.
Local integration evidence so far: the expanded career completed 180 turns with seed 1 (three season ends), and another 180 with seed 11 (two season ends). No simulator invariant violations or contract-policy errors were reported. These are automated manager-policy runs, not claims of complete human gameplay QA or validation of all editions/platforms.
The prepared private dataset has 445 club/country entries, 3,334 players and 263 individual foreign club crests. Original German rosters and all 2,574 Original player word records are preserved by assertions during preparation. The visual review identified 175 usable supplied foreign crests and 88 missing/shared Original placeholders. Those 88 now have explicit fictional club-specific monograms instead of the computer symbol; the updated crest preparation uses the bright Original background texture and preserves black logo details. Donor fields retain their real/fictional provenance. No original game content is committed here.
Validation: 37 configured synthetic tests executed successfully, with 158 external-input tests explicitly skipped; four offline preparation tests passed. Extended save/reload and both cross-profile rejection paths passed. Two separate season-end snapshots each contain every fixture in all nine leagues. A Classic 80-turn run produces a byte-identical save to stable 1.0.2. Screenshots and saves are archived privately. Native platform CI also builds and tests Windows x64, macOS ARM64 and Linux x64; release QA receipts identify the exact successful revision. See [FORMAT.md](FORMAT.md) for dimensions, preparation and distribution boundaries. A development commit is not a completed release claim.
The next community package uses a data-only `COMMUNITY.OBD` bundle and no DOS executables. See [STANDALONE.md](STANDALONE.md). The Windows community ZIP omits source archives and loose PNG/JPEG studies; corresponding sources remain available separately.
-51
View File
@@ -1,51 +0,0 @@
# Editor 0.5.1 — ratings and salaries
These are actual 1440×900 SDL2/OpenGL/RmlUI captures on Linux under Xvfb
with software OpenGL. All content is the synthetic `World::demo()` fixture:
52 invented players, two invented clubs, one league and 50 explicitly synthetic
per-season contracts (one unknown salary per club). No real-world data, original
game images, personal paths, settings or credentials are included. This editor
uses starting worlds, not a career save; reproduce the data with `--demo`.
| View | Evidence |
|---|---|
| Before, released Editor 0.5.0 | [Player inspector](before-players-0.5.0.png), without a ratings/payroll overview |
| Players, Midnight Glass / German | [Salary descending](players-midnight-de.png) |
| Teams, Silver Glass / English | [Player-weighted means, payroll and coverage](teams-silver-en.png) |
| Leagues, Matchday / German | [League aggregate](leagues-matchday-de.png) |
| Attribute selection | [Choose columns](columns-midnight-de.png) |
| Horizontal navigation | [Further attributes](players-scroll-midnight-de.png); header and values remain aligned |
The after views use Editor 0.5.1. The before capture uses the released 0.5.0
Linux executable and its own assets. No screenshot is a browser mockup.
Validation:
- `editor_core_tests`, `editor_comparison_tests`, `editor_version` pass locally.
The comparison suite checks 36 outcomes, including actual currency units,
unknown versus zero salaries, date/team selection, conflicting contracts,
staff exclusion, complete reserves, duplicate evidence, player-weighted means,
coverage, empty groups, numeric sorting across more than 200 rows, stable ties,
nulls last in both directions, different rating systems, overflow, read-only
session state, cache refresh after editing/undo and the shared MCP tool.
- `tests/editor_gui_smoke.py` performs real keyboard/mouse operations. It selects
a rating column via its label, sorts ratings and salaries, opens the first row
and edits it. MCP verifies the expected stable player/club/league identifier
changed, then undoes it. The existing inspector/search/JSON/undo/save checks
still pass. The comparison leaves the saved world clean.
- All three themes and both languages were inspected. Header arrows do not rely
on missing font glyphs; horizontal scrolling keeps column alignment.
- The completed private season was checked independently: 18,920 eligible
player rows, 545 teams, 32 leagues; 832 source-only duplicate rows excluded.
Every eligible player has one known current-team salary in that package.
These are dataset estimates, not verified real wages. No private rows or
screenshots are distributed in this public directory.
Build the targets and run the CTest commands in [the editor guide](../../EDITOR.md).
For the native input test, run `python3 tests/editor_gui_smoke.py <OpenBMHEditor>`
inside a graphical session or Xvfb with xdotool. `OpenBMHEditor --demo --page
comparison` opens the overview; the three buttons choose players, teams or
leagues. **Choose columns** selects additional attributes.
Windows/macOS native build and core tests run in the editor CI. The Linux
window checks do not establish human acceptance on those operating systems.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 203 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 149 KiB

-27
View File
@@ -1,27 +0,0 @@
# Native read-only image preview
Editor 0.5.3, captured from the native RmlUI application at 1440×900.
All pictures and records are authored synthetic demo data. No game installation,
real crest, portrait, savegame or personal profile is included.
| View | Native screenshot |
|---|---|
| Before: small image in the club inspector | [Club inspector](before-club-image.png) |
| After: large read-only preview, Midnight / German | [Midnight](preview-midnight-de.png) |
| Silver / English | [Silver](preview-silver-en.png) |
| Matchday / German | [Matchday](preview-matchday-de.png) |
| Jump to the exact linked image record | [Linked asset](linked-asset.png) |
Clicking the inspector image or a list thumbnail opens the same viewer. Images
retain their aspect ratio; there are no editing controls. Close, the window's
close button and Escape return to the current form. **View asset** opens the
linked asset, clearing unrelated country/league/team filters. Composed Classic
portraits without a single backing asset offer the general image library.
`tests/editor_gui_smoke.py` exercises the actual mouse and keyboard path. MCP
observes that opening/closing the preview leaves the world and history unchanged.
The test also preserves a pending property draft, cancels a guarded asset jump,
checks the selected club's exact asset, and opens the different asset from an
unselected row. These checks complement the core, comparison and regulations
tests. The synthetic demo starts unsaved; the asterisk in these captures reflects
that initial state rather than a modification caused by the preview.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

-84
View File
@@ -1,84 +0,0 @@
# Native editor POC — QA evidence
All images here contain **synthetic demo data and project-owned geometric
artwork**. No real club, player photograph, original game screen, imported game
artwork, local filesystem path or MCP credential is included. These exact
reviewed image hashes are allowlisted by the public-tree check.
| Screenshot | Coverage |
|---|---|
| [Clubs](clubs-midnight-de.png) | Native RmlUI master/detail view, Midnight Glass, German |
| [Players](players-silver-en.png) | Silver Glass, English interface, retained authored German demo names |
| [Squads](roster-matchday-de.png) | Matchday theme, full squads and optional 24-row view |
| [Search](gui-search.png) | Actual keyboard input, focus retained across filtering |
| [Options](options-midnight-de.png) | Language, theme, integrated MCP toggle/port |
| [Image editor](image-editor-midnight-de.png) | Source-preserving crop, free rotation and mirroring; the demo's geometric SVG crest |
## Theme comparison
The three editor palettes follow the modern game's submenu colours. Midnight
uses a slate-grey gradient and restrained mint accents, Silver pale silver-blue
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 |
|---|---|---|---|
| Midnight Glass | [View](clubs-midnight-de.png) | [View](options-midnight-de.png) | [View](image-editor-midnight-de.png) |
| Silver Glass | [View](clubs-silver-de.png) | [View](options-silver-de.png) | [View](image-editor-silver-de.png) |
| Matchday | [View](clubs-matchday-de.png) | [View](options-matchday-de.png) | [View](image-editor-matchday-de.png) |
[Previous Midnight view](https://github.com/Weyoune/openbmh/blob/fcf6092063c2354dec400462d5fa0c7dda3afe11/docs/qa/editor-poc/clubs-midnight-de.png)
provides the before image for the change from saturated navy to the submenu
palette. Data and layout are identical.
Environment: Debian 13 x86-64; actual SDL2/OpenGL/RmlUI window inside Xvfb,
software OpenGL requested with `LIBGL_ALWAYS_SOFTWARE=1`; 1440×900 window.
These are native application captures, not HTML/browser mockups.
Validation performed:
- `editor_core_tests`: 59 assertions for edit/rollback, revision conflicts,
references, dates/scales, roster moves/swaps/order, shared undo/redo/save
checkpoint, atomic OBW overwrite, exact image originals, arbitrary SVG/raster
transforms, unknown-extension preservation and authenticated MCP HTTP.
Individual image edits also verify that shared fallback images and other
records remain unchanged.
Windows additionally checks a profile directory containing non-ASCII letters.
- `tests/editor_gui_smoke.py`: real mouse/keyboard inspector edit; untouched
JSON colour field retained; native search focus; shared MCP/native undo/redo;
save to OBW. This check caught and fixed RmlUI textarea entity handling and
select-initialization refresh loops.
- Native theme QA: switch Midnight → Silver → Matchday → Midnight through the
actual Options dropdown and Apply button; verify persisted settings and
compare rendered body, list and inspector pixels against a fresh startup
in each theme. Reopen the editor using the saved preference. Inspect the
Options popup, rejected invalid port input, dashboard, players, review,
history and image editor in each palette. The rejected input leaves the
saved options unchanged. No new platform GUI claim is implied.
- Private local checks, whose data is not published here: raw BMH and raw
Football Limited import, existing converted Classic OBWs, save/reopen, frozen
Classic portrait composition, and the large private merged 32-league world.
Structural checks passed; missing biographies/source conflicts remain
explicit warnings.
- Manifest/table JSON schemas checked against the private Classic-derived and
merged-world outputs. This is separate from runtime reference/range checks.
Reproduce the synthetic view from a configured build:
```sh
OpenBMHEditor --demo --page clubs --screenshot clubs.png --quit-after-ms 1800
```
The synthetic data is generated by `World::demo()`, not a career save. Options
files used for captures are local QA profiles and are not included. The image
editor captures use the demo's geometric SVG crest. Earlier history also
contains a synthetic portrait made from a blue rectangle, circular head and
rounded shoulders; no real or AI-generated player photo is used.
Windows x64/macOS ARM64 build and core/MCP checks are run by the separate
**OBW Editor POC** workflow. A CI pass is not a human GUI acceptance test on
either platform.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 93 KiB

Loaded 100 of 363 files, more files were not shown because too many files have changed in this diff. Show more