Skip to content

README.md

Latest commit

 

History

History
230 lines (175 loc) · 8.59 KB

README.md

File metadata and controls

230 lines (175 loc) · 8.59 KB
Raw

How to build

Quickstart Windows / Visual Studio 2019 (and newer) variant: dependencies are downloaded, no CMake needed

For a pre-compiled download of all external/third-party dependencies:

Download VPinballX-10.8.1-(revision)-(SHA1)-dev-third-party-windows-(x86/x64)-(Debug/Release).zip from Actions of a vpinball run, and extract the content to the third-party folder in the top directory, overwriting all existing files.

Run the create_vs_solution.bat from this folder here and select the Visual Studio version that will be used. This will create .sln/.proj files in the top directory.

If DirectX9 rendering / compilation is wanted, install the Microsoft DirectX SDK from 2021 (currently at DX SDK).

Otherwise, using the full build system via CMake:

Build tools and libraries

Depending on the platform you are on you will need to install additional build tools and libraries.

Windows

External dependencies

Some external dependencies are required to build Visual Pinball. To fetch and build these, we have provided a script for each platform. This script must be run from the root of project.

platforms/[platform]/external.sh

Building via CMake

Each target/platform combination has a CMakeLists_[target]_[platform].txt file in the make directory. Copy this file to CMakeLists.txt at the root of the project.

  • target can be one of the following:
    • bgfx (recommended) - uses bgfx to support multiple rendering backends
    • gl - OpenGL
    • dx9 - DirectX 9
  • platform should be the same one as you used to build the external dependencies.
cp make/CMakeLists_[target]_[platform].txt CMakeLists.txt

Supported Platforms

windows-x64 
platforms/windows-x64/external.sh
cp make/CMakeLists_bgfx-windows-x64.txt CMakeLists.txt
cmake -G "Visual Studio 17 2022" -A x64 -B build
cmake --build build --config Release
windows-x86 
platforms/windows-x86/external.sh
cp make/CMakeLists_bgfx-windows-x86.txt CMakeLists.txt
cmake -G "Visual Studio 17 2022" -A Win32 -B build
cmake --build build --config Release
macos-arm64 
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
brew install autoconf automake libtool cmake bison curl
export PATH="$(brew --prefix bison)/bin:$PATH"
platforms/macos-arm64/external.sh
cp make/CMakeLists_bgfx-macos-arm64.txt CMakeLists.txt
cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(sysctl -n hw.ncpu)

build/VPinballX_BGFX.app/Contents/MacOS/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
macos-x64 
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
brew install autoconf automake libtool cmake nasm bison curl
export PATH="$(brew --prefix bison)/bin:$PATH"
platforms/macos-x64/external.sh
cp make/CMakeLists_bgfx-macos-x64.txt CMakeLists.txt
cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(sysctl -n hw.ncpu)

build/VPinballX_BGFX.app/Contents/MacOS/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
linux-x64 (Ubuntu) 
sudo apt-get update
sudo apt install git build-essential autoconf automake libtool cmake nasm bison curl zlib1g-dev libdrm-dev libgbm-dev libglu1-mesa-dev libegl-dev libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev libudev-dev libx11-dev libxrandr-dev libasound2-dev libpipewire-0.3-dev
platforms/linux-x64/external.sh
cp make/CMakeLists_bgfx-linux-x64.txt CMakeLists.txt
cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(nproc)

build/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
ios-arm64 (and ios-simulator-arm64) 
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
brew install cmake bison curl
export PATH="$(brew --prefix bison)/bin:$PATH"
platforms/ios-arm64/external.sh
#platforms/ios-simulator-arm64/external.sh
cp make/CMakeLists_bgfx_lib.txt CMakeLists.txt
cmake -DPLATFORM=ios -DARCH=arm64 -DCMAKE_BUILD_TYPE=Release -B build/ios-arm64
cmake --build build/ios-arm64 -- -j$(sysctl -n hw.ncpu)
#cmake -DPLATFORM=ios-simulator -DARCH=arm64 -DCMAKE_BUILD_TYPE=Release -B build/ios-simulator-arm64
#cmake --build build/ios-simulator-arm64 -- -j$(sysctl -n hw.ncpu)

