Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
221478b629 | ||
|
|
a447d9282a | ||
|
|
6636308cad | ||
|
|
b8183e4165 | ||
|
|
a475c1ba80 | ||
|
|
fcf6092063 | ||
|
|
f128a46104 | ||
|
|
056ac8ebea | ||
|
|
ef111342f9 | ||
|
|
b199f67eec | ||
|
|
bde8b10762 | ||
|
|
56b91ddca0 | ||
|
|
4f8e296f86 | ||
|
|
b868a236ea | ||
|
|
7ea00c7046 | ||
|
|
faaecf2eb2 | ||
|
|
906cce902d | ||
|
|
6e5fa72ed5 | ||
|
|
74ca973111 | ||
|
|
8aa849e9fa | ||
|
|
00f522c1f3 | ||
|
|
0b2354c979 | ||
|
|
978a014b87 | ||
|
|
481b525582 | ||
|
|
2552528176 | ||
|
|
3a021fc160 | ||
|
|
65b087c1d0 | ||
|
|
e1d17d8f81 | ||
|
|
7eff8a34f8 | ||
|
|
8326a23274 | ||
|
|
9bff07828a |
No files matched your search
@@ -3,7 +3,7 @@ name: Build without game data
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
branches: [main, assist/codex-0.2-launcher]
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
@@ -37,7 +37,7 @@ jobs:
|
||||
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
|
||||
- name: Verify source export
|
||||
run: python3 tools/public_release/check_public_tree.py --root . --history
|
||||
run: python3 tools/public_release/check_public_tree.py --root . --history --revision HEAD
|
||||
- name: Set up MSVC x64
|
||||
if: runner.os == 'Windows'
|
||||
uses: ilammy/msvc-dev-cmd@a102174a2b586eec2ea151a69e6fd14404a8ce7c # v1.13.0
|
||||
|
||||
@@ -0,0 +1,113 @@
|
||||
# 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 -DOPENBMH_BUILD_EDITOR=ON -DBMH_DATA= "${args[@]}"
|
||||
- name: Build editor and synthetic tests
|
||||
run: cmake --build build --target openbmh_editor editor_core_tests editor_comparison_tests --parallel 2
|
||||
- name: Native editor core and MCP tests
|
||||
run: ctest --test-dir build -C Release -R "^editor_(core_tests|comparison_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
|
||||
- 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)
|
||||
@@ -27,14 +27,23 @@ jobs:
|
||||
path: dist
|
||||
merge-multiple: true
|
||||
- name: Create draft for review
|
||||
shell: python
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
RELEASE_TAG: ${{ github.ref_name }}
|
||||
run: |
|
||||
for package in dist/*.zip; do
|
||||
case "$(basename "$package")" in
|
||||
OpenBMH-${RELEASE_TAG#v}-*.zip) ;;
|
||||
*) echo "Release tag and package version differ" >&2; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
gh release create "$RELEASE_TAG" dist/*.zip --draft --verify-tag --title "OpenBMH $RELEASE_TAG" --notes-file docs/release/0.1/RELEASE_NOTES.md
|
||||
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)
|
||||
@@ -1,6 +1,11 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-only
|
||||
cmake_minimum_required(VERSION 3.24)
|
||||
project(OpenBMH VERSION 0.1.2 LANGUAGES CXX C)
|
||||
project(OpenBMH VERSION 0.2.0 LANGUAGES CXX C)
|
||||
if(APPLE)
|
||||
enable_language(OBJC OBJCXX)
|
||||
set(CMAKE_OBJCXX_STANDARD 20)
|
||||
set(CMAKE_OBJCXX_STANDARD_REQUIRED ON)
|
||||
endif()
|
||||
# the one place of the version: --version of both programs and the window title (src/version.hpp)
|
||||
add_compile_definitions(OPENBMH_VERSION="${PROJECT_VERSION}")
|
||||
|
||||
@@ -196,6 +201,10 @@ 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/palette.cpp
|
||||
src/formats/vga.cpp
|
||||
src/formats/font.cpp
|
||||
@@ -264,10 +273,10 @@ else()
|
||||
target_compile_options(bmhcore PRIVATE -Wall -Wextra)
|
||||
endif()
|
||||
|
||||
add_executable(openbmh src/main.cpp)
|
||||
target_link_libraries(openbmh PRIVATE bmhcore ${BMH_SDL_TARGET})
|
||||
add_executable(openbmh_inspect src/main.cpp)
|
||||
target_link_libraries(openbmh_inspect PRIVATE bmhcore ${BMH_SDL_TARGET})
|
||||
if(MSVC)
|
||||
target_compile_options(openbmh PRIVATE /utf-8)
|
||||
target_compile_options(openbmh_inspect PRIVATE /utf-8)
|
||||
endif()
|
||||
|
||||
# --- Game data launcher (src/launch): find, unpack and check the original game data ---------
|
||||
@@ -316,6 +325,12 @@ 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)
|
||||
@@ -438,10 +453,15 @@ add_executable(openbmh_play
|
||||
src/app/main.cpp
|
||||
${BMH_APP_CONTROLLER_SOURCE}
|
||||
${BMH_APP_SESSION_SDL_SOURCE})
|
||||
target_link_libraries(openbmh_play PRIVATE bmhui bmhlaunch_dialog openbmh_audio ${BMH_SDL_TARGET})
|
||||
target_link_libraries(openbmh_play PRIVATE bmhui bmh_launcher 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)
|
||||
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()
|
||||
if(MSVC)
|
||||
target_compile_options(openbmh_play PRIVATE /utf-8)
|
||||
# App sources also compile in headless tests/helpers without target /utf-8.
|
||||
@@ -621,7 +641,7 @@ add_executable(openbmh_cli
|
||||
src/cli/seat_hub.cpp
|
||||
src/cli/json.cpp
|
||||
${BMH_APP_SESSION_SOURCE})
|
||||
target_link_libraries(openbmh_cli PRIVATE bmhui bmhlaunch)
|
||||
target_link_libraries(openbmh_cli PRIVATE bmh_launcher bmhui bmhlaunch)
|
||||
if(WIN32)
|
||||
target_link_libraries(openbmh_cli PRIVATE ws2_32) # --listen (Winsock)
|
||||
endif()
|
||||
@@ -1048,12 +1068,15 @@ 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)
|
||||
install(DIRECTORY docs/ DESTINATION docs COMPONENT Runtime PATTERN "qa" EXCLUDE)
|
||||
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)
|
||||
@@ -1069,6 +1092,25 @@ if(MSVC)
|
||||
endif()
|
||||
add_test(NAME launch_unit_tests COMMAND launch_unit_tests)
|
||||
|
||||
add_executable(fltd_translation_unit_tests tests/fltd_translation_unit_tests.cpp)
|
||||
target_link_libraries(fltd_translation_unit_tests PRIVATE bmhlaunch)
|
||||
add_test(NAME fltd_translation_unit_tests COMMAND fltd_translation_unit_tests)
|
||||
|
||||
add_executable(host_path_display_unit_tests tests/host_path_display_unit_tests.cpp)
|
||||
target_include_directories(host_path_display_unit_tests PRIVATE src)
|
||||
if(MSVC)
|
||||
target_compile_options(host_path_display_unit_tests PRIVATE /utf-8)
|
||||
endif()
|
||||
add_test(NAME host_path_display_unit_tests COMMAND host_path_display_unit_tests)
|
||||
|
||||
add_executable(quit_confirmation_unit_tests tests/quit_confirmation_unit_tests.cpp)
|
||||
target_include_directories(quit_confirmation_unit_tests PRIVATE src)
|
||||
target_link_libraries(quit_confirmation_unit_tests PRIVATE ${BMH_SDL_TARGET})
|
||||
if(MSVC)
|
||||
target_compile_options(quit_confirmation_unit_tests PRIVATE /utf-8)
|
||||
endif()
|
||||
add_test(NAME quit_confirmation_unit_tests COMMAND quit_confirmation_unit_tests)
|
||||
|
||||
add_executable(fixture_table_tests tests/fixture_table_tests.cpp)
|
||||
target_link_libraries(fixture_table_tests PRIVATE bmhcore)
|
||||
add_test(NAME fixture_table_unit_tests COMMAND fixture_table_tests)
|
||||
@@ -1077,8 +1119,10 @@ 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)
|
||||
foreach(dependency IN ITEMS SDL2 miniz lzma_sdk nfd rmlui freetype)
|
||||
string(REPLACE "\\" "/" dependency_path "${${dependency}_SOURCE_DIR}")
|
||||
if(dependency STREQUAL "SDL2" AND sdl2_SOURCE_DIR)
|
||||
set(dependency_path "${sdl2_SOURCE_DIR}")
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
# OpenBMH
|
||||
|
||||
The separate [OpenBMH Editor 0.5.1](docs/EDITOR.md) uses native RmlUI,
|
||||
supports German/English, three themes, image editing and a local MCP server.
|
||||
Download its own `editor-v0.5.1` release or build with
|
||||
`-DOPENBMH_BUILD_EDITOR=ON`. Edited worlds are independent of the Classic runtime.
|
||||
|
||||
A modern and faithful open source rebuild of the *Bundesliga Manager Hattrick* engine.
|
||||
|
||||
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.
|
||||
|
||||
The engine reads a game installation supplied by the player. 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -12,18 +17,26 @@ 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.
|
||||
|
||||
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_play` (`openbmh_play.exe` on Windows). Select the game directory or executable when prompted. A ZIP or 7z containing one game installation can also be selected.
|
||||
These instructions describe **0.2.0**, released separately from the editor. See the [0.2 release notes](docs/release/0.2/RELEASE_NOTES.md).
|
||||
|
||||
From a terminal:
|
||||
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:
|
||||
|
||||
```sh
|
||||
openbmh_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves"
|
||||
./OpenBMH --mod "mods/BMH-classic/content.obw"
|
||||
./openbmh_cli --console --mod "mods/BMH-classic/content.obw"
|
||||
```
|
||||
|
||||
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 [0.1 release notes](docs/release/0.1/RELEASE_NOTES.md).
|
||||
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.
|
||||
|
||||
The launcher uses SDL2, RmlUI and OpenGL 3.3 (macOS: OpenGL 4.1); 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.
|
||||
|
||||
## Features and direction
|
||||
|
||||
@@ -31,9 +44,11 @@ The graphical client and console share career management, matches, transfers, co
|
||||
|
||||
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.
|
||||
|
||||
## Build from source
|
||||
|
||||
The following recipes target v0.1.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 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.
|
||||
|
||||
Clone the public repository, then run the commands for your system:
|
||||
|
||||
@@ -50,7 +65,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_play.exe --data "path/to/game" --save-directory "path/to/saves"
|
||||
.\build-windows\Release\OpenBMH.exe
|
||||
```
|
||||
|
||||
### Linux
|
||||
@@ -62,7 +77,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_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
./build-linux/OpenBMH
|
||||
```
|
||||
|
||||
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.
|
||||
@@ -77,7 +92,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_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
./build-macos/OpenBMH
|
||||
```
|
||||
|
||||
On Intel Macs omit the arm64 setting or select `x86_64`. These commands build terminal executables; they do not create a signed application bundle.
|
||||
@@ -103,6 +118,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 this version. 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.
|
||||
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.
|
||||
|
||||
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).
|
||||
@@ -10,9 +10,21 @@ 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. 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
<!-- 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>
|
||||
@@ -0,0 +1,272 @@
|
||||
/* 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; }
|
||||
.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; }
|
||||
#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); }
|
||||
@@ -0,0 +1,45 @@
|
||||
<!-- 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>
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"asset": "stadium.tga",
|
||||
"sha256": "fb8e5f1f86afe60de87b70a2f533690d1ef470241fa24ee4384ff000149edaab",
|
||||
"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."
|
||||
}
|
||||
|
After Width: | Height: | Size: 4.5 MiB |
@@ -0,0 +1,74 @@
|
||||
/* 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; }
|
||||
@@ -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 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.
|
||||
Requirements: a C++20 compiler, CMake 3.24 or newer, Git and a supported build tool such as Ninja. The CMake project fetches pinned SDL2, miniz, 7-Zip C decoder, nativefiledialog-extended, RmlUi and FreeType sources. Network access is needed on the first configure unless these dependencies are supplied locally. Nuked OPL3 is included in the source tree.
|
||||
|
||||
```sh
|
||||
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
|
||||
@@ -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_play` (graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
|
||||
Main programs are `OpenBMH` (native launcher and graphical game) and `openbmh_cli` (console and protocol). Single-configuration generators put them in the build directory; multi-configuration generators normally add a configuration directory. On Windows they have the `.exe` suffix.
|
||||
|
||||
## Windows
|
||||
|
||||
@@ -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 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.
|
||||
Install a C++20 compiler, Git, CMake, Ninja, pkg-config and the development packages required by SDL2 and the folder-dialog backend. The RmlUI launcher uses SDL2/OpenGL; its native folder picker uses GTK3 on Linux. For example, Debian-family development packages include `build-essential`, `cmake`, `ninja-build`, `git`, `pkg-config`, `libgl1-mesa-dev` and `libgtk-3-dev`; SDL2's selected video/audio backends may need additional development libraries. RmlUI and FreeType are built from pinned sources without installing them separately. Keep the generated `assets/launcher` directory alongside OpenBMH when copying a development build.
|
||||
|
||||
The common commands above build the bundled SDL2. To use an installed SDL2 CMake package instead, configure with `-DBMH_USE_SYSTEM_SDL2=ON`. Its version and backend configuration then come from the installed package.
|
||||
|
||||
@@ -42,11 +42,13 @@ ctest --test-dir build-macos --output-on-failure
|
||||
|
||||
Use native toolchain/dependency architectures consistently. A terminal executable and a Finder-launchable, signed `.app` package are different deliverables. The commands describe the build procedure, not a claim that a particular Windows or macOS binary has passed native acceptance.
|
||||
|
||||
## Run with your data
|
||||
## Import and run your data
|
||||
|
||||
Start the native launcher, choose **Add**, and select your original installation. Content and personal files are portable beside the executable. The original installation is needed only for import. See the [0.2 contract](formats/obw/runtime-0.2.md).
|
||||
|
||||
```sh
|
||||
build/openbmh_play --data "path/to/game" --save-directory "path/to/saves"
|
||||
build/openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --seed 1
|
||||
build/OpenBMH
|
||||
build/openbmh_cli --console --mod "build/mods/BMH-classic/content.obw" --seed 1
|
||||
```
|
||||
|
||||
For redistribution, include [LICENSE](../LICENSE), [THIRD_PARTY_NOTICES.md](../THIRD_PARTY_NOTICES.md), the full texts in [licenses/](licenses/README.md), and the corresponding source and build information required by the applicable licenses. Inspect the actual libraries in each platform package; static SDL2 alone does not establish that every dependency is static.
|
||||
@@ -12,6 +12,17 @@ Intentional changes in code should use the marker `OpenBMH deviates from the ori
|
||||
|
||||
The [generated differences catalogue](DIFFERENCES.md) lists these markers with links to their source files.
|
||||
|
||||
## Application exit confirmation
|
||||
|
||||
Closing the window, exiting with Escape or confirming the desktop's exit control
|
||||
opens a native confirmation dialog. BMH data uses German text and Football
|
||||
Limited data uses English. Enter, Escape and closing the confirmation cancel the
|
||||
exit; only the explicit Quit/Beenden button permits normal shutdown. Cancelling
|
||||
keeps the current dialog or match owner alive without a turn or implicit save.
|
||||
An unavailable native message box also cancels the request. This applies to
|
||||
voluntary application exits, including quit events received during animations;
|
||||
normal completed-career handling remains separate.
|
||||
|
||||
## Environment and presentation in 0.1.2
|
||||
|
||||
The desktop environment provides three youth teams and three staff
|
||||
@@ -35,3 +46,20 @@ instead of an added fixed pause. A9 and the existing scene delays can be adjuste
|
||||
in Settings; loaded saves and EIN files retain their chosen speeds. VGA retrace
|
||||
animations use a 70-Hz reference instead of the host monitor's refresh rate.
|
||||
`--live-frame-ms` and `BMH_LIVE_FRAME_MS` remain explicit diagnostic overrides.
|
||||
|
||||
## Native data and saves in 0.2
|
||||
|
||||
Classic imports preserve the supported BMH and Football Limited structures in sealed OBW
|
||||
packages. The normal runtime no longer reads the original installation. Package integrity
|
||||
failures require reimport; Classic overlays and manual content editing are unsupported.
|
||||
|
||||
Native saving and autosaving consume no random numbers. The FBM writer previously drew
|
||||
four Watcom values for its encryption envelope, so future results after a legacy save
|
||||
operation can differ. A native save/load pair preserves both generators and their draw
|
||||
counts exactly. Original saves lack the clock-seeded Watcom state; migration derives its
|
||||
initial value reproducibly from the source file and records the full state thereafter.
|
||||
|
||||
The launcher start year affects displayed years only. Classic weekdays and season timing
|
||||
retain their existing cycle. Imported careers keep the valid year in their own save header.
|
||||
The launcher exits without confirmation; the running game's existing exit confirmation
|
||||
remains in effect and returns control to the launcher after a confirmed exit.
|
||||
@@ -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 --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 a single process, start `openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves"`. Send command lines on stdin and finish each block with `go.`. `--json` provides structured output records.
|
||||
|
||||
For separate manager processes, start a local mailbox server:
|
||||
|
||||
```sh
|
||||
openbmh_cli --console --data "path/to/game" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
|
||||
openbmh_cli --console --mod "mods/BMH-classic/content.obw" --saves "path/to/saves" --serve mailbox --seats 4 --seed 1
|
||||
```
|
||||
|
||||
A client sends one block on stdin to:
|
||||
|
||||
@@ -6,6 +6,8 @@ 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.
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
# OpenBMH Editor 0.5.1
|
||||
|
||||
Der eigenständige, native Editor verwendet **RmlUI, SDL2 und OpenGL**. Er bearbeitet Startdatenbanken, keine laufenden Spielstände. Das Spiel und seine Classic-Prüfung bleiben unverändert. Editor 0.5.1 hat eine eigene Versionsreihe und den Release-Tag `editor-v0.5.1`; die Spielversion ist 0.2.0.
|
||||
|
||||
## Starten und Daten öffnen
|
||||
|
||||
Das vollständige Paket `OpenBMHEditor-0.5.1-<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.
|
||||
- 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.
|
||||
|
||||
**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_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`.
|
||||
|
||||
## 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. Die Grafikausgabe benötigt OpenGL 3.3, auf 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 --parallel 2
|
||||
ctest --test-dir build-editor -C Release -R '^editor_(core_tests|comparison_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.
|
||||
|
||||
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.
|
||||
|
||||
In **Options**, switch the interface to **English**, choose one of the three themes, and enable/disable the integrated local MCP server. **Copy connection** provides the authenticated configuration. The server defaults to loopback port 8765; use port 0 for a free port. GUI and MCP share the same world, validation and undo history. It supports MCP Streamable HTTP 2025-11-25/2025-06-18 and optional stdio mode. Use `expected_revision` for concurrent edits.
|
||||
|
||||
Build with the three commands above, including `-DOPENBMH_BUILD_EDITOR=ON`. The native application requires OpenGL 3.3 (macOS 4.1) and the platform development dependencies documented in the main README. Editor 0.5.1 is unsigned and does not bundle any real-world dataset or proprietary game assets.
|
||||
@@ -0,0 +1,163 @@
|
||||
# Engine split: Classic, Classic Extended and Modern
|
||||
|
||||
Status: **concept and migration plan**. It prepares one shared match engine under three season engines. 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`) | The current engine: fixed calendar, 9 leagues, original competition structure and rules | Classic 320×200 interface | Essentially complete |
|
||||
| **Classic Extended** | Classic data plus extension data | Classic engine with optional, switchable extensions | Classic interface plus additional screens in the same style | Not started |
|
||||
| **Modern** | Typed OBW worlds (imported or own) | New engine: generated calendar, data-driven leagues and competitions, playable foreign leagues | New high-resolution interface (RmlUi) | 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.
|
||||
|
||||
## 2. Target architecture
|
||||
|
||||
```
|
||||
Classic UI Classic Extended UI Modern UI (RmlUi)
|
||||
\ | /
|
||||
+-------- app / protocol layer -------+ variant capabilities
|
||||
/ | \
|
||||
season: classic season: classic + extensions season: modern
|
||||
(GameState image) (GameState image + ext state) (typed OBW model)
|
||||
\ | /
|
||||
+------ 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` | Extension modules on top of Classic (§4) | `bmh_season_classic` |
|
||||
| `bmh_season_modern` | New season engine on the typed OBW model (§5) | `bmh_match`, `bmh_world` |
|
||||
| `bmh_world` | Typed OBW model, reader/writer, validator, importers (`src/import`) | `bmhcore` formats |
|
||||
|
||||
The dependency rule: **the match engine knows no season engine**, and no season engine reaches into another one's state.
|
||||
|
||||
## 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 and Classic Extended already store 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
|
||||
|
||||
Classic Extended is **Classic plus switchable extensions**:
|
||||
|
||||
- It runs on the Classic season engine and the Classic save layout, plus one additional state block for extensions (`x-extended/` in OBW saves).
|
||||
- Each extension is a module with an id, a version, its own state, its rules and its screens. A career records which extensions it uses.
|
||||
- **Invariant:** with every extension switched off, Classic Extended produces exactly the Classic results. A test runs the Classic regression through the Extended engine with no extensions.
|
||||
- Extensions hook into defined points of the Classic turn (start/end of day, week, month, season; before/after matchday; desk actions), never into the middle of a Classic routine.
|
||||
- Its screens use the classic interface toolkit (`src/ui`), in the same resolution and style.
|
||||
- Candidates for first extensions: the environment ("Umfeld") menu of a later DIAMOND release (reviewed against our rule base, documented as a deviation), more statistics and history screens, quality-of-life automation, configurable rule values (roadmap 0.3).
|
||||
|
||||
## 5. Modern
|
||||
|
||||
Modern is a new season engine on the typed OBW model (`docs/formats/OBW.md`):
|
||||
|
||||
- **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; up to 32 leagues; 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, documented 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"]` or `["runtime:modern-v1"]`, plus `match@1`.
|
||||
- `CareerSession` selects the season engine from the manifest; the protocol reports **capabilities** per variant, so interfaces and console clients only offer supported actions.
|
||||
- Conversions are **one-way**: Classic → Classic Extended (switch on extensions), Classic or Classic Extended → Modern (convert to the typed model). There is no way back, and the original file is kept.
|
||||
- Legacy `.FBM` saves stay Classic.
|
||||
|
||||
## 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 | Variant field in manifests, engine selection in `CareerSession`, capability reporting in the protocol | Classic unchanged; capability tests |
|
||||
| 6 | Classic Extended skeleton: extension registry, hook points, `x-extended` state, "all extensions off = Classic" test | Regression identical through Extended |
|
||||
| 7 | Modern season engine on `bmh_world`, first with one nation and the shared match engine, then the competition model, then foreign leagues | Modern plausibility runs |
|
||||
| 8 | First Classic Extended extensions; Modern feature growth | Per extension/feature |
|
||||
|
||||
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.
|
||||
|
||||
## 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:** Classic regression through the Extended engine with no extensions.
|
||||
- **Modern plausibility:** bulk season simulations with goal, points and money distributions compared to Classic as a reference band.
|
||||
- **Dependency check:** the build fails if `bmh_match` includes season or `GameState` headers.
|
||||
|
||||
## 9. Open decisions
|
||||
|
||||
- Whether Classic Extended may change the save layout for its extensions only in OBW saves or also offer a legacy `.FBM` export (proposal: OBW only).
|
||||
- Whether Modern keeps `bmh-classic@1` as its only player attribute set at first (proposal: yes, richer attributes later).
|
||||
- Which team owns which variant: Classic and the split (engine/integration), Modern interface (UI), Classic Extended extensions (both, per module).
|
||||
@@ -10,9 +10,18 @@ Career management, matches, finances, transfers, original-style SDL2 screens, au
|
||||
|
||||
Complete edition-specific loading, presentation, competitions and sound support. Imported content determines names, text, clubs and league organisation; a shared engine rule base defines the simulation.
|
||||
|
||||
## 0.2: open data and typed state
|
||||
## 0.2: portable Classic content and native saves
|
||||
|
||||
Introduce a documented import format and a native save format, retaining supported legacy import where practical. The format concept is [OBW](formats/OBW.md). Replace fixed-layout state gradually with typed clubs, players, contracts and competitions. Keep each intermediate stage usable and cover transitions with tests.
|
||||
Import a supplied BMH or Football Limited installation through the launcher into a
|
||||
sealed [OBW](formats/OBW.md) Classic mod. Run the original-style interface and
|
||||
console exclusively from converted content, with native careers and preferences
|
||||
stored separately. Legacy save migration is an import operation. See the
|
||||
[0.2 release notes](release/0.2/RELEASE_NOTES.md) and
|
||||
[runtime contract](formats/obw/runtime-0.2.md).
|
||||
|
||||
Modern game screens are deferred. The Modern UI POC remains separate from the
|
||||
0.2 distribution. Replacing the remaining compatibility blocks with typed clubs,
|
||||
players, contracts and competitions is subsequent work, not a completed 0.2 claim.
|
||||
|
||||
## 0.3: configurable rules
|
||||
|
||||
|
||||
@@ -12,7 +12,9 @@ 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` | Locating user data, archive extraction, edition normalisation and file selection |
|
||||
| `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 |
|
||||
|
||||
`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.
|
||||
|
||||
@@ -24,6 +26,8 @@ Some calendar operations need synchronous human decisions. Their presenters own
|
||||
|
||||
## Calendar and matches
|
||||
|
||||
The planned split into one shared match engine and three season engines (Classic, Classic Extended, 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
|
||||
@@ -37,3 +41,27 @@ 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 upstream SDL2/OpenGL renderer
|
||||
on all desktop platforms. 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.
|
||||
@@ -1,6 +1,31 @@
|
||||
# OBW: OpenBMH world, save and pack format (concept, format version 1.0)
|
||||
# OBW: OpenBMH world, save and pack format
|
||||
|
||||
Status: **concept** for roadmap 0.2 (open data and typed state) with preparation for 0.4 (scalable interface, content packs). Nothing here is implemented yet; the legacy formats in this directory remain authoritative for the current engine.
|
||||
## 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
|
||||
|
||||
@@ -16,14 +41,15 @@ Goals:
|
||||
Non-goals of version 1.0:
|
||||
|
||||
- The match engine and its parameters (reserved namespace `x-matchengine`, see §3.3).
|
||||
- Network play, an editor application and a binary encoding (reserved, see §2.4).
|
||||
- Network play and a binary encoding (reserved, see §2.4). The separate editor
|
||||
uses the additive 1.1 profile described above.
|
||||
- Layout or screen data. Interfaces are themes (§9.6), not part of a world.
|
||||
|
||||
## 2. Container and files
|
||||
|
||||
### 2.1 Container
|
||||
|
||||
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents. The project already links miniz (`bmh_miniz`) and has a JSON reader/writer (`src/cli/json.cpp`), so the format needs no new dependency. JSON keeps worlds diffable and editable by hand or by script.
|
||||
Every OBW file is a ZIP archive (deflate or stored) containing UTF-8 JSON documents and referenced binary assets. The 1.1 editor reader also supports ZIP64, with its own documented size limits. The versioned Classic extension additionally permits data-only compatibility regions and startup input records; it does not permit executable code or save state in a world. The readers use miniz for the container; the editor additionally uses its declared JSON/image dependencies. Generic editor JSON remains editable by hand or script; sealed Classic packages must retain their original bytes and seals.
|
||||
|
||||
| Extension | `kind` | Contents |
|
||||
|---|---|---|
|
||||
@@ -50,7 +76,7 @@ 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/... packs and themes only, §9
|
||||
assets/... local Classic worlds, packs and themes, §9
|
||||
x-<name>/... extensions, §3.3
|
||||
```
|
||||
|
||||
@@ -112,6 +138,8 @@ Fields and directories whose name starts with `x-` belong to extensions (`x-matc
|
||||
|
||||
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.
|
||||
@@ -161,7 +189,8 @@ Teams without a squad (`foreign`, or `national` in a world that does not simulat
|
||||
|---|---|---|---|
|
||||
| `id` | string | R | |
|
||||
| `name` | object | R | `{"first": "...", "last": "...", "known_as": "..."}`, each a plain string; `known_as` optional |
|
||||
| `born` | date | R | Age is derived from the in-game date |
|
||||
| `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` |
|
||||
@@ -172,6 +201,18 @@ Teams without a squad (`foreign`, or `national` in a world that does not simulat
|
||||
| `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:
|
||||
|
||||
@@ -232,6 +273,7 @@ A competition is an ordered list of **stages**. Each stage takes teams from **sl
|
||||
"type": "league",
|
||||
"nation": "nation:de",
|
||||
"tier": 2,
|
||||
"trophy": "asset:comp/de-2/trophy",
|
||||
"season_cycle": 1,
|
||||
"stages": [{
|
||||
"id": "regular",
|
||||
@@ -348,7 +390,7 @@ Edition detection is the one the launcher already performs (`src/launch/game_dat
|
||||
|
||||
### 8.2 Mapping per edition
|
||||
|
||||
Every edition has a mapping table in the importer (to be published with it as `docs/formats/obw/import.md`):
|
||||
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 |
|
||||
|---|---|---|---|
|
||||
@@ -363,6 +405,8 @@ Cups, European cups, the indoor tournament, the English FA Cup with its qualifyi
|
||||
|
||||
### 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.
|
||||
@@ -388,6 +432,30 @@ Data never refers to file paths. It uses logical keys:
|
||||
| `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.
|
||||
@@ -395,9 +463,21 @@ A resolver looks a key up in the active packs by priority (§9.5), then in the w
|
||||
- **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).
|
||||
|
||||
**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.
|
||||
|
||||
@@ -19,7 +19,7 @@ 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 (concept) | `*.obw`, `*.obs`, `*.obp`, `*.obt` | [OBW](OBW.md) | Planned for 0.2 |
|
||||
| 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.
|
||||
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
# 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.
|
||||
|
||||
`classic-calendar@1` retains the complete source day table and bindings.
|
||||
`classic-season-calendar@1` applies options, season cycle, weekday alignment and
|
||||
leap-year behavior using the Classic calendar algorithm at runtime. Cup series
|
||||
bind calendar bit `competition_id + 5`; league series retain the edition's
|
||||
calendar-group binding. Dated fixtures cannot be exported before manager/options
|
||||
selection without changing the original start semantics.
|
||||
|
||||
## Artwork, portraits, fonts and audio
|
||||
|
||||
Every imported image has an indexed PNG for standard consumers plus a `.pixels`
|
||||
payload for the Classic adapter's exact palette-index operations. Dimensions and
|
||||
palette are explicit. The source VGA files themselves are not required. Crest
|
||||
keys bind stable club identities; the original generic crest is used where the
|
||||
Classic interface deliberately uses a fallback. Kit selectors and the complete
|
||||
relevant sprite sheets remain available.
|
||||
|
||||
`appearance` contains the source-name-derived result, computed with the same
|
||||
signed-byte/unsigned-seed arithmetic as `PlayerCardScreen::draw_portrait`, including
|
||||
its discarded initial draw. It never consumes the game's RNG streams. A rename
|
||||
changes the name, not the recipe. The set stores each part separately, preserving
|
||||
linear source-stride wrap at row edges, transparent index zero, layer order and
|
||||
offsets relative to the 38×38 background. It never stores composed faces.
|
||||
|
||||
Bitmap fonts store glyph locations, widths, advances, original alphabet bounds,
|
||||
baseline and exact bitmap bytes. The zero-width replacement glyph may point
|
||||
beyond the bitmap because it is never dereferenced. These fonts use the Classic
|
||||
byte encoding; new modern interface fonts remain a separate theme concern.
|
||||
|
||||
The four original ALPTRAUM audio containers are local binary assets with chunk
|
||||
metadata, consumed by the already implemented audio decoder. Music keeps its
|
||||
instrument/sequence data rather than being destructively flattened to a recording.
|
||||
Source frequency/operator tables remain in the Classic data regions. Optional
|
||||
FLI/FLC and editor artwork is retained as identified local artwork, without
|
||||
importing editor programs, user settings or saves.
|
||||
|
||||
## Reader, writer and checks
|
||||
|
||||
`bmh::obw::read` accepts ZIP/directory content and validates it. `load_classic`
|
||||
returns the read-only input model (`Database`, data-only `LeImage`, full `TextDb`,
|
||||
desktop/formation seeds, indexed images, palette, fonts and audio) independently
|
||||
of either game frontend. It does not create `GameState` or `CareerSession`.
|
||||
|
||||
Binary payloads are byte strings, not UTF-8 JSON strings. Paths are authored
|
||||
relative forward-slash paths. The reader rejects traversal, duplicate entries,
|
||||
symlinks in a directory, excessive sizes and unknown required profiles. The
|
||||
validator checks cross-references, complete stage/contract bindings, resource
|
||||
shapes, portrait indices and inventory. CRC32 detects accidental damage, not
|
||||
malicious modification. An editor deliberately changing a world must update its
|
||||
inventory (`refresh_classic_inventory`) and validate it before writing.
|
||||
|
||||
The installation test reconstructs from an OBW ZIP, then compares a complete
|
||||
first-season initialization in RAM against the existing legacy-load path:
|
||||
native state bytes and both RNG seeds/counts. It also compares every exported
|
||||
data-region byte and original atlas pixels, palette, fonts and audio. This proves
|
||||
content/startup preservation for the supplied installation and chosen test start;
|
||||
it does not claim an implemented 0.2 adapter, native-platform testing, a fully
|
||||
played season or savegame conversion.
|
||||
@@ -0,0 +1,133 @@
|
||||
# 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.
|
||||
|
||||
## Sources, conflicts and images
|
||||
|
||||
- `x-source/` can contain unchanged or losslessly gzipped normalized source
|
||||
tables, input hashes, source-to-projection identifiers and identity evidence.
|
||||
References include package-local file paths and JSON pointers. Sources do
|
||||
not become authoritative merely by being present.
|
||||
- `x-editor/review.json` has `items` with `id`, `reason`, `resolved`, optional
|
||||
`table`, `entity`, `field` (JSON pointer), and `alternatives` with `value` and
|
||||
source descriptions. Choosing a value updates its target plus the review
|
||||
record in one undoable transaction. Original alternatives remain.
|
||||
- Raster and SVG sources are stored unchanged. Identity imports preserve exact
|
||||
bytes. Edits use a normalized recipe: `angle` degrees, `flip_x`, `flip_y`,
|
||||
`crop: {x,y,width,height}`. Mirroring precedes clockwise rotation; rotation
|
||||
expands the canvas; crop coordinates refer to that expanded canvas. Values
|
||||
are finite, crop dimensions positive and inside [0,1]. JSON floating-point
|
||||
values must survive round trips.
|
||||
- An edited asset's `x-editor` stores `original`, `original_sha256` and
|
||||
`transform`. Originals live in `x-editor/originals/`, rendered files in
|
||||
`assets/edited/`, addressed by SHA-256. Raster edits are PNG with transparent
|
||||
expanded edges, SVG edits remain vectors. Import does not upscale portraits.
|
||||
Referenced external SVG resources are refused. Originals and source recipes
|
||||
remain available on re-edit; no repeated destructive resampling is needed.
|
||||
- Portrait part sets and frozen `appearance` recipes remain valid. The editor
|
||||
composes those layers for display; a rename never regenerates the recipe.
|
||||
|
||||
## Container, validation and saving
|
||||
|
||||
ZIP/ZIP64, stored or deflated entries; UTF-8 JSON; package-local paths without
|
||||
absolute paths, `..`, backslashes or symlinks. The editor limits are 100,000
|
||||
entries, 64 MiB per uncompressed entry and 2 GiB total uncompressed bytes. This
|
||||
is independent of the smaller Classic 1.0 reader limits.
|
||||
|
||||
The editor checks identifier uniqueness, typed references, valid dates,
|
||||
declared attribute ranges and assets. Missing facts/source questions are
|
||||
warnings; structural errors block saving. A transaction either validates and
|
||||
commits or is rolled back. `revision` increases monotonically, including
|
||||
undo/redo. Undoing to the saved state clears the dirty flag.
|
||||
|
||||
Unknown entries, extensions, binary assets and untouched table bytes are
|
||||
retained. Large assets remain lazily read from an immutable source snapshot.
|
||||
Saving streams a temporary ZIP and atomically replaces the destination only
|
||||
after finalization. Modified-on-disk sources require Save As. The editor never
|
||||
writes legacy files or a running save.
|
||||
|
||||
The [1.1 editor schema](schema/1.1/editor-world.json) documents structural
|
||||
constraints. Runtime validation additionally resolves cross-table references
|
||||
and rule-declared scales. This is not a claim that the generic world can yet
|
||||
be played by a game engine.
|
||||
@@ -0,0 +1,158 @@
|
||||
# BMH and Football Limited installation converter
|
||||
|
||||
`openbmh_import` imports the content of a supported, locally supplied installation
|
||||
as **BMH-classic** or **FLTD-classic**. Football Limited's executable is named
|
||||
`FLTD.EXE`; the spellings `FTDL-classic` and `FTLD-classic` are accepted as CLI
|
||||
aliases and written as `FLTD-classic`.
|
||||
|
||||
The output is an `.obw` ZIP, or an equivalent directory. It contains the complete
|
||||
**Classic installation content**, including graphics, portrait parts, fonts,
|
||||
audio and the original data tables. It contains no running career or executable.
|
||||
The existing 0.1 game does not read OBW. The 0.2 development branch implements the
|
||||
versioned [Classic contract](classic-v1.md) through its
|
||||
[native runtime and launcher](runtime-0.2.md). This remains separate from
|
||||
migrating every engine rule to the future generic model.
|
||||
|
||||
## Build and use
|
||||
|
||||
Configure as described in [BUILDING](../../BUILDING.md), then:
|
||||
|
||||
```sh
|
||||
cmake --build build --config Release --target openbmh_import
|
||||
./build/openbmh_import --data "path/to/BMH" --output "BMH-classic.obw" \
|
||||
--start-date 2026-07-01 --mod BMH-classic
|
||||
./build/openbmh_import --data "path/to/FLTD.EXE" --output "FLTD-classic.obw" \
|
||||
--start-date 1995-07-01 --mod FLTD-classic
|
||||
./build/openbmh_import --validate "BMH-classic.obw"
|
||||
```
|
||||
|
||||
On a Visual Studio multi-configuration build use
|
||||
`build\Release\openbmh_import.exe`. `--mod` is optional: the tool detects the
|
||||
edition. A mismatching explicit mod is an error. `--title TEXT` changes the
|
||||
world's display title. `--directory` writes an unpacked world, which `--validate`
|
||||
can read too. The source may be an installation directory, its executable, or a
|
||||
parent with exactly one installation. File discovery ignores case. If both game
|
||||
executables exist, select the intended executable explicitly.
|
||||
|
||||
A full import requires the same installation resources as the current launcher:
|
||||
master database, text database, executable, `M3.MEN`, `M3.DAT`, palette, required
|
||||
`KB`/`W` pictures, two fonts and four sound banks. A missing resource is an error.
|
||||
Supported inputs are the German CD-family editions and Football Limited; the
|
||||
1994 floppy `M3.EXE`/`M3PC.MAN` family and Amiga installations are not supported.
|
||||
Source ZIP/7z and `.FBM` files are not input formats for this tool.
|
||||
|
||||
The date must be July 1 of an explicit year (1900–9998). Master data contain
|
||||
ages without an unambiguous season year; the converter never uses today's date
|
||||
or invents birth dates. Player age is recorded as `age_at_start`. Calendar setup
|
||||
remains a Classic runtime operation using the selected season/options.
|
||||
|
||||
Existing destinations, including symlinks, are refused. The parent directory
|
||||
must exist. The tool stages and validates output before publishing by rename;
|
||||
source files are read only. Do not run competing writers for one destination.
|
||||
|
||||
## What a Classic world contains
|
||||
|
||||
The manifest names `mod: BMH-classic` or `FLTD-classic`, profile
|
||||
`classic-installation-v1`, `requires: ["runtime:classic-v1"]` and
|
||||
`content_license: local-import-only`. `content_complete: true` means all inputs
|
||||
for that **specific Classic runtime** are present. It does not claim that the
|
||||
0.1 client can load OBW or that every rule has already been migrated to a generic
|
||||
0.2/0.4 schema. A reader without `runtime:classic-v1` must refuse the world.
|
||||
|
||||
| Area | Contents |
|
||||
|---|---|
|
||||
| Nations and teams | All named clubs/national teams, nine leagues, amateur pool, foreign nation blocks, encoded strength band/style, crest and kit selectors |
|
||||
| Players | All 2,574 identities, squads, raw words/flags, attributes, age reference, nationality and frozen portrait recipe |
|
||||
| Staff | Referee names, properties and strictness; human/computer manager setup is a runtime initializer |
|
||||
| Contracts and finance | Contract seeds per assigned player and finance policies for all 138 league clubs; actual values are created by the same manager/season initialization as today |
|
||||
| Stadiums | Entire name pool and stadium initializer, with all building, capacity, price and facility tables retained in Classic data regions |
|
||||
| Competitions | Nine league definitions and fixture generators, plus every configured cup-table stage with links, flags, group/qualifying information and runtime participant resolvers |
|
||||
| Calendar and rules | Day table, league bindings, cup series, ladder, training camps, credit factors, initialization sequence and all remaining data-region content |
|
||||
| Text | UTF-8 original gettext layer, indexed strings, raw text blob and embedded executable-data texts |
|
||||
| Artwork | Every numeric `KB/*.VGA` and `W/*.VGA` decoded as indexed PNG plus exact pixel indices; crest crops, original palette, portrait parts, bitmap fonts |
|
||||
| Audio and optional art | Four original audio containers with chunk descriptors; optional FLI/FLC animation and WAPPEN.LBM when present |
|
||||
| Preservation | Exact master-database bytes, named auxiliary tables/pools, original and effective data regions, resource metadata and CRC32 inventory |
|
||||
|
||||
A source database does **not** contain ready-made human-manager finances,
|
||||
contracts or stadium capacities. Those depend on the selected club, game level,
|
||||
mode and random seeds. The world specifies their initialization rather than
|
||||
inventing a balance, contract term or stadium owner. Imported player attributes
|
||||
are the master seeds; the existing Classic initialization changes ratings and
|
||||
ages and can shuffle club draw positions. This consumes no RNG during import.
|
||||
|
||||
Player `appearance` is computed from the **raw legacy byte name**, before Unicode
|
||||
conversion. It freezes the background and five layer indices once. Name overlays
|
||||
must retain this field. The imported set stores individual transparent parts and
|
||||
placement metadata; composed player faces are never stored. Packed atlas parts
|
||||
which cross a source row boundary retain their original pixels.
|
||||
|
||||
The effective data use OpenBMH's existing supported rule profile. Unpatched
|
||||
source data are preserved separately, including Football Limited's native data
|
||||
segment. Neither copy includes a DOS header, executable code or relocation
|
||||
instructions. `x-classic` is a documented compatibility bridge, not a claim that
|
||||
the current address-based engine has already been replaced.
|
||||
|
||||
## Stable identities and original encodings
|
||||
|
||||
IDs derive from master identity slots: `club:00000`, `player:00000`,
|
||||
`stadium:00000`; national teams use `nt:<nation-key>`. Recognized countries get
|
||||
ISO keys, with private association keys for England/Scotland/Wales/Northern
|
||||
Ireland. Unrecognized/duplicate country labels retain `nation:x-legacy-<index>`
|
||||
and a report warning, preserving modded or historical identities.
|
||||
|
||||
Foreign club indices 168–356 form 27 blocks of seven teams corresponding to
|
||||
nation slots 5–31. The nine league ranges retain their edition-specific sizes:
|
||||
German 18/18/18/18/18 and four 12-team leagues; English 20/20/20/20/10 and four
|
||||
12-team leagues. The English fifth division is an unplayed pool; no ten-team
|
||||
fixture generator is invented. Unnamed English amateur slots remain in the
|
||||
preserved source rather than becoming fabricated clubs.
|
||||
|
||||
Text follows ISO 646-DE substitutions and preserves extended bytes as Latin-1
|
||||
Unicode code points; raw bytes remain available. Player names are kept whole in
|
||||
`name.last`, without guessing first/last-name splits. Fixture tables describe
|
||||
draw positions; qualified participants and final fixtures are resolved at the
|
||||
same initialization phase as in the Classic engine.
|
||||
|
||||
## Validation and verification
|
||||
|
||||
`--validate` checks the profile, versions, safe paths, unique entity/asset IDs,
|
||||
core references, squad/stage counts, complete cup bindings, contract ownership,
|
||||
initialization contract, media shapes, portrait indices, resource files and the
|
||||
inventory before accepting a world. Complete imports also carry a SHA-256 seal,
|
||||
verified by this tool when present and required by the 0.2 Classic runtime.
|
||||
ZIP and directory readers enforce size
|
||||
limits; directory symlinks and injected `state/` content are rejected. CRC32
|
||||
catches accidental damage; it is not a signature or proof of trustworthy content.
|
||||
This is the Classic profile validator, not a general competition engine or a full
|
||||
JSON Schema implementation. Draft 2020-12 schemas are provided for external tools.
|
||||
|
||||
`obw_import_tests` uses synthetic data to cover both editions, binary round trips,
|
||||
frozen appearances, malformed input and damaged payloads. With `BMH_DATA`,
|
||||
`obw_classic_installation_tests` imports an installation, writes/reopens its ZIP,
|
||||
reconstructs the startup inputs without reading the source again, and compares
|
||||
first-season initialization bytes and both RNG streams. It also compares data
|
||||
regions, atlas pixels, palette, fonts and audio against the source. The same test
|
||||
can be run with a Football Limited directory as its argument. It does not test
|
||||
OBW integration in a released client or a complete played season.
|
||||
|
||||
## Partial development export
|
||||
|
||||
`--database-only` deliberately retains the previous `legacy-database-v1` export
|
||||
for database investigations without media. Its manifest remains
|
||||
`playable: false`, requires `import:legacy-database-v1`, and its report lists gaps.
|
||||
It is **not** one of the completed Classic mods. Default imports never silently
|
||||
fall back to this mode.
|
||||
|
||||
## Rights and excluded data
|
||||
|
||||
All imported content remains local and retains its original ownership. Do not
|
||||
publish generated worlds or assets without appropriate rights. Public tests and
|
||||
schemas contain only independently authored implementation and synthetic data.
|
||||
|
||||
The standalone installation converter does not migrate careers or personal
|
||||
settings. The 0.2 launcher separately migrates supported `.FBM`, `.EIN` and `.MEN`
|
||||
files into native personal files; see its [migration contract](runtime-0.2.md).
|
||||
`SOUND.CFG`, high scores, backups, editor/program executables and external manuals
|
||||
are not imported. In-game readme content is retained when available. Manager
|
||||
choices and career RNG state belong to a new game or `.obs` save, not to this
|
||||
installation conversion.
|
||||
@@ -0,0 +1,107 @@
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-only -->
|
||||
# Classic runtime and portable launcher (0.2 development)
|
||||
|
||||
This contract is for the 0.2 development branch. It is not a release validation claim.
|
||||
|
||||
## Portable layout and lifecycle
|
||||
|
||||
`OpenBMH.exe` (Windows) / `OpenBMH` (Linux and macOS) starts the operating system's
|
||||
RmlUI launcher: one selected row, **Name | Art**, and **Start, Add, Delete, Rename, End**.
|
||||
No installation is auto-selected on first launch. Add converts an externally owned
|
||||
installation; original assets never belong in a distribution.
|
||||
|
||||
```
|
||||
OpenBMH[.exe]
|
||||
assets/launcher/*
|
||||
mods/<name>/content.obw
|
||||
userdata/<content-id>/*.obs
|
||||
userdata/<content-id>/*.obsettings
|
||||
userdata/<content-id>/*.oblayout
|
||||
userdata/<content-id>/highscore-<signature>.obscore
|
||||
```
|
||||
|
||||
The directory name is the launcher name, separate from `manifest.mod` (`BMH-classic`
|
||||
or `FLTD-classic`). `FTDL-classic` is the requested English directory-name default.
|
||||
Names must be portable single path components; duplicates are case-insensitive.
|
||||
Classic files are sealed, not editable world overlays. Modern gameplay is not implemented.
|
||||
|
||||
Rename changes the directory only. Delete removes mod content after confirmation and
|
||||
retains user data. Reimporting the same content and start year reconnects it. The content
|
||||
identity excludes display title, generator version and the CRC inventory, but includes
|
||||
runtime content and the starting-year configuration. It deliberately changes when content
|
||||
actually changes. User data cannot be silently associated with a different database.
|
||||
|
||||
The launcher starts a child process of the same binary, with `--run-mod` and a separate
|
||||
save directory, and remains available after the child exits. `--mod <content.obw>` bypasses
|
||||
the launcher. A normal GUI/console invocation cannot fall back to original game files.
|
||||
|
||||
RML/RCSS define the launcher and its import, rename, delete and progress dialogs.
|
||||
Only folder selection uses an OS dialog. The SDL2/OpenGL view keeps UI resources
|
||||
relative to the executable, supports resizing and HiDPI input, and sleeps between
|
||||
input or scheduled UI updates. The running child's match engine does not depend on
|
||||
RmlUI. OpenGL 3.3 is required for the launcher (4.1 on macOS).
|
||||
|
||||
## Integrity and content access
|
||||
|
||||
The existing `classic-installation-v1` payload is complemented by
|
||||
`x-classic/seal.json` (`classic-seal@1.0`): SHA-256 for every other archive entry plus
|
||||
`content_id`. The earlier CRC inventory excludes the seal to avoid a circular digest.
|
||||
A missing seal, changed entry or unexpected file in a Classic mod directory prevents start.
|
||||
SHA-256 detects ordinary manual changes/corruption; it is not a signature or a promise
|
||||
against a local owner modifying the validator.
|
||||
|
||||
The runtime decodes indexed images, fonts and palettes into an immutable store. Existing
|
||||
UI aliases such as `KB/29.VGA` select the already decoded object; they are not files.
|
||||
Embedded image palettes are imported separately, preserving the Sportschau/title colours.
|
||||
Original single-byte readme content is preserved in the local package where available.
|
||||
No original executable is reconstructed or executed.
|
||||
|
||||
## Native careers and personal files
|
||||
|
||||
A `.obs` ZIP contains the complete sealed starting world, with its original manifest at
|
||||
`state/world-manifest.json`. The top manifest has `kind: save`,
|
||||
`save_profile: classic-career-v1` and the content identity.
|
||||
|
||||
| Entry | Native contract |
|
||||
|---|---|
|
||||
| `state/career.json` | `classic-state@1.0`: named typed arrays/scalars, name bytes and explicitly addressed compatibility blocks |
|
||||
| `state/rng.json` | `classic-rng@1.0`: both seeds and decimal-string draw counters |
|
||||
| `state/session.json` | `classic-session@1.0`: runtime option bytes, stable desk arguments and manager mappings |
|
||||
| `state/driver.json` | `classic-driver@1.0`: desk stage/order, match groups, referees, event counter and previous results |
|
||||
| `state/information.json` | `classic-bytes@1.0`: Classic browser information fields |
|
||||
| `state/integrity.json` | `save-integrity@1.0`: SHA-256 of every other state entry |
|
||||
|
||||
Only existing manager-desk save boundaries are supported. Runtime callbacks and host
|
||||
pointers are reconstructed. Native saving is RNG-neutral; unlike the old FBM envelope it
|
||||
needs no random encryption fields. Both generator seeds and draw counters resume exactly.
|
||||
Names and compatibility bytes use hexadecimal encoding to retain single-byte values
|
||||
without pretending they are UTF-8. Integer fields have explicit bounds.
|
||||
|
||||
`.obsettings`, `.oblayout` and `.obscore` are JSON documents with kind-specific schema
|
||||
names (`classic-settings@1.0`, `classic-layout@1.0`, `classic-highscore@1.0`) and a
|
||||
`classic-bytes@1.0` payload. They preserve existing availability bits, layout chains and
|
||||
high-score fields. The existing application validators still govern settings and layouts.
|
||||
Writes publish a complete temporary file atomically; overwrites require the existing
|
||||
application confirmation.
|
||||
|
||||
## Legacy migration and Classic dates
|
||||
|
||||
Add defaults to transferring games/settings, with a separately selectable source directory.
|
||||
The source is read-only. Existing personal files are retained rather than overwritten.
|
||||
Individual failures appear in the import report.
|
||||
|
||||
German/OpenBMH V2.24 files use their documented block contract. Original Football Limited
|
||||
V2.20 has its own block translator, including FA Cup, League Cup and additional-cup memory.
|
||||
It is never accepted by merely changing a version string. Like the V2.20 loader, migration
|
||||
rebuilds its unsaved current match groups without replaying daily finances or shuffling
|
||||
saved manager order. Unknown/damaged versions fail explicitly.
|
||||
|
||||
Original FBM files do not contain the clock-seeded Watcom random state. Migration therefore
|
||||
seeds that stream reproducibly from SHA-256 of the source file. A converted career cannot
|
||||
promise the original machine's unknown random future; subsequent native checkpoints retain
|
||||
both streams in full.
|
||||
|
||||
The selected start year changes only displayed years for new careers. Weekdays and the
|
||||
original four-year calendar remain unchanged. Imported careers retain the year from their
|
||||
saved information header when it is valid. This cosmetic origin is independent of the
|
||||
immutable world's start configuration and is carried in the native career.
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/asset-index.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "asset-index@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"pattern": "^asset:"
|
||||
},
|
||||
"files": {
|
||||
"type": "object",
|
||||
"minProperties": 1,
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"source": {
|
||||
"type": "string"
|
||||
},
|
||||
"author": {
|
||||
"type": "string"
|
||||
},
|
||||
"license": {
|
||||
"const": "local-import-only"
|
||||
},
|
||||
"kind": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key",
|
||||
"files",
|
||||
"source",
|
||||
"author",
|
||||
"license",
|
||||
"kind"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/calendar.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "calendar@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^calendar:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"season_start": {
|
||||
"const": "07-01"
|
||||
},
|
||||
"series": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"legacy_calendar_bit": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 31
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"legacy_calendar_bit"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"season_start",
|
||||
"series"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-bytes.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,402 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-driver.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-driver@1.0"
|
||||
},
|
||||
"stage": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 2
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"manager_position": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4
|
||||
},
|
||||
"next_event_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
},
|
||||
"loaded_matchday_resume": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"suppress_remaining_pre_match_offers": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"national_nomination_desk": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"enable_national_nomination_desks": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"referee_source": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"referees": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 255
|
||||
},
|
||||
"last_results": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"valid": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calendar_entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"matchday": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"desc": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 192,
|
||||
"maxItems": 208
|
||||
},
|
||||
"fixtures": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 64
|
||||
},
|
||||
"results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_results": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"cup_other_leg": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 576
|
||||
},
|
||||
"end_minute": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"spectators": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 32
|
||||
},
|
||||
"log": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"cup_addresses": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"phase": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 1
|
||||
},
|
||||
"ended": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"kickoff_void_mask": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"desc",
|
||||
"fixtures",
|
||||
"results",
|
||||
"cup_results",
|
||||
"cup_other_leg",
|
||||
"records",
|
||||
"end_minute",
|
||||
"spectators",
|
||||
"log",
|
||||
"cup_addresses",
|
||||
"phase",
|
||||
"ended",
|
||||
"kickoff_void_mask"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 6
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"valid",
|
||||
"date",
|
||||
"calendar_entry",
|
||||
"matchday",
|
||||
"groups",
|
||||
"tournament_name"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"stage",
|
||||
"calendar_entry",
|
||||
"manager_position",
|
||||
"next_event_id",
|
||||
"loaded_matchday_resume",
|
||||
"suppress_remaining_pre_match_offers",
|
||||
"national_nomination_desk",
|
||||
"enable_national_nomination_desks",
|
||||
"groups",
|
||||
"referee_source",
|
||||
"referees",
|
||||
"last_results"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-highscore.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-highscore@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 720,
|
||||
"minLength": 720
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-inventory.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-inventory@1.0"
|
||||
},
|
||||
"entries": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"path": {
|
||||
"type": "string"
|
||||
},
|
||||
"bytes": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"crc32": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"path",
|
||||
"bytes",
|
||||
"crc32"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"entries"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-layout.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-layout@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 1728,
|
||||
"minLength": 1728
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-palette.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-palette@1.0"
|
||||
},
|
||||
"argb": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"minItems": 256,
|
||||
"maxItems": 256
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"argb"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,200 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; Classic installation content.",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-resources.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-resources@1.0"
|
||||
},
|
||||
"images": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
},
|
||||
"height": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
},
|
||||
"pixels": {
|
||||
"type": "string"
|
||||
},
|
||||
"png": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"width",
|
||||
"height",
|
||||
"pixels",
|
||||
"png"
|
||||
]
|
||||
}
|
||||
},
|
||||
"fonts": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"baseline": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"nominal_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"flags": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"lo_char": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hi_char": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"modulo": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"bitmap": {
|
||||
"type": "string"
|
||||
},
|
||||
"glyphs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"bit_offset": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"bit_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"advance": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"bit_offset",
|
||||
"bit_width",
|
||||
"advance"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"height",
|
||||
"baseline",
|
||||
"nominal_width",
|
||||
"flags",
|
||||
"lo_char",
|
||||
"hi_char",
|
||||
"modulo",
|
||||
"glyphs",
|
||||
"bitmap"
|
||||
]
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"audio": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
},
|
||||
"codec": {
|
||||
"const": "original-alptraum@1"
|
||||
},
|
||||
"chunks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"offset": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"offset",
|
||||
"size"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"path",
|
||||
"codec",
|
||||
"chunks"
|
||||
]
|
||||
},
|
||||
"minItems": 4,
|
||||
"maxItems": 4
|
||||
},
|
||||
"optional": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"path"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"images",
|
||||
"fonts",
|
||||
"audio",
|
||||
"optional"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-rng.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-rng@1.0"
|
||||
},
|
||||
"watcom": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"game": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"seed": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"calls": {
|
||||
"type": "string",
|
||||
"pattern": "^(0|[1-9][0-9]*)$",
|
||||
"maxLength": 20
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"seed",
|
||||
"calls"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"watcom",
|
||||
"game"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-seal.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-seal@1.0"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"content_id",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-session.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-session@1.0"
|
||||
},
|
||||
"runtime": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"value": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"value"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"desk_callargs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"managers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 3,
|
||||
"maxItems": 3
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"runtime",
|
||||
"desk_callargs",
|
||||
"managers"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-settings.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-settings@1.0"
|
||||
},
|
||||
"payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-bytes@1.0"
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 360,
|
||||
"minLength": 360
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"payload"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,189 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-startup.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-startup@1.0"
|
||||
},
|
||||
"layout": {
|
||||
"const": "openbmh-classic-layout@1"
|
||||
},
|
||||
"mod": {
|
||||
"enum": [
|
||||
"BMH-classic",
|
||||
"FLTD-classic"
|
||||
]
|
||||
},
|
||||
"english": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported@1"
|
||||
},
|
||||
"data_regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"base": {
|
||||
"type": "integer"
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"base",
|
||||
"size",
|
||||
"path"
|
||||
]
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 2
|
||||
},
|
||||
"source_regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"base": {
|
||||
"type": "integer"
|
||||
},
|
||||
"size": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"base",
|
||||
"size",
|
||||
"path"
|
||||
]
|
||||
},
|
||||
"minItems": 1,
|
||||
"maxItems": 2
|
||||
},
|
||||
"desktop_seed": {
|
||||
"type": "string"
|
||||
},
|
||||
"formation_seed": {
|
||||
"type": "string"
|
||||
},
|
||||
"text_blob": {
|
||||
"type": "string"
|
||||
},
|
||||
"initializers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"minItems": 8,
|
||||
"maxItems": 8
|
||||
},
|
||||
"runtime_inputs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"rng": {
|
||||
"type": "object"
|
||||
},
|
||||
"embedded_literals": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"address": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bytes_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})+$"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"address",
|
||||
"bytes_hex"
|
||||
]
|
||||
}
|
||||
},
|
||||
"source_literals": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"address": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bytes_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})+$"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name",
|
||||
"address",
|
||||
"bytes_hex"
|
||||
]
|
||||
}
|
||||
},
|
||||
"text_header": {
|
||||
"type": "array",
|
||||
"minItems": 7,
|
||||
"maxItems": 7,
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"layout",
|
||||
"mod",
|
||||
"english",
|
||||
"rule_profile",
|
||||
"data_regions",
|
||||
"source_regions",
|
||||
"desktop_seed",
|
||||
"formation_seed",
|
||||
"text_blob",
|
||||
"initializers",
|
||||
"runtime_inputs",
|
||||
"rng",
|
||||
"embedded_literals",
|
||||
"source_literals",
|
||||
"text_header"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -0,0 +1,542 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/classic-state.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "classic-state@1.0"
|
||||
},
|
||||
"indoor": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"level": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_rain": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"chance_temperature": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_shooter": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"last_pick_quality": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"live_scene": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_selection_available": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sportschau_club_threshold": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"list_toggle": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"lineups_frozen": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"offer_answer": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"transfer_notice_suppressed": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"pools_open": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"autosave_months": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"autosave_month": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"display_start_year": {
|
||||
"type": "integer",
|
||||
"minimum": 1900,
|
||||
"maximum": 9998
|
||||
},
|
||||
"date": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"season_start": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 3000000
|
||||
},
|
||||
"development_balance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"trend_rotation": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"season": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"team_morale": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_bonus": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"formations": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_records": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tactics": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_options": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_table": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_bc": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_78": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_heap_b8": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"master_database_metadata": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"referee_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stadium_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"tournament_name": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"manager_ratings": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"position_history": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"league_rounds": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"results": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"stocks": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"foreign_strength": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"mailbox": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"club_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"player_names": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"squad_slots": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"team_flags": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"manager_teams": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -1,
|
||||
"maximum": 4095
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4
|
||||
},
|
||||
"live_matches": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"sportschau_homes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"sportschau_priorities": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 10,
|
||||
"maxItems": 10
|
||||
},
|
||||
"club_ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_cards": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"player_name_offsets": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 65535
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 1000000
|
||||
},
|
||||
"players": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name_hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
},
|
||||
"form": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"skills": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"identity": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"name_hex",
|
||||
"form",
|
||||
"skills",
|
||||
"identity"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 4095
|
||||
},
|
||||
"memory": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"address": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 4294967295
|
||||
},
|
||||
"hex": {
|
||||
"type": "string",
|
||||
"pattern": "^(?:[0-9a-f]{2})*$",
|
||||
"maxLength": 33554432
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"minItems": 0,
|
||||
"maxItems": 8192
|
||||
},
|
||||
"reality": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"initialized": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"deflected": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"card_kind": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"distance": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"actors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 5,
|
||||
"maxItems": 5
|
||||
},
|
||||
"grid": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"planes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"minItems": 1144,
|
||||
"maxItems": 1144
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"positions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"minItems": 24,
|
||||
"maxItems": 24
|
||||
},
|
||||
"ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"previous_ball": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": -2147483648,
|
||||
"maximum": 2147483647
|
||||
},
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"planes",
|
||||
"positions",
|
||||
"ball",
|
||||
"previous_ball"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"initialized",
|
||||
"deflected",
|
||||
"card_kind",
|
||||
"distance",
|
||||
"actors",
|
||||
"grid"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"indoor",
|
||||
"level",
|
||||
"chance_rain",
|
||||
"chance_temperature",
|
||||
"last_shooter",
|
||||
"last_pick_quality",
|
||||
"live_scene",
|
||||
"sportschau_selection_available",
|
||||
"sportschau_club_threshold",
|
||||
"list_toggle",
|
||||
"lineups_frozen",
|
||||
"offer_answer",
|
||||
"transfer_notice_suppressed",
|
||||
"pools_open",
|
||||
"autosave_months",
|
||||
"autosave_month",
|
||||
"display_start_year",
|
||||
"date",
|
||||
"season_start",
|
||||
"development_balance",
|
||||
"trend_rotation",
|
||||
"season",
|
||||
"team_morale",
|
||||
"player_bonus",
|
||||
"formations",
|
||||
"manager_records",
|
||||
"tactics",
|
||||
"manager_options",
|
||||
"club_table",
|
||||
"club_heap_bc",
|
||||
"club_heap_78",
|
||||
"club_heap_b8",
|
||||
"master_database_metadata",
|
||||
"referee_names",
|
||||
"stadium_names",
|
||||
"tournament_name",
|
||||
"manager_results",
|
||||
"manager_ratings",
|
||||
"position_history",
|
||||
"league_rounds",
|
||||
"results",
|
||||
"stocks",
|
||||
"foreign_strength",
|
||||
"mailbox",
|
||||
"club_names",
|
||||
"player_names",
|
||||
"squad_slots",
|
||||
"team_flags",
|
||||
"manager_teams",
|
||||
"live_matches",
|
||||
"sportschau_homes",
|
||||
"sportschau_priorities",
|
||||
"club_ids",
|
||||
"player_cards",
|
||||
"player_name_offsets",
|
||||
"players",
|
||||
"memory",
|
||||
"reality"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/clubs.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "clubs@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"type": {
|
||||
"enum": [
|
||||
"club",
|
||||
"national",
|
||||
"amateur",
|
||||
"foreign"
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"nation": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"stadium": {
|
||||
"type": "string",
|
||||
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"strength": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"name",
|
||||
"nation"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/common.json",
|
||||
"$defs": {
|
||||
"localized": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"default"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"nation_id": {
|
||||
"type": "string",
|
||||
"pattern": "^nation:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"team_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(club|nt):[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"person_id": {
|
||||
"type": "string",
|
||||
"pattern": "^(player|staff):[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"date": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
|
||||
},
|
||||
"attributes": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,171 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/competitions.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "competitions@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^comp:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"type": {
|
||||
"enum": [
|
||||
"league",
|
||||
"cup",
|
||||
"club_international",
|
||||
"national_team",
|
||||
"friendly",
|
||||
"indoor"
|
||||
]
|
||||
},
|
||||
"nation": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"tier": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"played": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"stages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"format": {
|
||||
"enum": [
|
||||
"league",
|
||||
"groups",
|
||||
"knockout",
|
||||
"final",
|
||||
"playoff"
|
||||
]
|
||||
},
|
||||
"teams": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
},
|
||||
"legs": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"generator": {
|
||||
"type": "string"
|
||||
},
|
||||
"matchdays": {
|
||||
"type": "string"
|
||||
},
|
||||
"slots": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"teams": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"uniqueItems": true
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"teams"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"resolver": {
|
||||
"const": "classic-entry@1"
|
||||
},
|
||||
"entry": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 35
|
||||
},
|
||||
"count": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 255
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"resolver",
|
||||
"entry",
|
||||
"count"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"format",
|
||||
"teams",
|
||||
"legs",
|
||||
"slots"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"trophy": {
|
||||
"type": "string",
|
||||
"pattern": "^asset:comp/(?!\\.{1,2}/)[a-zA-Z0-9._-]+/trophy$",
|
||||
"description": "Optional presentation key; default is asset:comp/<competition key>/trophy. Missing artwork resolves to asset:comp/generic/trophy and then a built-in neutral trophy icon."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"type",
|
||||
"played",
|
||||
"stages"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"type": {
|
||||
"const": "league"
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"nation",
|
||||
"tier"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/contracts.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "contracts@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^contract:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"person": {
|
||||
"$ref": "common.json#/$defs/person_id"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"salary": {
|
||||
"type": "integer"
|
||||
},
|
||||
"start": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"end": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"person",
|
||||
"team"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/finance.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "finance@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^finance:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"balance": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"team"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,235 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/manifest.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"const": "openbmh-world"
|
||||
},
|
||||
"format_version": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"kind": {
|
||||
"const": "world"
|
||||
},
|
||||
"min_reader": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"title": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"generator": {
|
||||
"type": "string"
|
||||
},
|
||||
"provenance": {
|
||||
"enum": [
|
||||
"import:bmh-de",
|
||||
"import:fltd"
|
||||
]
|
||||
},
|
||||
"content_license": {
|
||||
"const": "local-import-only"
|
||||
},
|
||||
"currency": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string"
|
||||
},
|
||||
"minor_units": {
|
||||
"const": 0
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"code",
|
||||
"minor_units"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"start_date": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"languages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"limits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"leagues": {
|
||||
"const": 32
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"leagues"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"requires": {
|
||||
"oneOf": [
|
||||
{
|
||||
"const": [
|
||||
"import:legacy-database-v1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"const": [
|
||||
"runtime:classic-v1"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"extensions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"version"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"x-import": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "legacy-database-v1"
|
||||
},
|
||||
"playable": {
|
||||
"const": false
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported"
|
||||
},
|
||||
"default_attribute_set": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"profile",
|
||||
"playable",
|
||||
"rule_profile"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "classic-installation-v1"
|
||||
},
|
||||
"content_complete": {
|
||||
"const": true
|
||||
},
|
||||
"runtime": {
|
||||
"const": "runtime:classic-v1"
|
||||
},
|
||||
"rule_profile": {
|
||||
"const": "openbmh-supported@1"
|
||||
},
|
||||
"source_rules_preserved": {
|
||||
"const": true
|
||||
},
|
||||
"default_attribute_set": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"default_portrait_set": {
|
||||
"const": "bmh-classic@1"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"profile",
|
||||
"content_complete",
|
||||
"runtime",
|
||||
"rule_profile",
|
||||
"source_rules_preserved",
|
||||
"default_attribute_set",
|
||||
"default_portrait_set"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"mod": {
|
||||
"enum": [
|
||||
"BMH-classic",
|
||||
"FLTD-classic"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"format",
|
||||
"format_version",
|
||||
"kind",
|
||||
"min_reader",
|
||||
"title",
|
||||
"generator",
|
||||
"provenance",
|
||||
"content_license",
|
||||
"currency",
|
||||
"start_date",
|
||||
"languages",
|
||||
"limits",
|
||||
"requires",
|
||||
"extensions",
|
||||
"x-import"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles.",
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"requires": {
|
||||
"const": [
|
||||
"runtime:classic-v1"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"id",
|
||||
"mod"
|
||||
],
|
||||
"properties": {
|
||||
"x-import": {
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "classic-installation-v1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"else": {
|
||||
"properties": {
|
||||
"x-import": {
|
||||
"properties": {
|
||||
"profile": {
|
||||
"const": "legacy-database-v1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/nations.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "nations@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^nation:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"confederation": {
|
||||
"enum": [
|
||||
"uefa",
|
||||
"conmebol",
|
||||
"caf",
|
||||
"afc",
|
||||
"concacaf",
|
||||
"ofc",
|
||||
"other"
|
||||
]
|
||||
},
|
||||
"national_team": {
|
||||
"type": "string",
|
||||
"pattern": "^nt:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"playable": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"confederation"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,153 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/players.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "players@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^player:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"first": {
|
||||
"type": "string"
|
||||
},
|
||||
"last": {
|
||||
"type": "string"
|
||||
},
|
||||
"known_as": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"first",
|
||||
"last"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"born": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
},
|
||||
"age_at_start": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"years": {
|
||||
"type": "integer",
|
||||
"minimum": 16,
|
||||
"maximum": 47
|
||||
},
|
||||
"on": {
|
||||
"$ref": "common.json#/$defs/date"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"years",
|
||||
"on"
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"nationalities": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "common.json#/$defs/nation_id"
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"positions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"enum": [
|
||||
"gk",
|
||||
"def",
|
||||
"mid",
|
||||
"fwd"
|
||||
]
|
||||
},
|
||||
"minItems": 1
|
||||
},
|
||||
"attribute_set": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"attributes": {
|
||||
"$ref": "common.json#/$defs/attributes"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
"appearance": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"set": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z][a-z0-9-]*@[0-9]+$"
|
||||
},
|
||||
"background": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"layers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"set",
|
||||
"background",
|
||||
"layers"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"nationalities",
|
||||
"positions",
|
||||
"attribute_set",
|
||||
"attributes"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"oneOf": [
|
||||
{
|
||||
"required": [
|
||||
"born"
|
||||
],
|
||||
"not": {
|
||||
"required": [
|
||||
"age_at_start"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"required": [
|
||||
"age_at_start"
|
||||
],
|
||||
"not": {
|
||||
"required": [
|
||||
"born"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/portrait-set.json",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "portrait-set@1.0"
|
||||
},
|
||||
"id": {
|
||||
"const": "bmh-classic@1"
|
||||
},
|
||||
"width": {
|
||||
"const": 38
|
||||
},
|
||||
"height": {
|
||||
"const": 38
|
||||
},
|
||||
"transparent_index": {
|
||||
"const": 0
|
||||
},
|
||||
"backgrounds": {
|
||||
"type": "array",
|
||||
"minItems": 4,
|
||||
"maxItems": 4,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"asset": {
|
||||
"type": "string"
|
||||
},
|
||||
"x": {
|
||||
"type": "integer"
|
||||
},
|
||||
"y": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"asset",
|
||||
"x",
|
||||
"y"
|
||||
]
|
||||
}
|
||||
},
|
||||
"layers": {
|
||||
"type": "array",
|
||||
"minItems": 5,
|
||||
"maxItems": 5,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"x": {
|
||||
"type": "integer"
|
||||
},
|
||||
"y": {
|
||||
"type": "integer"
|
||||
},
|
||||
"parts": {
|
||||
"type": "array",
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"x",
|
||||
"y",
|
||||
"parts"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"id",
|
||||
"width",
|
||||
"height",
|
||||
"backgrounds",
|
||||
"layers",
|
||||
"transparent_index"
|
||||
],
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; legacy database and Classic installation profiles."
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/rules.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "rules@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-integrity.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "save-integrity@1.0"
|
||||
},
|
||||
"entries": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"entries"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/save-manifest.json",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"format",
|
||||
"format_version",
|
||||
"kind",
|
||||
"save_profile",
|
||||
"content_id"
|
||||
],
|
||||
"properties": {
|
||||
"format": {
|
||||
"const": "openbmh-world"
|
||||
},
|
||||
"format_version": {
|
||||
"const": "1.0"
|
||||
},
|
||||
"kind": {
|
||||
"const": "save"
|
||||
},
|
||||
"save_profile": {
|
||||
"const": "classic-career-v1"
|
||||
},
|
||||
"content_id": {
|
||||
"type": "string",
|
||||
"pattern": "^[0-9a-f]{64}$"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/stadiums.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "stadiums@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^stadium:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"owner": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
},
|
||||
"capacity": {
|
||||
"type": "object"
|
||||
},
|
||||
"facilities": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://raw.githubusercontent.com/Weyoune/openbmh/main/docs/formats/obw/schema/1.0/staff.json",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"schema": {
|
||||
"const": "staff@1.0"
|
||||
},
|
||||
"items": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^staff:[a-zA-Z0-9._-]+$"
|
||||
},
|
||||
"name": {
|
||||
"$ref": "common.json#/$defs/localized"
|
||||
},
|
||||
"role": {
|
||||
"type": "string"
|
||||
},
|
||||
"team": {
|
||||
"$ref": "common.json#/$defs/team_id"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"name",
|
||||
"role"
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"schema",
|
||||
"items"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"$comment": "SPDX-License-Identifier: GPL-3.0-only; initial legacy-database-v1 conversion profile."
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://openbmh.org/schema/1.1/editor-world.json",
|
||||
"title": "OBW 1.1 editor-world-v1 manifest",
|
||||
"type": "object",
|
||||
"required": ["format", "format_version", "min_reader", "kind", "title", "requires", "x-editor"],
|
||||
"properties": {
|
||||
"format": {"const": "openbmh-world"},
|
||||
"format_version": {"const": "1.1"},
|
||||
"min_reader": {"const": "1.1"},
|
||||
"kind": {"const": "world"},
|
||||
"title": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": {"type": "string"}}]},
|
||||
"start_date": {"type": "string", "format": "date"},
|
||||
"requires": {"type": "array", "contains": {"const": "editor:world-v1"}, "items": {"type": "string"}},
|
||||
"x-editor": {
|
||||
"type": "object", "required": ["profile", "playable"],
|
||||
"properties": {"profile": {"const": "editor-world-v1"}, "playable": {"const": false}},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true,
|
||||
"$defs": {
|
||||
"table": {"type": "object", "required": ["schema", "items"], "properties": {"schema": {"type": "string"}, "items": {"type": "array", "items": {"type": "object"}}}, "additionalProperties": true},
|
||||
"transform": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"angle": {"type": "number", "minimum": -360, "maximum": 360},
|
||||
"flip_x": {"type": "boolean"}, "flip_y": {"type": "boolean"},
|
||||
"crop": {"type": "object", "properties": {
|
||||
"x": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "number", "minimum": 0, "maximum": 1},
|
||||
"width": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}, "height": {"type": "number", "exclusiveMinimum": 0, "maximum": 1}
|
||||
}, "additionalProperties": true}
|
||||
}, "additionalProperties": true
|
||||
},
|
||||
"review": {"type": "object", "required": ["id", "reason", "resolved", "alternatives"], "properties": {
|
||||
"id": {"type": "string", "minLength": 1}, "reason": {"type": "string"}, "resolved": {"type": "boolean"},
|
||||
"table": {"type": "string"}, "entity": {"type": "string"}, "field": {"type": "string", "pattern": "^/"},
|
||||
"alternatives": {"type": "array", "items": {"type": "object", "required": ["value"], "additionalProperties": true}}
|
||||
}, "additionalProperties": true}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,152 @@
|
||||
FreeType font driver for BDF fonts
|
||||
|
||||
Francesco Zappa Nardelli
|
||||
<francesco.zappa.nardelli@ens.fr>
|
||||
|
||||
|
||||
Introduction
|
||||
************
|
||||
|
||||
BDF (Bitmap Distribution Format) is a bitmap font format defined by Adobe,
|
||||
which is intended to be easily understood by both humans and computers.
|
||||
This code implements a BDF driver for the FreeType library, following the
|
||||
Adobe Specification V 2.2. The specification of the BDF font format is
|
||||
available from Adobe's web site:
|
||||
|
||||
https://adobe-type-tools.github.io/font-tech-notes/pdfs/5005.BDF_Spec.pdf
|
||||
|
||||
Many good bitmap fonts in bdf format come with XFree86 (www.XFree86.org).
|
||||
They do not define vertical metrics, because the X Consortium BDF
|
||||
specification has removed them.
|
||||
|
||||
|
||||
Encodings
|
||||
*********
|
||||
|
||||
[This section is out of date, retained for historical reasons. BDF
|
||||
properties can be retrieved with `FT_Get_BDF_Property`, character set ID
|
||||
values with `FT_Get_BDF_Charset_ID`.]
|
||||
|
||||
The variety of encodings that accompanies bdf fonts appears to encompass the
|
||||
small set defined in freetype.h. On the other hand, two properties that
|
||||
specify encoding and registry are usually defined in bdf fonts.
|
||||
|
||||
I decided to make these two properties directly accessible, leaving to the
|
||||
client application the work of interpreting them. For instance:
|
||||
|
||||
|
||||
#include FT_INTERNAL_BDF_TYPES_H
|
||||
|
||||
FT_Face face;
|
||||
BDF_Public_Face bdfface;
|
||||
|
||||
|
||||
FT_New_Face( library, ..., &face );
|
||||
|
||||
bdfface = (BDF_Public_Face)face;
|
||||
|
||||
if ( ( bdfface->charset_registry == "ISO10646" ) &&
|
||||
( bdfface->charset_encoding == "1" ) )
|
||||
[..]
|
||||
|
||||
|
||||
Thus the driver always exports `ft_encoding_none' as face->charmap.encoding.
|
||||
FT_Get_Char_Index's behavior is unmodified, that is, it converts the ULong
|
||||
value given as argument into the corresponding glyph number.
|
||||
|
||||
If the two properties are not available, Adobe Standard Encoding should be
|
||||
assumed.
|
||||
|
||||
|
||||
Anti-Aliased Bitmaps
|
||||
********************
|
||||
|
||||
The driver supports an extension to the BDF format as used in Mark Leisher's
|
||||
xmbdfed bitmap font editor. Microsoft's SBIT tool expects bitmap fonts in
|
||||
that format for adding anti-aliased them to TrueType fonts. It introduces a
|
||||
fourth field to the `SIZE' keyword which gives the bpp value (bits per
|
||||
pixel) of the glyph data in the font. Possible values are 1 (the default),
|
||||
2 (four gray levels), 4 (16 gray levels), and 8 (256 gray levels). The
|
||||
driver returns either a bitmap with 1 bit per pixel or a pixmap with 8bits
|
||||
per pixel (using 4, 16, and 256 gray levels, respectively).
|
||||
|
||||
|
||||
Known problems
|
||||
**************
|
||||
|
||||
- A font is entirely loaded into memory. Obviously, this is not the Right
|
||||
Thing(TM). If you have big fonts I suggest you convert them into PCF
|
||||
format (using the bdftopcf utility): the PCF font drive of FreeType can
|
||||
perform incremental glyph loading.
|
||||
|
||||
When I have some time, I will implement on-demand glyph parsing.
|
||||
|
||||
- Except for encodings properties, client applications have no visibility of
|
||||
the PCF_Face object. This means that applications cannot directly access
|
||||
font tables and must trust FreeType.
|
||||
|
||||
- Currently, glyph names are ignored.
|
||||
|
||||
I plan to give full visibility of the BDF_Face object in an upcoming
|
||||
revision of the driver, thus implementing also glyph names.
|
||||
|
||||
- As I have never seen a BDF font that defines vertical metrics, vertical
|
||||
metrics are (parsed and) discarded. If you own a BDF font that defines
|
||||
vertical metrics, please let me know (I will implement them in 5-10
|
||||
minutes).
|
||||
|
||||
|
||||
License
|
||||
*******
|
||||
|
||||
Copyright (C) 2001-2002 by Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
*** Portions of the driver (that is, bdflib.c and bdf.h):
|
||||
|
||||
Copyright 2000 Computing Research Labs, New Mexico State University
|
||||
Copyright 2001-2002, 2011 Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the "Software"),
|
||||
to deal in the Software without restriction, including without limitation
|
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||||
THE COMPUTING RESEARCH LAB OR NEW MEXICO STATE UNIVERSITY BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
|
||||
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
|
||||
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
Credits
|
||||
*******
|
||||
|
||||
This driver is based on excellent Mark Leisher's bdf library. If you
|
||||
find something good in this driver you should probably thank him, not
|
||||
me.
|
||||
@@ -0,0 +1,169 @@
|
||||
The FreeType Project LICENSE
|
||||
----------------------------
|
||||
|
||||
2006-Jan-27
|
||||
|
||||
Copyright 1996-2002, 2006 by
|
||||
David Turner, Robert Wilhelm, and Werner Lemberg
|
||||
|
||||
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
The FreeType Project is distributed in several archive packages;
|
||||
some of them may contain, in addition to the FreeType font engine,
|
||||
various tools and contributions which rely on, or relate to, the
|
||||
FreeType Project.
|
||||
|
||||
This license applies to all files found in such packages, and
|
||||
which do not fall under their own explicit license. The license
|
||||
affects thus the FreeType font engine, the test programs,
|
||||
documentation and makefiles, at the very least.
|
||||
|
||||
This license was inspired by the BSD, Artistic, and IJG
|
||||
(Independent JPEG Group) licenses, which all encourage inclusion
|
||||
and use of free software in commercial and freeware products
|
||||
alike. As a consequence, its main points are that:
|
||||
|
||||
o We don't promise that this software works. However, we will be
|
||||
interested in any kind of bug reports. (`as is' distribution)
|
||||
|
||||
o You can use this software for whatever you want, in parts or
|
||||
full form, without having to pay us. (`royalty-free' usage)
|
||||
|
||||
o You may not pretend that you wrote this software. If you use
|
||||
it, or only parts of it, in a program, you must acknowledge
|
||||
somewhere in your documentation that you have used the
|
||||
FreeType code. (`credits')
|
||||
|
||||
We specifically permit and encourage the inclusion of this
|
||||
software, with or without modifications, in commercial products.
|
||||
We disclaim all warranties covering The FreeType Project and
|
||||
assume no liability related to The FreeType Project.
|
||||
|
||||
|
||||
Finally, many people asked us for a preferred form for a
|
||||
credit/disclaimer to use in compliance with this license. We thus
|
||||
encourage you to use the following text:
|
||||
|
||||
"""
|
||||
Portions of this software are copyright © <year> The FreeType
|
||||
Project (www.freetype.org). All rights reserved.
|
||||
"""
|
||||
|
||||
Please replace <year> with the value from the FreeType version you
|
||||
actually use.
|
||||
|
||||
|
||||
Legal Terms
|
||||
===========
|
||||
|
||||
0. Definitions
|
||||
--------------
|
||||
|
||||
Throughout this license, the terms `package', `FreeType Project',
|
||||
and `FreeType archive' refer to the set of files originally
|
||||
distributed by the authors (David Turner, Robert Wilhelm, and
|
||||
Werner Lemberg) as the `FreeType Project', be they named as alpha,
|
||||
beta or final release.
|
||||
|
||||
`You' refers to the licensee, or person using the project, where
|
||||
`using' is a generic term including compiling the project's source
|
||||
code as well as linking it to form a `program' or `executable'.
|
||||
This program is referred to as `a program using the FreeType
|
||||
engine'.
|
||||
|
||||
This license applies to all files distributed in the original
|
||||
FreeType Project, including all source code, binaries and
|
||||
documentation, unless otherwise stated in the file in its
|
||||
original, unmodified form as distributed in the original archive.
|
||||
If you are unsure whether or not a particular file is covered by
|
||||
this license, you must contact us to verify this.
|
||||
|
||||
The FreeType Project is copyright (C) 1996-2000 by David Turner,
|
||||
Robert Wilhelm, and Werner Lemberg. All rights reserved except as
|
||||
specified below.
|
||||
|
||||
1. No Warranty
|
||||
--------------
|
||||
|
||||
THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR COPYRIGHT HOLDERS
|
||||
BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE OR THE INABILITY TO
|
||||
USE, OF THE FREETYPE PROJECT.
|
||||
|
||||
2. Redistribution
|
||||
-----------------
|
||||
|
||||
This license grants a worldwide, royalty-free, perpetual and
|
||||
irrevocable right and license to use, execute, perform, compile,
|
||||
display, copy, create derivative works of, distribute and
|
||||
sublicense the FreeType Project (in both source and object code
|
||||
forms) and derivative works thereof for any purpose; and to
|
||||
authorize others to exercise some or all of the rights granted
|
||||
herein, subject to the following conditions:
|
||||
|
||||
o Redistribution of source code must retain this license file
|
||||
(`FTL.TXT') unaltered; any additions, deletions or changes to
|
||||
the original files must be clearly indicated in accompanying
|
||||
documentation. The copyright notices of the unaltered,
|
||||
original files must be preserved in all copies of source
|
||||
files.
|
||||
|
||||
o Redistribution in binary form must provide a disclaimer that
|
||||
states that the software is based in part of the work of the
|
||||
FreeType Team, in the distribution documentation. We also
|
||||
encourage you to put an URL to the FreeType web page in your
|
||||
documentation, though this isn't mandatory.
|
||||
|
||||
These conditions apply to any software derived from or based on
|
||||
the FreeType Project, not just the unmodified files. If you use
|
||||
our work, you must acknowledge us. However, no fee need be paid
|
||||
to us.
|
||||
|
||||
3. Advertising
|
||||
--------------
|
||||
|
||||
Neither the FreeType authors and contributors nor you shall use
|
||||
the name of the other for commercial, advertising, or promotional
|
||||
purposes without specific prior written permission.
|
||||
|
||||
We suggest, but do not require, that you use one or more of the
|
||||
following phrases to refer to this software in your documentation
|
||||
or advertising materials: `FreeType Project', `FreeType Engine',
|
||||
`FreeType library', or `FreeType Distribution'.
|
||||
|
||||
As you have not signed this license, you are not required to
|
||||
accept it. However, as the FreeType Project is copyrighted
|
||||
material, only this license, or another one contracted with the
|
||||
authors, grants you the right to use, distribute, and modify it.
|
||||
Therefore, by using, distributing, or modifying the FreeType
|
||||
Project, you indicate that you understand and accept all the terms
|
||||
of this license.
|
||||
|
||||
4. Contacts
|
||||
-----------
|
||||
|
||||
There are two mailing lists related to FreeType:
|
||||
|
||||
o freetype@nongnu.org
|
||||
|
||||
Discusses general use and applications of FreeType, as well as
|
||||
future and wanted additions to the library and distribution.
|
||||
If you are looking for support, start in this list if you
|
||||
haven't found anything to help you in the documentation.
|
||||
|
||||
o freetype-devel@nongnu.org
|
||||
|
||||
Discusses bugs, as well as engine internals, design issues,
|
||||
specific licenses, porting, etc.
|
||||
|
||||
Our home page can be found at
|
||||
|
||||
https://www.freetype.org
|
||||
|
||||
|
||||
--- end of FTL.TXT ---
|
||||
@@ -0,0 +1,96 @@
|
||||
FreeType font driver for PCF fonts
|
||||
|
||||
Francesco Zappa Nardelli
|
||||
<francesco.zappa.nardelli@ens.fr>
|
||||
|
||||
|
||||
Introduction
|
||||
************
|
||||
|
||||
PCF (Portable Compiled Format) is a binary bitmap font format, largely used
|
||||
in X world. This code implements a PCF driver for the FreeType library.
|
||||
Glyph images are loaded into memory only on demand, thus leading to a small
|
||||
memory footprint.
|
||||
|
||||
Information on the PCF font format can only be worked out from
|
||||
`pcfread.c', and `pcfwrite.c', to be found, for instance, in the XFree86
|
||||
(www.xfree86.org) source tree (xc/lib/font/bitmap/).
|
||||
|
||||
Many good bitmap fonts in bdf format come with XFree86: they can be
|
||||
compiled into the pcf format using the `bdftopcf' utility.
|
||||
|
||||
|
||||
Supported hardware
|
||||
******************
|
||||
|
||||
The driver has been tested on linux/x86 and sunos5.5/sparc. In both
|
||||
cases the compiler was gcc. When back in Paris, I will test it also
|
||||
on linux/alpha.
|
||||
|
||||
|
||||
Encodings
|
||||
*********
|
||||
|
||||
Use `FT_Get_BDF_Charset_ID' to access the encoding and registry.
|
||||
|
||||
The driver always exports `ft_encoding_none' as face->charmap.encoding.
|
||||
FT_Get_Char_Index() behavior is unmodified, that is, it converts the ULong
|
||||
value given as argument into the corresponding glyph number.
|
||||
|
||||
|
||||
Known problems
|
||||
**************
|
||||
|
||||
- dealing explicitly with encodings breaks the uniformity of FreeType 2
|
||||
API.
|
||||
|
||||
- except for encodings properties, client applications have no
|
||||
visibility of the PCF_Face object. This means that applications
|
||||
cannot directly access font tables and are obliged to trust
|
||||
FreeType.
|
||||
|
||||
- currently, glyph names and ink_metrics are ignored.
|
||||
|
||||
I plan to give full visibility of the PCF_Face object in the next
|
||||
release of the driver, thus implementing also glyph names and
|
||||
ink_metrics.
|
||||
|
||||
- height is defined as (ascent - descent). Is this correct?
|
||||
|
||||
- if unable to read size information from the font, PCF_Init_Face
|
||||
sets available_size->width and available_size->height to 12.
|
||||
|
||||
- too many english grammar errors in the readme file :-(
|
||||
|
||||
|
||||
License
|
||||
*******
|
||||
|
||||
Copyright (C) 2000 by Francesco Zappa Nardelli
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
Credits
|
||||
*******
|
||||
|
||||
Keith Packard wrote the pcf driver found in XFree86. His work is at
|
||||
the same time the specification and the sample implementation of the
|
||||
PCF format. Undoubtedly, this driver is inspired from his work.
|
||||
@@ -0,0 +1,29 @@
|
||||
/* zlib.h -- interface of the 'zlib' general purpose compression library
|
||||
version 1.3, August 18th, 2023
|
||||
|
||||
Copyright (C) 1995-2023 Jean-loup Gailly and Mark Adler
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Jean-loup Gailly Mark Adler
|
||||
jloup@gzip.org madler@alumni.caltech.edu
|
||||
|
||||
|
||||
The data format used by the zlib library is described by RFCs (Request for
|
||||
Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
|
||||
(zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
|
||||
*/
|
||||
@@ -0,0 +1,46 @@
|
||||
FREETYPE LICENSES
|
||||
-----------------
|
||||
|
||||
The FreeType 2 font engine is copyrighted work and cannot be used
|
||||
legally without a software license. In order to make this project
|
||||
usable to a vast majority of developers, we distribute it under two
|
||||
mutually exclusive open-source licenses.
|
||||
|
||||
This means that *you* must choose *one* of the two licenses described
|
||||
below, then obey all its terms and conditions when using FreeType 2 in
|
||||
any of your projects or products.
|
||||
|
||||
- The FreeType License, found in the file `docs/FTL.TXT`, which is
|
||||
similar to the original BSD license *with* an advertising clause
|
||||
that forces you to explicitly cite the FreeType project in your
|
||||
product's documentation. All details are in the license file.
|
||||
This license is suited to products which don't use the GNU General
|
||||
Public License.
|
||||
|
||||
Note that this license is compatible to the GNU General Public
|
||||
License version 3, but not version 2.
|
||||
|
||||
- The GNU General Public License version 2, found in
|
||||
`docs/GPLv2.TXT` (any later version can be used also), for
|
||||
programs which already use the GPL. Note that the FTL is
|
||||
incompatible with GPLv2 due to its advertisement clause.
|
||||
|
||||
The contributed BDF and PCF drivers come with a license similar to
|
||||
that of the X Window System. It is compatible to the above two
|
||||
licenses (see files `src/bdf/README` and `src/pcf/README`). The same
|
||||
holds for the source code files `src/base/fthash.c` and
|
||||
`include/freetype/internal/fthash.h`; they were part of the BDF driver
|
||||
in earlier FreeType versions.
|
||||
|
||||
The gzip module uses the zlib license (see `src/gzip/zlib.h`) which
|
||||
too is compatible to the above two licenses.
|
||||
|
||||
The files `src/autofit/ft-hb.c` and `src/autofit/ft-hb.h` contain code
|
||||
taken almost verbatim from the HarfBuzz file `hb-ft.cc`, which uses
|
||||
the 'Old MIT' license, compatible to the above two licenses.
|
||||
|
||||
The MD5 checksum support (only used for debugging in development
|
||||
builds) is in the public domain.
|
||||
|
||||
|
||||
--- end of LICENSE.TXT ---
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2025 Samuel Ugochukwu <sammycageagle@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -8,7 +8,11 @@ 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.
|
||||
@@ -0,0 +1,22 @@
|
||||
/*
|
||||
** Copyright (c) 2008-2018 The Khronos Group Inc.
|
||||
**
|
||||
** Permission is hereby granted, free of charge, to any person obtaining a
|
||||
** copy of this software and/or associated documentation files (the
|
||||
** "Materials"), to deal in the Materials without restriction, including
|
||||
** without limitation the rights to use, copy, modify, merge, publish,
|
||||
** distribute, sublicense, and/or sell copies of the Materials, and to
|
||||
** permit persons to whom the Materials are furnished to do so, subject to
|
||||
** the following conditions:
|
||||
**
|
||||
** The above copyright notice and this permission notice shall be included
|
||||
** in all copies or substantial portions of the Materials.
|
||||
**
|
||||
** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
||||
*/
|
||||
@@ -0,0 +1,58 @@
|
||||
RmlUi Core contains thirdparty libraries. They are listed below along with
|
||||
their full licenses - all MIT licensed.
|
||||
|
||||
---
|
||||
|
||||
robin_hood unordered map & set
|
||||
https://github.com/martinus/robin-hood-hashing
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2018-2020 Martin Ankerl <http://martin.ankerl.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
---
|
||||
|
||||
itlib
|
||||
https://github.com/iboB/itlib
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright(c) 2016-2019 Chobolabs Inc.
|
||||
Copyright(c) 2020-2023 Borislav Stanimirov
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files(the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and / or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions :
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,316 @@
|
||||
The RmlUi samples include fonts that are separately licensed. They are listed
|
||||
below along with their licenses.
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- Lato ---
|
||||
--- http://www.latofonts.com/ ---
|
||||
--- ---
|
||||
--- LatoLatin-Bold.ttf ---
|
||||
--- LatoLatin-BoldItalic.ttf ---
|
||||
--- LatoLatin-Italic.ttf ---
|
||||
--- LatoLatin-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
Copyright (c) 2010-2015, Łukasz Dziedzic (dziedzic@typoland.com),
|
||||
with Reserved Font Name Lato.
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- Noto Emoji ---
|
||||
--- https://www.google.com/get/noto/ ---
|
||||
--- ---
|
||||
--- NotoEmoji-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License,
|
||||
Version 1.1.
|
||||
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font
|
||||
creation efforts of academic and linguistic communities, and to
|
||||
provide a free and open framework in which fonts may be shared and
|
||||
improved in partnership with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply to
|
||||
any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software
|
||||
components as distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to,
|
||||
deleting, or substituting -- in part or in whole -- any of the
|
||||
components of the Original Version, by changing formats or by porting
|
||||
the Font Software to a new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed,
|
||||
modify, redistribute, and sell modified and unmodified copies of the
|
||||
Font Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components, in
|
||||
Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the
|
||||
corresponding Copyright Holder. This restriction only applies to the
|
||||
primary font name as presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created using
|
||||
the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
--- RobotoMono ---
|
||||
--- https://fonts.google.com/ ---
|
||||
--- ---
|
||||
--- RobotoMono-Bold.ttf ---
|
||||
--- RobotoMono-BoldItalic.ttf ---
|
||||
--- RobotoMono-Italic.ttf ---
|
||||
--- RobotoMono-Regular.ttf ---
|
||||
-----------------------------------------------------------
|
||||
-----------------------------------------------------------
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
https://openfontlicense.org
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
@@ -0,0 +1,22 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2008-2014 CodePoint Ltd, Shift Technology Ltd, and contributors
|
||||
Copyright (c) 2019-2026 The RmlUi Team, and contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,17 @@
|
||||
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
@@ -0,0 +1,22 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 yhirose
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
Additional IP Rights Grant (Patents)
|
||||
------------------------------------
|
||||
|
||||
"These implementations" means the copyrightable works that implement the WebM
|
||||
codecs distributed by Google as part of the WebM Project.
|
||||
|
||||
Google hereby grants to you a perpetual, worldwide, non-exclusive, no-charge,
|
||||
royalty-free, irrevocable (except as stated in this section) patent license to
|
||||
make, have made, use, offer to sell, sell, import, transfer, and otherwise
|
||||
run, modify and propagate the contents of these implementations of WebM, where
|
||||
such license applies only to those patent claims, both currently owned by
|
||||
Google and acquired in the future, licensable by Google that are necessarily
|
||||
infringed by these implementations of WebM. This grant does not include claims
|
||||
that would be infringed only as a consequence of further modification of these
|
||||
implementations. If you or your agent or exclusive licensee institute or order
|
||||
or agree to the institution of patent litigation or any other patent
|
||||
enforcement activity against any entity (including a cross-claim or
|
||||
counterclaim in a lawsuit) alleging that any of these implementations of WebM
|
||||
or any code incorporated within any of these implementations of WebM
|
||||
constitute direct or contributory patent infringement, or inducement of
|
||||
patent infringement, then any patent rights granted to you under this License
|
||||
for these implementations of WebM shall terminate as of the date such
|
||||
litigation is filed.
|
||||
@@ -0,0 +1,30 @@
|
||||
Copyright (c) 2010, Google Inc. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
* Neither the name of Google nor the names of its contributors may
|
||||
be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
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.
|
||||
@@ -0,0 +1,24 @@
|
||||
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.
|
||||
@@ -0,0 +1,36 @@
|
||||
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.
|
||||
------------------------------------------------------------------------------
|
||||
@@ -0,0 +1,51 @@
|
||||
# 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.
|
||||
|
After Width: | Height: | Size: 203 KiB |
|
After Width: | Height: | Size: 130 KiB |
|
After Width: | Height: | Size: 137 KiB |
|
After Width: | Height: | Size: 189 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 149 KiB |
@@ -0,0 +1,84 @@
|
||||
# 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.
|
||||
|
After Width: | Height: | Size: 134 KiB |
|
After Width: | Height: | Size: 179 KiB |
|
After Width: | Height: | Size: 157 KiB |
|
After Width: | Height: | Size: 131 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 99 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 178 KiB |
|
After Width: | Height: | Size: 160 KiB |
@@ -2,6 +2,32 @@
|
||||
|
||||
OpenBMH reconstructs the Bundesliga Manager Hattrick engine in C++20. The graphical client uses SDL2; the console provides command batches and local manager-client transports over the same career session. This release needs a supported game installation supplied by the player. No original executable, artwork, music, text database, manual or saved game is included.
|
||||
|
||||
## Unreleased corrections
|
||||
|
||||
- Application exits ask for confirmation in a native German/English message
|
||||
box, with Cancel selected by default, including window close events during
|
||||
matches and dialogs ([#11](https://github.com/Weyoune/openbmh/issues/11)).
|
||||
|
||||
- Football Limited uses the correct enabled/disabled setup sprites, positive
|
||||
balance colour and outside controls of the desktop shortcut bar ([#7](https://github.com/Weyoune/openbmh/issues/7)).
|
||||
Its cached data is regenerated automatically for the corrected mapping.
|
||||
- Filename dialogs reacquire the native SDL text editor on entry and window
|
||||
focus, including the live settings dialog. macOS acceptance remains human QA
|
||||
([#8](https://github.com/Weyoune/openbmh/issues/8)).
|
||||
- Save-directory labels use portable `/` separators, avoiding the German bitmap
|
||||
font's `Ö` glyph at the backslash position on Windows ([#9](https://github.com/Weyoune/openbmh/issues/9)).
|
||||
- Setup ignores mouse releases without a matching press on that screen, so
|
||||
window activation cannot toggle the initial league/national-team selection
|
||||
through that input path ([#10](https://github.com/Weyoune/openbmh/issues/10)).
|
||||
- The standalone [OBW installation converter](../../formats/obw/import.md) builds
|
||||
complete `BMH-classic` / `FLTD-classic` installation-content worlds, including
|
||||
graphics, fonts, audio, frozen player portrait recipes and versioned Classic
|
||||
startup data. Subsequent CI packages include `openbmh_import`. The 0.2 runtime
|
||||
adapter and savegame conversion remain separate work.
|
||||
|
||||
These changes require a build from the updated source. The tagged 0.1.2 package
|
||||
does not contain these subsequent corrections.
|
||||
|
||||
## Changes in 0.1.2
|
||||
|
||||
- The environment menu shows all six original artwork panels: three youth teams,
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-only -->
|
||||
# OpenBMH v0.2.0
|
||||
|
||||
Version 0.2 makes the original-style game independent of the original installation
|
||||
after import. It supports Bundesliga Manager Hattrick and Football Limited Classic
|
||||
content. Modern game screens are deferred; the stadium-themed launcher is included.
|
||||
|
||||
## Start playing
|
||||
|
||||
1. Extract the package into a writable folder and start `OpenBMH.exe` on Windows
|
||||
or `OpenBMH` on Linux/macOS. Keep the supplied `assets` folder beside it.
|
||||
2. Choose **Add**, select an installation containing `BMH.EXE` or `FLTD.EXE`,
|
||||
and choose a unique mod name. Defaults are `BMH-classic` and `FTDL-classic`.
|
||||
3. Choose the displayed starting year. Optionally migrate original saved games,
|
||||
settings and desktop layouts; another source folder can be selected.
|
||||
4. Select the imported mod and choose **Start**. The game reads its converted
|
||||
`content.obw`, so the original installation is no longer required for play.
|
||||
|
||||
The list is empty on the first launch. Rename changes the mod folder; Delete asks
|
||||
for confirmation and retains personal files. Failed individual save conversions
|
||||
appear in the import report. Keep the original files as backups.
|
||||
|
||||
## Content and saves
|
||||
|
||||
- Converted content lives in `mods/<name>/content.obw`. Classic content preserves
|
||||
the original edition's tables, rules, artwork and competition structure. A seal
|
||||
detects modified or damaged contents; reimport to repair a rejected package.
|
||||
- New saved games use `.obs`, including the starting world, complete career state,
|
||||
turn driver and both random streams. Settings, layouts and high scores use
|
||||
`.obsettings`, `.oblayout` and `.obscore`.
|
||||
- Personal files live in `userdata/<content-id>/`. Renaming or deleting a mod
|
||||
retains them; reimporting identical content reconnects them.
|
||||
- Use Add to migrate older `.FBM`, `.EIN` and `.MEN` files. Original Football
|
||||
Limited V2.20 saves have an edition-specific translator. Unsupported or damaged
|
||||
saves are reported rather than guessed. OpenBMH 0.1.2 cannot load native 0.2 saves.
|
||||
- Original saves did not record every random seed. Migration establishes a
|
||||
reproducible continuation; subsequent native saves preserve both streams exactly.
|
||||
- Starting-year selection changes displayed years, retaining Classic scheduling
|
||||
and weekday rules. Existing careers keep their saved year.
|
||||
|
||||
The GUI and console both run from native content. For direct startup:
|
||||
|
||||
```sh
|
||||
./OpenBMH --mod "mods/BMH-classic/content.obw"
|
||||
./openbmh_cli --console --mod "mods/BMH-classic/content.obw"
|
||||
```
|
||||
|
||||
See the [runtime and migration contract](../../formats/obw/runtime-0.2.md).
|
||||
|
||||
## Platforms and distribution
|
||||
|
||||
The build pipeline produces Windows x64, Linux x64 and macOS ARM64 ZIPs and a
|
||||
matching source ZIP with pinned dependency sources and build information.
|
||||
Builds and automated tests do not replace native interactive acceptance.
|
||||
The launcher requires OpenGL 3.3 (macOS: 4.1). Linux requires the platform libraries
|
||||
described in [BUILDING](../../BUILDING.md), including GTK3 for its folder picker.
|
||||
The macOS executable is unsigned and is not a notarised application bundle.
|
||||
|
||||
Platform-specific human confirmation remains open for
|
||||
[macOS filename entry](https://github.com/Weyoune/openbmh/issues/8),
|
||||
[Windows path display](https://github.com/Weyoune/openbmh/issues/9) and
|
||||
[Windows initial national-team selection](https://github.com/Weyoune/openbmh/issues/10).
|
||||
Their fixes are included and covered by automated/Linux checks; an HQA label
|
||||
does not claim that the original platform report has been verified on that OS.
|
||||
|
||||
No original executables, graphics, sound, databases or saved games are distributed.
|
||||
Supply a supported CD/later German or Football Limited installation; the original
|
||||
German floppy edition is unsupported. OpenBMH is GPL-3.0-only; bundled components
|
||||
retain their licenses. Keep all supplied notices and corresponding source material.
|
||||
@@ -0,0 +1,58 @@
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-only -->
|
||||
# OpenBMH Editor 0.5.1
|
||||
|
||||
Adds **Ratings & salaries / Wertevergleich**: sortable player, team and league
|
||||
overviews, searchable and filterable by country/league/club and attribute system.
|
||||
Choose the attribute columns and scroll horizontally for additional metrics.
|
||||
Click a row to open its existing editor. All three themes and both interface
|
||||
languages are supported.
|
||||
|
||||
Player values retain their native scales. Group ratings are player-weighted
|
||||
means; salaries are per-season amounts from contracts active at the world start
|
||||
date. Partial wage bills are marked, unknown values stay unknown, explicit zero
|
||||
salaries remain zero. All reserves are included; source-only duplicate evidence
|
||||
is excluded. Different rating systems are not combined. The read-only MCP tool
|
||||
`editor_compare` exposes the same results and pagination. Comparison caches
|
||||
refresh after edits and undo/redo without changing the world.
|
||||
|
||||
## Initial editor 0.5.0
|
||||
|
||||
The first standalone editor release uses SDL2, RmlUI and OpenGL on Windows x64,
|
||||
Linux x64 and macOS ARM64. Its version is independent of OpenBMH 0.2.0.
|
||||
|
||||
## Opening and editing worlds
|
||||
|
||||
Open an OBW archive, an unpacked world, or import a supported Bundesliga Manager
|
||||
Hattrick / Football Limited installation. Edit countries, competitions, clubs,
|
||||
players, squads, stadiums, referees and indexed artwork. Save exclusively as
|
||||
**OBW 1.1 `editor-world-v1`**. Legacy installations are not overwritten.
|
||||
|
||||
The interface offers German and English, Midnight Glass, Silver Glass and
|
||||
Matchday themes, shared undo/redo, validation and source-conflict review. Image
|
||||
import supports cropping, arbitrary rotation and mirroring while retaining the
|
||||
original. Shared placeholders remain intact when an individual image is edited.
|
||||
|
||||
The integrated authenticated MCP server is enabled by default on loopback.
|
||||
Configure its port and copy the connection in Options. GUI and MCP use the same
|
||||
transactions and revision checks; credentials remain in the local profile.
|
||||
|
||||
## Compatibility and limits
|
||||
|
||||
- Existing sealed Classic BMH/FLTD worlds can be opened and saved as editable
|
||||
worlds. Edited worlds cannot be played by the Classic 0.2 runtime and are
|
||||
never resealed as unmodified Classic content.
|
||||
- Complete source rosters, unknown extensions, image originals and source
|
||||
evidence are preserved. Missing facts remain missing; unresolved source
|
||||
conflicts remain visible. This release does not supply game data.
|
||||
- Modern season simulation, complete rule/calendar authoring and saved-career
|
||||
editing are outside this release. An editor-valid world does not establish
|
||||
that a season engine can play it.
|
||||
- The ZIP contains the executable, `assets/editor`, fonts and notices. Retain
|
||||
them together. Windows includes its app-local runtime. Linux needs the
|
||||
documented system libraries. macOS is unsigned and not notarised.
|
||||
|
||||
The release has matching platform archives and a corresponding source archive
|
||||
with pinned dependencies. Build/core/MCP checks run on all three platforms;
|
||||
native mouse/keyboard GUI checks run on Linux. Target-platform human acceptance
|
||||
remains separate. See the [editor guide](../../EDITOR.md) and
|
||||
[format contract](../../formats/obw/editor-v1.md).
|
||||
@@ -1,6 +1,8 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
#include "formats/executable_layout.hpp"
|
||||
#include "app/career_session.hpp"
|
||||
#include "content/save.hpp"
|
||||
#include "import/save.hpp"
|
||||
|
||||
#include <stdexcept>
|
||||
#include <system_error>
|
||||
@@ -420,16 +422,14 @@ void restore_saved_turn_cursor(TurnDriver& driver, GameState& state, const Datab
|
||||
if (!unsupported_continuation.empty()) return;
|
||||
|
||||
std::vector<int> active_leagues;
|
||||
// DayCompetitions2's competition bits expand to group leagues in this original order;
|
||||
// bit 2 owns both league 2 and 3. The stale descriptors after the active group count
|
||||
// are intentionally ignored.
|
||||
static constexpr int first_league[8] = {0, 1, 2, 4, 5, 6, 7, 8};
|
||||
static constexpr int league_count[8] = {1, 1, 2, 1, 1, 1, 1, 1};
|
||||
// Expand the selected edition's groups. Only the German third divisions
|
||||
// share bit 2; the English divisions each have their own calendar group.
|
||||
// Stale descriptors beyond the active group count are ignored.
|
||||
for (int bit = 0; bit < 5; ++bit) {
|
||||
if (!((competitions >> bit) & 1u)) continue;
|
||||
const int first = bit, last = bit < 4 ? bit + 1 : 8;
|
||||
for (int k = first; k < last; ++k)
|
||||
for (int league = first_league[k]; league < first_league[k] + league_count[k]; ++league)
|
||||
for (int league = kGroupLeague[k]; league < kGroupLeague[k] + kGroupLeagues[k]; ++league)
|
||||
active_leagues.push_back(league);
|
||||
}
|
||||
if (active_leagues.size() > 6)
|
||||
@@ -560,6 +560,11 @@ CareerSession::CareerSession(const std::filesystem::path& data, uint32_t watcom_
|
||||
session_id_ = next_session_id.fetch_add(1, std::memory_order_relaxed);
|
||||
initialize_club_modal_runtime();
|
||||
g_ = startup_state(exe_, db_, read_file(data / "M3.MEN"), read_file(data / "M3.DAT"));
|
||||
if (const auto resource = content::find(data)) {
|
||||
g_.display_start_year = resource->content->start_year;
|
||||
content::set_display_start_year(data, g_.display_start_year);
|
||||
exe_.set_display_start_year(g_.display_start_year);
|
||||
}
|
||||
g_.texts = &texts_;
|
||||
g_.currency_suffix = exe_.cstring(::bmh::layout::CurrencySuffixText); // CurrencySuffixText
|
||||
configure_training_camp_data(g_, exe_);
|
||||
@@ -567,14 +572,18 @@ CareerSession::CareerSession(const std::filesystem::path& data, uint32_t watcom_
|
||||
g_.credit_divisor = std::bit_cast<double>(uint64_t(exe_.u32(::bmh::layout::BankCredit_BankCreditContext_RuntimeField)) | uint64_t(exe_.u32(::bmh::layout::BankCredit_BankCreditContext_RuntimeField2)) << 32);
|
||||
g_.credit_rate_table_available = true;
|
||||
install_default_hooks();
|
||||
if (content::find(data))
|
||||
turn_driver_.desk_autosave = [this](const GameState &state, WatcomRandom &random) {
|
||||
write_desk_autosave(state, random);
|
||||
};
|
||||
startup_players(g_, game_, rand_); // CareerFirstSteps2
|
||||
MinuteReport report;
|
||||
if (!new_career_before_dialog(g_, game_, rand_, report)) // InitializeCareer up to the dialog
|
||||
throw std::runtime_error("career start: " + report.reason);
|
||||
}
|
||||
|
||||
CareerSession::CareerSession(const std::filesystem::path& data, uint32_t watcom_seed,
|
||||
const std::filesystem::path& save_path)
|
||||
CareerSession::CareerSession(const std::filesystem::path &data, uint32_t watcom_seed,
|
||||
const std::filesystem::path &save_path, bool importing_legacy)
|
||||
: data_directory_(data), exe_(load_le(data / "BMH.exe")), db_(load_database(data / "M3D.MAN")),
|
||||
texts_(load_textd(data / "TEXTD.BLK")), rand_(watcom_seed) {
|
||||
install_league_sizes(exe_);
|
||||
@@ -584,15 +593,62 @@ CareerSession::CareerSession(const std::filesystem::path& data, uint32_t watcom_
|
||||
? TransferAllocatorContext::zero : TransferAllocatorContext::blocked;
|
||||
session_id_ = next_session_id.fetch_add(1, std::memory_order_relaxed);
|
||||
initialize_club_modal_runtime();
|
||||
const Savegame file = load_savegame(save_path);
|
||||
if (!file.checksum_ok || file.version != "V2.24") throw std::runtime_error("savegame: unsupported or damaged FBM");
|
||||
const DbCounts counts{exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField), exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField3), exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField2), exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField4)};
|
||||
const SaveState save(file.stream, counts);
|
||||
g_ = GameState::from_save(save, counts);
|
||||
bool original_english_save = false;
|
||||
std::optional<content::SavedCareer> native;
|
||||
if (const auto resource = content::find(data); resource && !importing_legacy) {
|
||||
if (content::key(save_path.extension()) != ".obs")
|
||||
throw FormatError("0.2 loads native OBS saves; use Add to migrate legacy games");
|
||||
native = content::load_career(save_path, *resource->content);
|
||||
g_ = std::move(native->state);
|
||||
rand_ = native->random;
|
||||
game_ = native->game;
|
||||
} else {
|
||||
const Savegame file = load_savegame(save_path);
|
||||
original_english_save = file.version == "V2.20";
|
||||
if (!file.checksum_ok ||
|
||||
(file.version != "V2.24" && !(importing_legacy && kEnglishCompetitions && original_english_save)))
|
||||
throw FormatError("savegame: unsupported or damaged FBM");
|
||||
const DbCounts counts{exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField),
|
||||
exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField3),
|
||||
exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField2),
|
||||
exe_.u32(::bmh::layout::CareerSession_DataDirectory_RuntimeField4)};
|
||||
const auto stream = original_english_save ? obw::normalize_english_save(file, counts) : file.stream;
|
||||
const SaveState save(stream, counts);
|
||||
const auto manager_count = save.data(::bmh::layout::ManagerCount)[0];
|
||||
if (manager_count < 1 || manager_count > 4)
|
||||
throw FormatError("Invalid legacy manager count");
|
||||
if (importing_legacy) {
|
||||
size_t english_blocks = 0;
|
||||
for (const auto &[address, size] : kEnglishCompetitionBlocks)
|
||||
for (const auto &block : save.extension())
|
||||
if (block.address == address && block.bytes.size() == size)
|
||||
++english_blocks;
|
||||
if ((kEnglishCompetitions && english_blocks != std::size(kEnglishCompetitionBlocks)) ||
|
||||
(!kEnglishCompetitions && english_blocks != 0))
|
||||
throw FormatError(
|
||||
"Spielstand und Mod-Ausgabe passen nicht zusammen oder englische Pokaldaten fehlen.");
|
||||
}
|
||||
g_ = GameState::from_save(save, counts);
|
||||
if (importing_legacy && file.plain_header.size() >= 11) {
|
||||
const std::string year(file.plain_header.begin() + 7, file.plain_header.begin() + 11);
|
||||
if (std::all_of(year.begin(), year.end(), [](unsigned char c) { return std::isdigit(c); })) {
|
||||
const int elapsed = ui::desk_date(g_.date, exe_).year - exe_.display_start_year();
|
||||
const int origin = std::stoi(year) - elapsed;
|
||||
if (origin >= 1900 && origin <= 9998)
|
||||
g_.display_start_year = origin;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (content::find(data)) {
|
||||
content::set_display_start_year(data, g_.display_start_year);
|
||||
exe_.set_display_start_year(g_.display_start_year);
|
||||
}
|
||||
// CompetitionPointers2, after DeskDate2: these are process statics, not FBM fields.
|
||||
// Resuming within this month must not count it as a newly elapsed month.
|
||||
g_.autosave_months = 0;
|
||||
g_.autosave_month = month_code(g_.date);
|
||||
if (!native) {
|
||||
g_.autosave_months = 0;
|
||||
g_.autosave_month = month_code(g_.date);
|
||||
}
|
||||
// Original CompetitionPointers2 calls CompetitionPointers after loading the stream. This
|
||||
// rebinds pointer fields in the saved competition table before any resume
|
||||
// path dereferences them (the serialized values may point into the old process).
|
||||
@@ -604,10 +660,55 @@ CareerSession::CareerSession(const std::filesystem::path& data, uint32_t watcom_
|
||||
g_.credit_divisor = std::bit_cast<double>(uint64_t(exe_.u32(::bmh::layout::BankCredit_BankCreditContext_RuntimeField)) | uint64_t(exe_.u32(::bmh::layout::BankCredit_BankCreditContext_RuntimeField2)) << 32);
|
||||
g_.credit_rate_table_available = true;
|
||||
install_default_hooks();
|
||||
national_coach_after_load(g_); // (NationalCoachAfterLoad: a Bundestrainer takes the national team over again)
|
||||
if (g_.memory.has(::bmh::layout::CareerSession_Save_RuntimeField)) game_.set_seed(int32_t(g_.memory.u32(::bmh::layout::CareerSession_Save_RuntimeField)));
|
||||
restore_saved_turn_cursor(turn_driver_, g_, db_, session_id_, 1, saved_turn_error_);
|
||||
capture_source_desk_callargs();
|
||||
if (content::find(data))
|
||||
turn_driver_.desk_autosave = [this](const GameState &state, WatcomRandom &random) {
|
||||
write_desk_autosave(state, random);
|
||||
};
|
||||
if (!native)
|
||||
national_coach_after_load(
|
||||
g_); // (NationalCoachAfterLoad: a Bundestrainer takes the national team over again)
|
||||
if (!native && g_.memory.has(::bmh::layout::CareerSession_Save_RuntimeField))
|
||||
game_.set_seed(int32_t(g_.memory.u32(::bmh::layout::CareerSession_Save_RuntimeField)));
|
||||
if (native) {
|
||||
content::restore_driver(turn_driver_, native->driver);
|
||||
restore_native_session_context(native->session);
|
||||
turn_driver_.session_id = session_id_;
|
||||
turn_driver_.revision = 1;
|
||||
exe_.set_display_start_year(g_.display_start_year);
|
||||
} else if (original_english_save &&
|
||||
!g_.memory.u8(::bmh::layout::CareerSession_RuntimeError_RuntimeField4)) {
|
||||
// V2.20 never stored transient match descriptors. Like its original loader,
|
||||
// rebuild the current groups without replaying daily/financial progression
|
||||
// or shuffling the saved manager order.
|
||||
const int day = g_.season_day();
|
||||
if (day < 0 || day >= 365)
|
||||
throw FormatError("V2.20 calendar day is invalid");
|
||||
const auto entry = g_.memory.u16(::bmh::layout::CompetitionCalendar + uint32_t(day) * 2);
|
||||
const auto competitions = g_.memory.u32(::bmh::layout::SavedCompetition);
|
||||
std::vector<uint8_t> referees = db_.raw_referee_properties;
|
||||
for (auto &referee : referees)
|
||||
referee &= 0x7f;
|
||||
MatchdayContext context;
|
||||
context.month = month_code(g_.date);
|
||||
context.season_day = day;
|
||||
context.weekday = ui::desk_date(g_.date, exe_).weekday;
|
||||
context.referees = &referees;
|
||||
MinuteReport report;
|
||||
auto groups = setup_matchday(g_, competitions, context, game_, rand_, report);
|
||||
if (report.unsupported)
|
||||
throw FormatError("V2.20 continuation: " + report.reason);
|
||||
std::string error;
|
||||
if (!begin_turn_driver(turn_driver_, g_, std::move(groups), entry, db_.raw_referee_properties,
|
||||
session_id_, 1, error))
|
||||
throw FormatError(error);
|
||||
turn_driver_.referees = std::move(referees);
|
||||
turn_driver_.loaded_matchday_resume = true;
|
||||
} else
|
||||
restore_saved_turn_cursor(turn_driver_, g_, db_, session_id_, 1, saved_turn_error_);
|
||||
if (importing_legacy && !saved_turn_error_.empty())
|
||||
throw FormatError(saved_turn_error_);
|
||||
if (!native)
|
||||
capture_source_desk_callargs();
|
||||
}
|
||||
|
||||
int CareerSession::runtime_club(int master) const { return runtime_club(g_, master); }
|
||||
@@ -4129,6 +4230,7 @@ bool CareerSession::finish(ui::CareerInitializationResult& result, std::string&
|
||||
for (size_t m = 0; m < managers_.size(); ++m)
|
||||
managers_[m].runtime_club = g_.manager_teams.at(m);
|
||||
result.managers = managers_;
|
||||
flush_native_autosave();
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -4335,6 +4437,7 @@ TurnAdvanceResult CareerSession::dispatch_kickoff(const ui::DeskRequest& request
|
||||
return id < names.size() ? names[id] : std::string();
|
||||
}, exe_, g_);
|
||||
}
|
||||
flush_native_autosave();
|
||||
return result;
|
||||
}
|
||||
|
||||
@@ -4800,7 +4903,10 @@ bool CareerSession::apply_settings_file(const ui::SaveLoadRequest& request,int m
|
||||
std::string extension=request.path.extension().string();
|
||||
std::transform(extension.begin(),extension.end(),extension.begin(),
|
||||
[](unsigned char c){return char(std::tolower(c));});
|
||||
if(extension!=".ein") {error="invalid_settings_file_extension";return false;}
|
||||
if (extension != (content::find(data_directory_) ? ".obsettings" : ".ein")) {
|
||||
error = "invalid_settings_file_extension";
|
||||
return false;
|
||||
}
|
||||
const uint32_t base=::bmh::layout::LeaguePresentationOptions;
|
||||
if(!staged.memory.has(base+uint32_t(kBytes-1))) {error="settings_file_memory_unavailable";return false;}
|
||||
std::error_code ec;
|
||||
@@ -4808,7 +4914,14 @@ bool CareerSession::apply_settings_file(const ui::SaveLoadRequest& request,int m
|
||||
if(!ec&&std::filesystem::is_symlink(status)) {error="settings_file_target_is_symlink";return false;}
|
||||
if(request.action==ui::SaveLoadAction::load) {
|
||||
Bytes bytes;
|
||||
try {bytes=read_file(request.path);}catch(const std::exception&) {error="settings_file_read_failed";return false;}
|
||||
try {
|
||||
bytes = content::find(data_directory_)
|
||||
? content::load_preferences(request.path, "settings", kBytes)
|
||||
: read_file(request.path);
|
||||
} catch (const std::exception &) {
|
||||
error = "settings_file_read_failed";
|
||||
return false;
|
||||
}
|
||||
if(bytes.size()!=kBytes) {error="settings_file_wrong_size";return false;}
|
||||
for(size_t i=0;i<kBytes;++i)staged.memory.set8(base+uint32_t(i),bytes[i]);
|
||||
std::array<uint8_t,kBytes> raw{};
|
||||
@@ -4831,6 +4944,11 @@ bool CareerSession::apply_settings_file(const ui::SaveLoadRequest& request,int m
|
||||
Bytes bytes(kBytes);
|
||||
for(size_t i=0;i<kBytes;++i)bytes[i]=staged.memory.u8(base+uint32_t(i));
|
||||
try {
|
||||
if (content::find(data_directory_)) {
|
||||
content::save_preferences(request.path, "settings", bytes, request.overwrite);
|
||||
error.clear();
|
||||
return true;
|
||||
}
|
||||
std::ofstream file(request.path,std::ios::binary|std::ios::trunc);
|
||||
if(!file) {error="settings_file_write_failed";return false;}
|
||||
file.write(reinterpret_cast<const char*>(bytes.data()),std::streamsize(bytes.size()));file.flush();
|
||||
@@ -7522,6 +7640,11 @@ std::string CareerSession::take_autosave_error() {
|
||||
}
|
||||
|
||||
void CareerSession::write_desk_autosave(const GameState& state, WatcomRandom& random) {
|
||||
// OpenBMH deviates from the original: native saves do not consume gameplay randomness for encryption.
|
||||
if (content::find(data_directory_)) {
|
||||
native_autosave_pending_ = bool(autosave_directory_);
|
||||
return;
|
||||
}
|
||||
std::filesystem::path temporary;
|
||||
try {
|
||||
if (!autosave_directory_ || !std::filesystem::is_directory(*autosave_directory_))
|
||||
@@ -7556,6 +7679,83 @@ void CareerSession::write_desk_autosave(const GameState& state, WatcomRandom& ra
|
||||
}
|
||||
}
|
||||
|
||||
cli::Json CareerSession::native_session_context() const {
|
||||
cli::Json::Array runtime, callargs, managers;
|
||||
for (const auto &[address, value] : club_modal_runtime_)
|
||||
runtime.emplace_back(cli::Json::Object{{"address", int64_t(address)}, {"value", int(value)}});
|
||||
for (const auto &args : source_desk_callargs_)
|
||||
callargs.emplace_back(cli::Json::Array{args.competition, args.opponent});
|
||||
for (const auto &manager : managers_)
|
||||
managers.emplace_back(cli::Json::Array{manager.slot, manager.master_club, manager.runtime_club});
|
||||
return cli::Json::Object{{"schema", "classic-session@1.0"},
|
||||
{"runtime", std::move(runtime)},
|
||||
{"desk_callargs", std::move(callargs)},
|
||||
{"managers", std::move(managers)}};
|
||||
}
|
||||
void CareerSession::restore_native_session_context(const cli::Json &root) {
|
||||
const auto field = [&](const char *name) -> const cli::Json & {
|
||||
if (!root.object() || !root.object()->contains(name))
|
||||
throw FormatError("Native session field missing");
|
||||
return root.object()->at(name);
|
||||
};
|
||||
if (!field("schema").string() || *field("schema").string() != "classic-session@1.0")
|
||||
throw FormatError("Unsupported native session");
|
||||
const auto array = [](const cli::Json &j, size_t maximum) -> const cli::Json::Array & {
|
||||
if (!j.array() || j.array()->size() > maximum)
|
||||
throw FormatError("Invalid native session array");
|
||||
return *j.array();
|
||||
};
|
||||
const auto integer = [](const cli::Json &j, int64_t low, int64_t high) -> int64_t {
|
||||
if (!j.integer() || *j.integer() < low || *j.integer() > high)
|
||||
throw FormatError("Invalid native session integer");
|
||||
return *j.integer();
|
||||
};
|
||||
std::map<uint32_t, uint8_t> runtime;
|
||||
for (const auto &row : array(field("runtime"), 8192)) {
|
||||
if (!row.object() || !row.object()->contains("address") || !row.object()->contains("value"))
|
||||
throw FormatError("Invalid runtime byte");
|
||||
const auto at = uint32_t(integer(row.object()->at("address"), 0, UINT32_MAX));
|
||||
if (!club_modal_runtime_.contains(at) ||
|
||||
!runtime.emplace(at, uint8_t(integer(row.object()->at("value"), 0, 255))).second)
|
||||
throw FormatError("Unknown or duplicated runtime byte");
|
||||
}
|
||||
if (runtime.size() != club_modal_runtime_.size())
|
||||
throw FormatError("Incomplete native runtime bytes");
|
||||
std::vector<ui::DeskMatchCallargs> callargs;
|
||||
for (const auto &row : array(field("desk_callargs"), 4)) {
|
||||
const auto &fields = array(row, 2);
|
||||
if (fields.size() != 2)
|
||||
throw FormatError("Invalid desk arguments");
|
||||
callargs.push_back({int(integer(fields[0], -1, 255)), int(integer(fields[1], -1, 4095))});
|
||||
}
|
||||
std::vector<ui::InitializedManager> managers;
|
||||
for (const auto &row : array(field("managers"), 4)) {
|
||||
const auto &fields = array(row, 3);
|
||||
if (fields.size() != 3)
|
||||
throw FormatError("Invalid manager mapping");
|
||||
managers.push_back({int(integer(fields[0], 0, 3)), int(integer(fields[1], 0, 4095)),
|
||||
int(integer(fields[2], 0, 4095))});
|
||||
}
|
||||
club_modal_runtime_ = std::move(runtime);
|
||||
source_desk_callargs_ = std::move(callargs);
|
||||
managers_ = std::move(managers);
|
||||
}
|
||||
void CareerSession::flush_native_autosave() {
|
||||
if (!std::exchange(native_autosave_pending_, false))
|
||||
return;
|
||||
try {
|
||||
if (!autosave_directory_ || !std::filesystem::is_directory(*autosave_directory_))
|
||||
throw FormatError("Autosave directory unavailable");
|
||||
const auto resource = content::find(data_directory_);
|
||||
if (!resource)
|
||||
throw FormatError("Native content unavailable");
|
||||
content::save_career(*autosave_directory_ / "AUTOSAVE.obs", *resource->content, g_, rand_, game_,
|
||||
turn_driver_, true, native_session_context());
|
||||
} catch (const std::exception &e) {
|
||||
autosave_error_ = e.what();
|
||||
}
|
||||
}
|
||||
|
||||
bool CareerSession::save_game(const std::filesystem::path& path, int manager_slot, bool overwrite, std::string& error) {
|
||||
if (advertising_renewal_dispatch_active_) { error="save_blocked_during_advertising_renewal"; return false; }
|
||||
if(balance_draft_||balance_dispatch_active_||strengths_owner_||strengths_dispatch_active_||
|
||||
@@ -7569,7 +7769,7 @@ bool CareerSession::save_game(const std::filesystem::path& path, int manager_slo
|
||||
std::string extension = path.extension().string();
|
||||
std::transform(extension.begin(), extension.end(), extension.begin(), [](unsigned char c) { return char(std::tolower(c)); });
|
||||
if (manager_slot != active || manager_slot < 0 || size_t(manager_slot) >= g_.manager_teams.size() ||
|
||||
extension != ".fbm" || path.filename().empty()) {
|
||||
extension != (content::find(data_directory_) ? ".obs" : ".fbm") || path.filename().empty()) {
|
||||
error = "invalid_save_request"; return false;
|
||||
}
|
||||
std::error_code ec;
|
||||
@@ -7582,6 +7782,11 @@ bool CareerSession::save_game(const std::filesystem::path& path, int manager_slo
|
||||
const bool exists = std::filesystem::exists(path, ec);
|
||||
if (ec || (exists && !overwrite)) { error = exists ? "overwrite_confirmation_required" : "save_target_unavailable"; return false; }
|
||||
try {
|
||||
if (const auto resource = content::find(data_directory_)) {
|
||||
content::save_career(path, *resource->content, g_, rand_, game_, turn_driver_, overwrite,
|
||||
native_session_context());
|
||||
return true;
|
||||
}
|
||||
WatcomRandom staged_rand = rand_;
|
||||
const Savegame save = make_savegame(g_, staged_rand);
|
||||
write_savegame(path, save);
|
||||
@@ -7623,7 +7828,10 @@ bool CareerSession::dispatch_menu_layout(const ui::SaveLoadRequest& request, uin
|
||||
std::string extension = request.path.extension().string();
|
||||
std::transform(extension.begin(), extension.end(), extension.begin(),
|
||||
[](unsigned char c) { return char(std::tolower(c)); });
|
||||
if (extension != ".men") { error = "invalid_menu_layout_extension"; return false; }
|
||||
if (extension != (content::find(data_directory_) ? ".oblayout" : ".men")) {
|
||||
error = "invalid_menu_layout_extension";
|
||||
return false;
|
||||
}
|
||||
const size_t active_base = size_t(request.manager_slot) * 0xb0c;
|
||||
if (active_base + 0xb0c > g_.manager_records.size() ||
|
||||
size_t(request.manager_slot) >= g_.manager_teams.size() ||
|
||||
@@ -7668,8 +7876,14 @@ bool CareerSession::dispatch_menu_layout(const ui::SaveLoadRequest& request, uin
|
||||
|
||||
if (request.action == ui::SaveLoadAction::load) {
|
||||
Bytes payload;
|
||||
try { payload = read_file(request.path); }
|
||||
catch (const std::exception&) { error = "menu_layout_read_failed"; return false; }
|
||||
try {
|
||||
payload = content::find(data_directory_)
|
||||
? content::load_preferences(request.path, "layout", kLayoutBytes)
|
||||
: read_file(request.path);
|
||||
} catch (const std::exception &) {
|
||||
error = "menu_layout_read_failed";
|
||||
return false;
|
||||
}
|
||||
if (!validate_payload(payload)) return false;
|
||||
GameState staged = g_;
|
||||
for (size_t i = 0; i < kLayoutBytes; ++i)
|
||||
@@ -7704,6 +7918,12 @@ bool CareerSession::dispatch_menu_layout(const ui::SaveLoadRequest& request, uin
|
||||
for (size_t i = 0; i < kLayoutBytes; ++i) payload[i] = g_.memory.u8(base + uint32_t(i));
|
||||
if (!validate_payload(payload)) return false;
|
||||
try {
|
||||
if (content::find(data_directory_)) {
|
||||
content::save_preferences(request.path, "layout", payload, request.overwrite);
|
||||
++revision;
|
||||
error.clear();
|
||||
return true;
|
||||
}
|
||||
std::ofstream file(request.path, std::ios::binary | std::ios::trunc);
|
||||
if (!file) { error = "menu_layout_write_failed"; return false; }
|
||||
file.write(reinterpret_cast<const char*>(payload.data()), std::streamsize(payload.size()));
|
||||
|
||||
@@ -808,7 +808,8 @@ public:
|
||||
bool dispatch_menu_layout(const ui::SaveLoadRequest&, uint64_t& revision, std::string& error);
|
||||
|
||||
// Load an existing V2.24 save without applying new-career options or startup RNG.
|
||||
CareerSession(const std::filesystem::path& data, uint32_t watcom_seed, const std::filesystem::path& save_path);
|
||||
CareerSession(const std::filesystem::path &data, uint32_t watcom_seed,
|
||||
const std::filesystem::path &save_path, bool importing_legacy = false);
|
||||
|
||||
const GameState& state() const { return g_; }
|
||||
GameState& state() { return g_; }
|
||||
@@ -883,6 +884,10 @@ private:
|
||||
std::optional<std::filesystem::path> autosave_directory_;
|
||||
std::string autosave_error_;
|
||||
void write_desk_autosave(const GameState&, WatcomRandom&);
|
||||
bool native_autosave_pending_ = false;
|
||||
void flush_native_autosave();
|
||||
cli::Json native_session_context() const;
|
||||
void restore_native_session_context(const cli::Json &);
|
||||
bool live_source_identity(const ui::StrengthsIdentity&) const;
|
||||
bool validate_desk_setting_owner(const DeskSettingIdentity&, uint64_t revision, std::string& error,
|
||||
bool require_desk_phase = true) const;
|
||||
|
||||