• Simple multi-threaded architecture - separate threads for physics, rendering, AI, and game logic
• Entity/component system
• Linear math suite somewhat stolen from Ogre
• Content pipeline supporting .blend, .glsl, .otf, .png
• Create levels, models, animations, and ragdoll rigs in Blender
• Deferred rendering, cascaded shadow maps, edge detection, bloom, SSAO
• Geometry-based UI system
• Efficient behavior tree implementation doubles as a tween system
• Localization support
• Dialogue tree system complete with an editor
• Keyboard/mouse/gamepad support via SDL
• Automatic navmesh generation with realtime mutations via Recast
• Audio via Wwise
• Physics via Bullet
• Almost all dependencies are open source GitHub submodules
• Builds and runs on Win/Mac/Linux

It's alright. It uses templates too often. Otherwise not too bad.

1. Install Visual Studio
2. Install the DirectX SDK
3. Install CMake
4. Ensure Blender is installed and available on the path
5. Ensure Wwise is installed and WwiseCLI is available on the path
6. Run setup.bat
7. Open build/yearning.sln in Visual Studio
8. Set the yearning project as the default startup project
9. Hit F5 to run the game

1. The Wwise authoring tool doesn't run on Linux. Use Wwise on another platform to build the Linux soundbanks.
2. If necessary, copy the generated Wwise_IDs.h file into src/asset
3. Copy the soundbanks into assets/audio/GeneratedSoundBanks/Linux
4. Run ./setup
5. Run ./yearning from the build folder

1. Install Homebrew
2. Ensure Blender is installed and available on the path
3. Ensure Wwise is installed and WwiseCLI.sh is available on the path
4. Wwise might have trouble generating soundbanks the first time. You might need to delete any cache files and open the project manually in Wwise first.
5. Run ./setup-mac
6. Run ./yearning from the build folder

All rights reserved for images, sounds, music, models, animations, fonts, levels, dialogue files, and all other game data. They are available for download here for convenience, but may not be redistributed without express permission.

All code not including the external directory is available under the following license:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This repository includes a copy of the Wwise SDK. Use of the SDK is subject to the Wwise EULA. Wwise is free for educational and non-commercial purposes. Otherwise, acquire a license key from Audiokinetic.