openblack is an open source reimplementation of Black & White (2001) developed using modern C++ and rendering technologies like OpenGL and Vulkan.
Original game assets are required to run openblack. See further below for an explanation on how to extract them.
- OpenBlack: An open-source reimplementation of Black & White (2001).
- Black & White (2001): A god simulation game developed by Lionhead Studios.
- vcpkg: A package manager for C++ libraries.
- CMake: A tool used for managing the build process in a compiler-independent manner.
- OpenGL: A cross-platform graphics API used for rendering.
- Vulkan: A modern, low-overhead graphics API.
- Clang: A compiler for C, C++, and Objective-C.
- MSVC: Microsoft Visual C++ Compiler.
- Xcode: Apple’s integrated development environment (IDE) for macOS.
- Android Studio: The official IDE for Android development.
- Flatpak: A software deployment and package management system.
- AppImage: A format for distributing portable software on Linux.
- Snap: A package management system developed by Canonical.
- Git: A version control system for tracking source code changes.
- Ninja: A small build system with a focus on speed.
- Arch Linux: A lightweight and flexible Linux distribution.
- Submodules: External repositories included within a Git repository.
- Presets: Predefined configurations for building software.
For the latest build of openblack without having to build it yourself, we offer pre-built binaries from our test service.
-333333){kind=icon}
-eeeeee){kind=icon}
-0078d4){kind=icon}
TThe following builds are experimental. They require additional setup, effort, and possibly custom patches to work correctly. Users should be prepared for troubleshooting when using these versions.
-0078d4){kind=icon}
-0078d4){kind=icon}
-333333){kind=icon}
-333333){kind=icon}
Clone the code using: git clone --recursive https://github.com/openblack/openblack.git
If you forgot to add --recursive, you will have to also run git submodule update --init from the openblack/ directory.
The easiest way to install all dependencies is via vcpkg which is comes with a manifest file.
The easiest way to get started on any platform is to allow CMake and vcpkg to handle all dependencies and configuration
for you. To do so, you will be selecting the "ninja-multi-vcpkg" - Ninja Multi-Config (vcpkg) preset. Other presets are available for more advanced users.
- Install Visual Studio Code
- Install the C++ Extension
- The extension might not be required on Linux
- Install a compiler depending on your platform
- GNU or Clang compilers on Linux
- Visual Studio's MSVC on Windows (See Visual Studio)
- Clang compiler on Mac
- Install the CMake Tools Extension
- Install CMake version 3.20+
- You can simply open the
openblackfolder directly in Visual Studio Code and select a preset.
- Install Visual Studio
- Select an appropriate MSVC C++ Component for your version
- Select an appropriate Windows SDK Component for your version
- Select the C++ CMake tools for Windows Component
- You can simply open the
openblackfolder directly in Visual Studio and select a preset.
- Install Clion
- You can simply open the
openblackfolder directly in CLion and select a preset.
- Install XCode
- Install the homebrew depenedencies using homebrew:
brew install cmake ninja pkg-config - Run
sudo xcode-select --resetafter installing cmake - You need to configure using the cmake preset
xcode-vcpkgusing cmake in either the GUI or using the command line argument--preset xcode-vcpkg
- Install Android Studio
- Install a recent SDK and an NDK of at least 23
- Open openblack from the
androiddirectory - Set the SDK and NDK in the project settings
- Do gradle configure which will run cmake configuration and compile the vcpkg dependencies
- Build the project for either a virtual device or a connected device
- Currently requires user to upload game assets to
/data/local/tmp/bwandchmod -R a+wrx /data/local/tmp/bwwith adb
- Get emsdk
- Add the directory of emsdk as the
EMSDKenvironment variable. - Run
emsdk install latest - Run
emsdk activate latest - Build the
emscripten-vcpkgpreset
- Your usual build tool-chain.
- Ubuntu / Debian:
# apt install build-essential cmake ninja-build - Arch Linux / Manjaro:
# pacman -S base-devel cmake ninja
- Ubuntu / Debian:
- You can generate the cmake build preset using
cmake --presetand you can list the presets usingcmake --list-presets
If you don't want to use vcpkg; CMake will use system libraries, or manually specified package directories.
CMake will find the required libraries as long as they provide a proper config file.
Install openblack-git from the AUR which builds and installs directly for all Arch Linux derived distros such as Manjaro. This will require pacman to install all required dependencies.
The prefix to use is "linux-system-deps" - Linux (System Deps)
Contributions are always welcome, whether it's modifying source code to add new features or bug fixes, documenting new file formats or simply editing some grammar.
You can also join the Discord for development discussion if you are unsure of anything.
As mentioned before, the original game assets are required in order to run openblack. Since these data are copyrighted, we won't provide them, so please don't ask. Here is a guide for extracting them from the original game.
You will need the following:
- The original installer (usually on a CD)
- Official patch 1.10
- Official patch 1.2
- Not needed (but will not compromise the extraction): Unofficial patch 1.42
Do not install 1.3, it is a patch to add P5 Power Glove support and is generally unstable
- Install the game from the installer, remember the installation directory
(
C:\\Program Files (x86)\\Lionhead Studios\\Black & White\\is the default) - Install the official patch 1.10 (in the same directory)
- Install the official patch 1.2 (in the same directory)
If you run on Linux or macOS, you can install the game with Wine (App Page on WineHQ).
- Install
wine - Run
wine Setup.exefrom the directory containing the installer, don't change the install path - Run
wine Black_White_Patch_v1.100.exefrom the directory containing the first patch (adapt the command in case the filename isn't exactly that) - Run
wine black_white_patch_v1_20.exefrom the directory containing the second patch (adapt too) - In case you would like to install the unofficial patch, it requires .NET 2.0,
that can be installed with
winetricks dotnet20sp2(you should installwinetricks first)
All the files should be installed in the following directory:
~/.wine/drive_c/Program Files (x86)/Lionhead Studios Ltd/Black & White
The folders you're interested in are the Audio, Data and Scripts folders in the
installation directory. You can use them from there or make a copy to the
location of your choice.
If you want to use them from there, remember the installation directory chosen in the installation step, unless you changed it, it should be either:
- either
C:\\Program Files (x86)\\Lionhead Studios\\Black & White\\ - or
~/.wine/drive_c/Program Files (x86)/Lionhead Studios Ltd/Black & White
This is the path you will give to openblack (using the -g flag).
If you prefer to copy the data (e.g. if you want to uninstall the original
game), just copy the Data and Scripts folders to the desired new location,
and give the path to this location to openblack (using the -g flag).
openblack is released as open source software under the GPL v3 license, see the license file in the project root for the full license text.