Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.03 KB

DEVELOPMENT.md

File metadata and controls

54 lines (40 loc) · 3.03 KB
Raw

fheroes2 build and contribution guide

Build

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

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-vs2017.vcxproj or fheroes2-vs2019.vcxproj depending on the version of Microsoft Visual Studio installed 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_sdl_2.sh (default setup) or install_sdl_1.sh.
    • Linux: go to the directory script/linux and run the file install_sdl_2_dev.sh (default setup) or install_sdl_1_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 with SDL2 or make FHEROES2_WITH_SDL1="ON" to build it with SDL1.

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.