open standalone/ios/VPinball.xcodeproj
android-arm64-v8a 
brew install cmake bison curl
export PATH="$(brew --prefix bison)/bin:$PATH"
export JAVA_HOME=$(/usr/libexec/java_home -v 17.0.11)
export ANDROID_HOME=/Users/jmillard/Library/Android/sdk
export ANDROID_NDK=/Users/jmillard/Library/Android/sdk/ndk/27.0.12077973
export ANDROID_NDK_HOME=/Users/jmillard/Library/Android/sdk/ndk/27.0.12077973
platforms/android-arm64-v8a/external.sh
cp make/CMakeLists_bgfx_lib.txt CMakeLists.txt
cmake -DPLATFORM=android -DARCH=arm64-v8a -DCMAKE_BUILD_TYPE=Release -B build/android-arm64-v8a
cmake --build build/android-arm64-v8a -- -j$(sysctl -n hw.ncpu)
cd standalone/android
./gradlew assembleDebug

Unsupported Platforms

linux-x64 (Fedora) 
sudo dnf install @development-tools
sudo dnf install gcc-c++ autoconf automake libtool cmake nasm bison curl systemd-devel libX11-devel mesa-libGL-devel libXext-devel zlib-ng-compat-static zlib-ng-compat-devel wayland-devel libxkbcommon-devel
platforms/linux-x64/external.sh
cp make/CMakeLists_bgfx-linux-aarch64.txt CMakeLists.txt
cmake -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(nproc)

build/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
linux-aarch64 (Fedora Asahi Remix 41 - Apple silicon) 
sudo dnf install @development-tools
sudo dnf install gcc-c++ autoconf automake libtool cmake nasm bison curl systemd-devel libX11-devel mesa-libGL-devel libXext-devel zlib-ng-compat-static zlib-ng-compat-devel wayland-devel libxkbcommon-devel
platforms/linux-x64/external.sh
cp make/CMakeLists_bgfx-linux-aarch64.txt CMakeLists.txt
cmake -DBUILD_RK3588=ON -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(nproc)

build/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
linux-aarch64 (RPI) 
sudo apt-get update
sudo apt install git pkg-config autoconf automake libtool cmake bison zlib1g-dev libdrm-dev libgbm-dev libgles2-mesa-dev libgles2-mesa libudev-dev libx11-dev libxrandr-dev libasound2-dev libpipewire-0.3-dev
platforms/linux-aarch64/external.sh
cp make/CMakeLists_bgfx-linux-aarch64.txt CMakeLists.txt
cmake -DBUILD_RPI=ON -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(nproc)

build/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen
linux-aarch64 (RK3588) 
sudo apt-get update
sudo apt install git pkg-config autoconf automake libtool cmake bison zlib1g-dev libdrm-dev libgbm-dev libgles2-mesa-dev libgles2-mesa libudev-dev libx11-dev libxrandr-dev libasound2-dev libpipewire-0.3-dev
platforms/linux-aarch64/external.sh
cp make/CMakeLists_bgfx-linux-aarch64.txt CMakeLists.txt
cmake -DBUILD_RK3588=ON -DCMAKE_BUILD_TYPE=Release -B build
cmake --build build -- -j$(nproc)

build/VPinballX_BGFX -play src/assets/exampleTable.vpx -disabletruefullscreen

Note

Instructions for unsupported platforms are provided as-is and are not officially maintained by the team. Community contributions to improve and update them are welcome.

Continuous Integration

Inspecting the CI workflows is also a good way to understand how everything is built.

Note

Due to the large storage requirements and build times for external dependencies, pull requests currently do not trigger continuous integration. We recommend enabling GitHub Actions on your fork.