antkeeper / antkeeper-source

🐜 Ant colony simulation game source code

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.

Table of Contents

• Building
  • Windows
• 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-release
cmake --build --preset windows-x64-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-release -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-source's Issues

Remove dependencies on deprecated codecvt unicode conversions

Fix control profile saving

Broken by the recent changes to the input system.

Render pass lambda captures storing outdated material variables

Currently some render passes, such as the material pass, capture material variables as shared pointers in lambdas. However, sometimes a material's variables are changed or a material with the same hash but different variables is created, causing outdated material parameters to be passed to a shader.

The whole model of storing shared pointers to material variables in lambda captures is messy, confusing, and leads to difficult-to-track bugs. The material variable and shader variable interfaces need to be redesigned to be less bug-prone and easier to use.

Also take into consideration that the individual shader uniform model should be phased out in favor of uniform buffer objects.

Q: benefits of using std::this_thread::yield()?

Hello 🤗
Can you tell, what are the benefits of using the std::this_thread::yield function instead of the std::this_thread::sleep_for function in this context?
regards, max

		// Idle
		do
		{
			std::this_thread::yield();
			m_frame_end_time = clock_type::now();
		}
		while (m_frame_end_time < idle_time);

Give materials a binary format

Abstract GL interface

Use a MessagePack library to load MessagePack files

Mesh files are currently stored in MessagePack format, and loaded with nlohmann::json, which first converts the MessagePack data to JSON. This is both inefficient, and loses sized type information. Consider using msgpack for C or msgpack for C++.

Add a "reset to defaults" button to options menus

Fix gamepad config menu

Broken by the recent changes to the input and event systems

Integrate models with B-rep meshes.

Models and B-rep meshes currently each have their own formats and loaders. Models should be constructed by loading B-rep mesh data, then generating interleaved VBOs. Models should also hold onto B-rep data via shared pointers. This way, models could potentially determine what data to upload to their VBOs based on their material sets, or update their VBOs if the B-rep mesh is modified.

Allow selection of borderless or exclusive fullscreen mode

Exclusive fullscreen mode may provide performance benefits.

Remove/replace obsolete animation classes and functions.

• animation_base
• animation
• animator
• tween
• timeline
• screen_transition

Add support for animation events/notifications.

Skeleton poses perform unnecessary calculations when one or more bones are posed.

The skeleton pose classes need to be improved so that if a bone is posed, the absolute transforms and skinning matrices of its descendants will be flagged as outdated. Absolute transforms and skinning matrices should only be updated if they are requested (via a get() call) or if they are manually updated through an update() call.

Write new animation classes and a loader for keyframe animations.

Add modifier key filters to key mappings