DCS EFM ImGui (FmGui)

FmGui is a project that implements the Dear ImGui library, and optionally the ImPlot extension, for use with the DCS: World EFM API. Its purpose is to greatly ease the development process of the user's EFM.

Table of Contents

• 1 Installing Binaries
• 2 Building
  • 2.1 Setting Up ImGui
  • 2.2 Setting Up ImPlot
  • 2.3 Setting Up MinHook
• 3 Examples
• 4 Configuration
• 5 Note
• 6 License

1. Installing Binaries:

Note: This section is a work in progress. It is recommended that you build the library yourself at this time.

2 Building:

To use the Include/FmGui.hpp and Source/FmGui.cpp source files, they must be included in the user's EFM Visual Studio or CMake project. In Visual Studio you can add existing file(s) as seen below.

The user will need to have the "Desktop development with C++" and "Game development with C++" Visual Studio workloads installed to successful build these source files. The "Game development with C++" workload is needed, because it contains the DirectX SDK. The process for installing these workloads can be seen below.

The source files use the ImGui, ImPlot (optionally), and MinHook libraries.

You may find ImGui v1.87 here ImPlot v0.13 here, and you can find MinHook v1.3.3 here.

2.1 Setting Up ImGui

Including ImGui in your EFM project is really simple. FmGui assumes that you store the ImGui source files in their original folder and add them to your project's include path. For example, consider the following folder structure below.

• EFM
  • lib
    • imgui-1.87
      • imgui
        • imconfig.h
        • imgui.cpp
        • imgui.h
        • imgui_demo.cpp
        • imgui_draw.cpp
        • imgui_impl_dx11.cpp
        • imgui_impl_dx11.h
        • imgui_impl_win32.cpp
        • imgui_impl_win32.h
        • imgui_interal.h
        • imgui_tables.cpp
        • imgui_widgets.cpp
        • imstb_rectpack.h
        • imstb_textedit.h
        • imstb_truetype.h
        • ...
      • ...
  • MY_EFM_PROJECT
    • FmGui.hpp
    • FmGui.cpp
    • .vcxproj in this directory.
    • ...
  • .sln in this directory.
  • ...

In Visual Studio select your project in the Solution Explorer and then add the following entry to Configuration Properties -> C/C++ -> General -> Additional Include Directories: $(ProjectDir)..\lib\imgui-1.87\imgui\

Since ImGui is distributed in source form you must add the .cpp files to your project as seen earlier. You can also press Shift + Alt + A and select imgui.cpp, imgui_demo.cpp (not optional), imgui_draw.cpp, imgui_impl_dx11.cpp, imgui_impl_win32.cpp, imgui_tables.cpp, and imgui_widgets.cpp.

You could also add the header files to your include path, but FmGui assumes the ImGui headers can be found in the current working directory.

2.2 Setting Up ImPlot

ImPlot is an extension for ImGui that add many useful new widgets such as plots, graphs, charts, and more.

An ImPlot directory setup might look like this:

• EFM
  • lib
    • implot-0.13
      • implot.cpp
      • implot.h
      • implot_demo.cpp
      • implot_internal.h
      • implot_items.cpp
      • ...
    • ...
  • MY_EFM_PROJECT
    • FmGui.hpp
    • FmGui.cpp
    • .vcxproj in this directory.
    • ...
  • .sln in this directory.
  • ...

In Visual Studio select your project in the Solution Explorer and then add the following entry to Configuration Properties -> C/C++ -> General -> Additional Include Directories: $(ProjectDir)..\lib\implot-0.13\

Much like ImGui, ImPlot is distributed in the source form so you need to add the .cpp files to your project in the same manner. You can press Shift + Alt + A and select implot.cpp, implot_demo.cpp (not optional), and implot_items.cpp.

Note: you do not have to use the ImPlot extension to use/build FmGui. You can disable ImPlot as shown in the source code example below:

/* In file FmGui.hpp */
/*
 * Simply comment out the "#define FMGUI_ENABLE_IMPLOT" line as seen below.
 */
// Define FMGUI_ENABLE_IMPLOT to enable the ImPlot extension.
// #define FMGUI_ENABLE_IMPLOT

2.3 Setting Up MinHook

As for the MinHook v1.3.3 release, assume the same project directory structure.

• EFM
  • lib
    • MinHook_133 (directory has been renamed)
      • lib
        • libMinHook-v<Platform Toolset>-<Run-time Type>.x64.lib
        • ...
      • include
        • ...
    • ...
  • MY_EFM_PROJECT
    • FmGui.hpp
    • FmGui.cpp
    • .vcxproj in this directory.
    • ...
  • .sln in this directory.
  • ...- FmGui.hpp
    • FmGui.cpp
    • .vcxproj in this directory.

I personally recommended downloading the the static library release for MinHook or building it from source. That way you don't have to worry about having multiple dynamic link libraries in your aircraft mod's bin folder.

To add the include directory and link statically for the MinHook static library release you can use the following instructions:

In Visual Studio select your project in the Solution Explorer and then add the following entry to Configuration Properties -> C/C++ -> General -> Additional Include Directories: $(ProjectDir)..\lib\MinHook_133\include\

Select Configuration Properties -> Linker -> General -> Additional Libraries Directories and add $(ProjectDir)/../lib/MinHook_133/lib/

In the MinHook_133/lib/ directory, you will see several different static libraries. You will most likely want to link against libMinHook-x64-v141-mt.lib for your release builds and libMinHook-x64-v141-mtd.lib for your debug builds. Add these for you different configurations in Configuration Properties -> Linker -> Input -> Additional Dependencies.

Phew, I think that's everything.

3. Examples:

Checkout the Examples directory for code samples on this library's usage.

See Examples/Fm.cpp

For a library reference simply view the FmGui.hpp header file and its commented functions.

4. Configuration:

Currently there are no real configuration options available, but those will be added in the future.

5. Note:

Please do not use these source files maliciously. This code is meant to aide the user in developing an EFM with the powerful ImGui widgets library.

These source files were built and tested using Visual Studio Community 2022, Windows 10 SDK Version 10.0.19041.0, the C++20 Standard, the MinHook library v1.3.3, the DirectX SDK Version _____, and the ImGui library version 1.87.

The minimum C++ ISO Standard requirement for these files is C++11.

6. License:

This project is licensed under the permissive BSD 2-Clause License. For more details view LICENSE.txt