debugging-tools gui imgui portable starter-project

ImGui Modern C++ and Modern CMake starter project

-+- Build Status -+-

develop

master

-+-

Key Features • Project Documentation • Getting Started • Contributing • Credits •

Key Features

This is a starter project for ImGui development in Modern C++ (>= c++-17) and with Modern CMake (>= 3.14) based on the asap template.

CMake as the build system with or without presets
cross-platform portability on Linux, OS X and Windows
multiple compilers: clang, g++ and MSVC
modular structure with each module self-contained in a subdirectory within the project
CMake build helpers to facilitate declaration of library, exe, test modules, for the end-to-end lifecycle including doc generation, test, packaging etc...
unit testing targets, with by default Google Test as the framework (other frameworks are also possible)
code coverage with clang or g++
zero-touch valgrind, clang-tidy, clang-format, google sanitizers, etc
development can be done locally or in a dev container with vscode
faster rebuilds with ccache compiler caching
CMake package management with CPM
ImGui with docking, GLM, GLFW, and an example simple application, so you can get started immediately
persistence of ImGui and docks configuration

If you miss the old version of this starter project (you can't move to cxx-17 or you just can't bother), it is still in the old_cxx branch of this repo.

It is no longer updated though.

Project Documentation

We have detailed guides for setting up an efficient development environment, the development process, project structure, etc. Take a look at the available guides here.

In addition to that, specific documentation for this project, its application modules, its usage and APIs, are provided in the project GitHub Pages site here.

Getting Started

It is strongly recommended that you take some time to browse the project documentation to familiarize yourself with its structure and development workflows.

Make sure you have a C++ compiler with C++-17 capabilities at least. Gnu, Clang and MSVC all can do that with a recent version.

git clone --recurse-submodules -j4 https://github.com/abdes/asap_app_imgui.git

mkdir _build && cd _build && cmake .. && cmake --build .

or just use one of the predefined CMake presets. Detailed instructions are in the project documentation, and many useful commands are listed here.

Running the demo

Run the app from within the build directory (./asap_app)
Drag and drop the frames to dock them to whichever side you want.
Edit the settings as you wish
When the app is closed, the settings, docks, loggers, etc are saved into the .asap directory under the build directory. Some files saved by ImGui are still under the build directory directly (work in progress)

You need to have a graphics system capable of providing OpenGL 3.2 to properly run the demo.

CMake configurable build options

# Project options
option(BUILD_SHARED_LIBS        "Build shared instead of static libraries."              ON)
option(ASAP_BUILD_TESTS         "Build tests."                                           OFF)
option(ASAP_BUILD_EXAMPLES      "Build examples."                                        OFF)
option(ASAP_WITH_GOOGLE_ASAN    "Instrument code with address sanitizer"                 OFF)
option(ASAP_WITH_GOOGLE_UBSAN   "Instrument code with undefined behavior sanitizer"      OFF)
option(ASAP_WITH_GOOGLE_TSAN    "Instrument code with thread sanitizer"                  OFF)
option(ASAP_WITH_VALGRIND       "Builds targets with valgrind profilers added"           OFF)

Contributing

If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

By contributing your code, you agree to license your contribution under the terms of the BSD-3-Clause or a more permissive license. All files are released with the BSD-3-Clause license.

Read the developer guides.

Submitting a PR

For every PR there should be an accompanying issue which the PR solves
The PR itself should only contain code which is the solution for the given issue
If you are a first time contributor check if there is a suitable issue for you

Getting updates from upstream `asap`

In order to pull and merge updates from the upstream project, make sure to add it to the repo's remotes and disable pulling/merging tags from the upstream. We want tags to be limited to those made in this repo, not in the upstream.

git remote add upstream https://github.com/abdes/asap.git
git config remote.upstream.tagopt --no-tags

Credits

The multitude of other open-source projects used to implement this project or to get inspiration - credits in the source code or the documentation as appropriate

About

Starter project for portable app with optional GUI (GLFW/ImGui) and a rich builtin debug UI. Includes docked windows, log viewer, settings editor, configuration load/save, etc...