Widelands

GPL v2+. Some assets are released under various Creative Commons licenses – see the respective folders. We support compiling Widelands for Linux, Windows under MSys2 and MSVC, and MacOS with GCC = 8 or Clang/LLVM = 7, though it might work with other compilers too. We have more detailed documentation available at: ./compile.sh Full debug build ./compile.sh -r -w Release build ./compile.sh -e -w Release build with debugging symbols ./compile.sh -h List available options We have various CMake options available. For example, to create a release build, call Depending on the Ninja installation, the last line can also be ninja-build . Note that CMake options are prefixed with -D . These are the available options: CMAKE BUILD TYPE Debug / Release / RelWithDebInfo Debug Create a release or debug build OPTION ASAN ON / OFF ON for Debug builds / OFF for Release builds Use AddressSanitizer. Switching this off only works once. You will have to clear the build directory if you want to switch this off again in a later build. OPTION TSAN ON / OFF OFF Use ThreadSanitizer. Mutually exclusive with OPTION ASAN . OPTION BUILD CODECHECK ON / OFF ON Build codecheck. Only available in Debug builds. OPTION BUILD WEBSITE TOOLS ON / OFF ON Build website-related tools OPTION BUILD TESTS ON / OFF ON Build unit tests CMAKE INSTALL PREFIX A directory See CMake documentation Define the target directory for the "install" target, e.g. -DCMAKE INSTALL PREFIX=~/widelands-install . WL INSTALL BINDIR A directory ${CMAKE INSTALL PREFIX}/games Define the destination of executables files (if installing) WL VERSION A version string Autodetected from git/bzr, or set by adding a VERSION file Define the Widelands version USE FLTO IF AVAILABLE ON / OFF Autodetected Use link-time optimization USE XDG ON / OFF ON Follow XDG-Basedir specification. Only available on Linux. OPTION USE GLBINDING ON / OFF OFF Use glbinding instead of GLEW OPTION GLEW STATIC ON / OFF OFF Use static GLEW Library OPTION BUILD WINSTATIC ON / OFF OFF Build a static linked .exe on windows OPTION FORCE EMBEDDED MINIZIP ON / OFF OFF Used embedded minizip sources (skip checking for installed minizip library) NEEDS EXTERNAL FILESYSTEM ON / OFF Autodetected from compiler version Whether std::filesystem needs to be linked against an extra library You can add targets to the make or ninja command, e.g. make codecheck to only run the code check suite. These are the available targets: ALL or no target Compile everything, up to executable with the settings from the cmake call codecheck Run the codechecks doc Generate Doxygen documentation. Currently only with Build Type Debug, but this is easily changed if necessary. install Install into the target dir, this is /usr/local per default (you need root privileges!) unless you change it (see CMake options above) The master branch and all issues and pull requests are mirrored bidirectionally between our developer environments on Codeberg and GitHub by bunnybot. Bunnybot also formats the code (C++, Lua, and Python) in all mirrored branches. Pull requests that have been generated by AI may be closed immediately in order to prevent their time-consuming and often fruitless reviews and discussions. cmake Build system and codecheck rules data The game's data files. Images, sounds, music, scripting, maps, campaigns, tribes, ... debian Packaging for Debian-based Linux distributions doc Sphinx documentation src C++ source code test Scripted maps for our regression test suite utils Diverse utilities: Building translations, code formatting, packaging Mac & Windows, ... xdg Files related to X Desktop Group Base Directory Specification All pull request branches as well as master are additionally deployed for MacOS, and a testsuite checks them under various compilers. To obtain MacOS builds or testsuite results, temporarily add the name of your branch to the branches section in .github/workflows/build.yaml . This does work for branches in forks as well.