fheroes2 build and contribution guide

Build

Please follow the instructions below to be able to build the project from source:

Note: You will need to clone the fheroes2 project before following the instructions below.

Windows

• Go to the directory script/windows and run the file install_packages.bat. This script will install all the required packages to build the project using Microsoft Visual Studio.
• If you have the original game, then copy the subdirectories ANIM, DATA, MAPS and MUSIC (some of them may be missing depending on the version of the original game) to the project root directory.
• Alternatively, go to the directory script/demo and run the file download_demo_version.bat. This script will download a demo version of the original game, which is the minimum required for development.
• Open the file fheroes2-vs2019.vcxproj (targeted for Visual Studio 2019) and build the project.
• Visual Studio will automatically copy game files in the root directory to the build directory.

macOS and Linux

• Depending on your OS, run the following scripts to install the dependencies required for the build:
  • macOS: go to the directory script/macos and run the file install_sdl2.sh.
  • Linux: go to the directory script/linux and run the file install_sdl2_dev.sh.
• If you have the original game, then copy the subdirectories ANIM, DATA, MAPS and MUSIC (some of them may be missing depending on the version of the original game) to the project root directory.
• Alternatively, go to the directory script/demo and run the file download_demo_version.sh. This script will download a demo version of the original game, which is the minimum required for development.
• Run the make command in the root directory of the project to build it.

Android

• Go to the directory script/android and run the file install_packages.bat if your development platform is Windows or install_packages.sh if your development platform is macOS or Linux. This script will install all the required packages to build the project using Android Studio.
• Launch Android Studio, open the project in the android directory and run the build.

PlayStation Vita

If you would like to build and run this project on PlayStation Vita please follow the instructions on this page.

Nintendo Switch

If you would like to build and run this project on Nintendo Switch please follow the instructions on this page.

Build with CMake

If you would like to build the project using CMake please follow the instructions on this page.

Contribution

We welcome and appreciate any help, even if it is a tiny text or code change. Please read our contribution guide before starting work on a pull request. Not sure what to start with? Feel free to refer to good first issue or help wanted tags.