Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.07 KB

HACKING.md

File metadata and controls

52 lines (36 loc) · 2.07 KB

Build from repository

This project uses the CMake build system. Use the following commands to build (it is recommended to build in a separate directory as shown here):

$ mkdir build && cd build
$ cmake ..
$ make

or select platform dependent generator for your favorite IDE.

This has been tested on Visual Studio 2019 - your experiences with other IDE's may vary.

Dependencies

  • SDL2 - crossplatform media framework
  • FFmpeg - video support
  • OpenAL - audio support
  • zlib - compression

These are now auto-resolved during CMake build.

Instructions

You will require the following installed on your computer: Git, CMake and Visual Studio 2019.

  • Clone, fork or download the repo "https://github.com/gp-alex/world-of-might-and-magic.git"
  • Move to folder and create a seperate build directory
  • Open CMake GUI and select the source directory and the build directory
  • Configure -> Select "Visual Studio 16 2019" for the generator and "Win32" as the optional platform
  • Generate
  • Open Project (Can now close CMake)
  • In Visual Studio 2019 Build the project
  • Once that completes set "World_of_Might_and_Magic" as the startup project and run

NB - Always use a new empty folder for the build directory if you need to re-run CMake

Still having problems? Try the discord chat

Coding style

For the C++ code we are following the Google C++ Style Guide.
Source code is automatically checked against it, and Pull Request will fail if you don't follow it.
For style check on Windows platform, you can use Visual Studio Code cpplint plugin.