Information, Recommended Plugins and Useful Links

Recommended VS 2022 Plugins

• SonarLint - Provides a great integrated Linter to point out code smells and errors, there are currently tons of them in the codebase!
• Double-Click Maximize - Allows you to easily maximize docked windows by double-clicking their title bar. Not necessary but quite convenient.
• Middle-Click Scroll - Allows you to scroll around files by holding the middle mouse button.

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
• SDL Documentation - Our input library and someday our replacement drawing library
• 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
• Weegee's Script Toolbox - A repo with some useful CC related tools
• Stewie's VSCode INI Language Support - Adds some useful features for editing CC's INI in vscode

Useful Information

• C++ Version: C++20
• FMOD Version: 2.2.13
• Allegro Version: 4.4.3.1 (custom build)
• SDL Version: 2.26.3.0
• Lua Version: 5.1.4 with LuaJIT 2.1.0-beta3

Important Build Information and Limitations

• All source and binary dependencies required to build the project are included.
• This codebase 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.
• This codebase uses a slightly modified version of Luabind. It adds support for passing ownership of pointers to vectors to Lua (and iterating over them)