Information, Recommended Plugins and Useful Links

Recommended VS 2019 Plugins

• CodeMaid - Provides a function list and code cleaning tools
• CppTripleSlash - Provides a shortcut for auto-generating comment blocks we can use for our documentation. NOTE - this is built into VS 2019 now, but still useful for 2017)
• SonarLint - Provides a great integrated Linter to point out code smells and errors, there are currently tons of them in the codebase!

Useful Links

• Doxygen Documentation - Our documentation generation tool. Look in the Documenting the code section if you need examples.
• FMOD Documentation - Our audio library
• Allegro Documentation - Our drawing library, as mentioned below we use a slightly customized version of it
• Luabind Documentation - Our current lua-binding solution
• Sol3 Documentation - Our potential future lua-binding solution
• Old CC Version Lua Data Objects - The old DRL wiki for CC lua objects; it won't be perfectly up-to-date but it can still be useful for its ease-of-access

Useful Information

• C++ Version: C++14
• Allegro Version: 4.2.3 (custom build)
• Lua Version: 5.15

Important Build Information and Limitations

• Linux and MacOS builds are not currently directly supported. There are various projects to build for linux which seem to have been successful. See forks for more details.
• All source and binary dependencies required to build the project are included.
• This version uses a slightly modified version of Allegro. The only difference from the original is a custom window borderless mode implemented to fix fullscreen issues. If you're gonna rebuild Allegro you'll probably need to disable custom calls in FrameMan.