> Note: The `antkeeper-data` submodule contains proprietary game data and is not publicly available. The game can be built without this submodule, but the game data is required to play Antkeeper. You can get a copy of the game data by purchasing Antkeeper at [antkeeper.com](https://antkeeper.com/).
> [!NOTE]
> The `antkeeper-data` submodule contains proprietary game data and is not publicly available. The game executable can be built without this submodule, but its data package is required to play Antkeeper. You can get a copy of the data package by purchasing Antkeeper at <https://antkeeper.com/>.
## Configuration & Building
CMake is required to configure and build the application. Depending on the target platform, CMake should be invoked from one of the following directories:
Building for Linux requires CMake, GCC, G++, and GNU Make. Navigate to either the [build/linux32](build/linux32) or [build/linux64](build/linux64) directory and run the following commands:
Building for Linux requires CMake, GCC, G++, and GNU Make.
Building for Windows requires CMake and Visual Studio Build Tools. Additionally, [NSIS](http://nsis.sourceforge.net/) is required if you want to build a distributable installer program. In order to correctly build for your target architecture, you must use the `x86 Native Tools Command Prompt` or the `x64 Native Tools Command Prompt` for 32-bit and 64-bit applications, respectively. Then navigate to either the [build\win32](build/win32) or [build\win64](build/win64) directory and run the following commands:
Run the following commands to configure and build a 64-bit Linux release:
@ -45,9 +37,13 @@ After building, a standalone version of the application will be located somewher
## Distribution
The built application can be packaged into a distributable format with the following command:
The built application can be packaged into a distributable format with the following commands:
cmake --build build\win64 --target dist
or
cmake --build . --target dist
cmake --build build/linux64 --target dist
The resulting package will be located in the `dist` directory.
@ -55,11 +51,11 @@ The resulting package will be located in the `dist` directory.
If any changes have been made to the submodules, commit those first. Each submodule can then be updated to their latest commits with the following command:
