Antkeeper Source

Antkeeper is an open-source 3D ant colony simulation game currently in development for Windows and Linux. Antkeeper is the passion project of solo indie game developer and myrmecophile C. J. Howard.

Get notified when the game is released by joining the mailing list at https://antkeeper.com/ or watching this repository.

Note

Antkeeper source code is licensed under GPL-3.0-or-later, but the game data required to play Antkeeper is proprietary, and can be obtained by purchasing a copy of the game when officially released.

Building
- Windows
Testing
Documentation
Contributing
Authors
License

Building

Windows

Requirements:

Git
CMake>=3.27
Build Tools for Visual Studio>=2022
Python>=3.11.0
Jinja2>=2.7,<4.0

Configure and build a Windows 64-bit release:

git clone https://github.com/antkeeper/antkeeper-source.git && cd antkeeper-source
cmake --preset windows-x64
cmake --build --preset windows-x64-release

Testing

Configure and build with -DANTKEEPER_TEST=ON, then run the following command to perform tests for a Windows 64-bit release:

ctest --test-dir build\windows-x64 -C Release

Documentation

Source code documentation can be generated with Doxygen. Graphviz can optionally be used to generate dependency graphs.

The following commands configure and build the source code documentation:

cmake --preset windows-x64 -DANTKEEPER_BUILD_DOCS=ON
cmake --build --preset windows-x64-release --target docs

Generated HTML documentation will be located at build/<platform>/docs/doxygen/html/index.html.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

See the contribution guide for more details on how to contribute.

Authors

C. J. Howard

License

Antkeeper source code is licensed under GPL-3.0-or-later.
Antkeeper translations are licensed under CC-BY-SA-4.0.
Antkeeper game data is proprietary.

antkeeper/antkeeper-source