superbuild/README.md

Antkeeper Superbuild

This repository contains the superbuild system and all dependencies required to build Antkeeper.

Download

Download the Antkeeper superbuild repository and all of its Git submodules:

git clone --recursive https://git.antkeeper.com/antkeeper/superbuild.git

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.

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:

Directory	Platform
build/linux32	32-bit Linux
build/linux64	64-bit Linux
build\win32	32-bit Windows
build\win64	64-bit Windows

The following arguments may be passed to CMake during configuration:

-DCMAKE_BUILD_TYPE // [Debug, Release]

Linux

Building for Linux requires CMake, GCC, G++, and GNU Make. Navigate to either the build/linux32 or build/linux64 directory and run the following commands:

cmake ../.. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=...
cmake --build .

Windows

Building for Windows requires CMake and Visual Studio Build Tools. Additionally, NSIS 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 or build\win64 directory and run the following commands:

cmake ..\.. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=...
cmake --build .

Running

After building, a standalone version of the application will be located somewhere in the bin directory according to the build type, build platform, and version string.

Distribution

The built application can be packaged into a distributable format with the following command:

cmake --build . --target dist

The resulting package will be located in the dist directory.

Contributing

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:

git submodule update --recursive --remote

License

Antkeeper superbuild is licensed under the GNU General Public License, version 3. For more information, see LICENSE.md.

3rd-Party Software

Name	Author(s)	License	File(s)
cxxopts	Jarryd Beck	MIT	cxxopts.hpp
dirent	Toni Ronkko	MIT	dirent.h
dr_wav	David Reid	Public Domain (Unlicense)	dr_wav.h
Easing Functions (Equations)	Robert Penner	MIT	ease.hpp
EnTT	Michele Caini	MIT	entt/*
khrplatform.h	The Khronos Group Inc.	MIT	khrplatform.h
OpenGL loader generated by glad	David Herberth	Public Domain / WTFPL / CC0	glad.h, glad.c
PhysicsFS	Ryan C. Gordon	Zlib	physfs/*
JSON for Modern C++	Niels Lohmann	MIT	json.hpp
OpenAL Soft		LGPL-2.0	openal-soft/*
Simple DirectMedia Layer	Sam Lantinga	Zlib	SDL2/*
stb_image	Sean Barrett	MIT / Public Domain	stb_image.h
stb_image_write	Sean Barrett	MIT / Public Domain	stb_image_write.h
stb_image_write	Sean Barrett	MIT / Public Domain	stb_truetype.h