[Troubleshooting] Can't get cimgui-love set up on an m1 mac

[javi7]

I have not been able to get my love project to successfully load with cimgui-love.

• I tried using the pre-built binary for Mac from the releases page. I got the following error:

  Error: error loading module 'cimgui' from file 'imgui/cimgui.dylib':
      dlopen(imgui/cimgui.dylib, 0x0006): tried: '/Applications/love.app/Contents/MacOS/../Frameworks/imgui/cimgui.dylib' (no such file), '/Applications/love.app/Contents/MacOS/../Frameworks/imgui/cimgui.dylib' (no such file), 'imgui/cimgui.dylib' (mach-o file, but is an incompatible architecture (have (x86_64), need (arm64e))), '/Users/javiermuhrer/things/whalin/imgui/cimgui.dylib' (mach-o file, but is an incompatible architecture (have (x86_64), need (arm64e)))

• Next, I tried compiling the library myself. I cloned the repo and cd'd into the cimgui subdirectory. I ran make and it generated a lot of errors:

  c++ -O2 -fno-exceptions -fno-rtti -I/usr/local/include -Wall -c -o cimgui.o cimgui.cpp
  In file included from cimgui.cpp:13:
  ././imgui/imgui.h:262:5: error: unknown type name 'constexpr'
  constexpr ImVec2()                      : x(0.0f), y(0.0f) { }
  ^
  ././imgui/imgui.h:262:15: error: constructor cannot have a return type
  constexpr ImVec2()                      : x(0.0f), y(0.0f) { }
            ^~~~~~
  ././imgui/imgui.h:263:5: error: unknown type name 'constexpr'
  constexpr ImVec2(float _x, float _y)    : x(_x), y(_y) { }
  ^
  ././imgui/imgui.h:263:15: error: constructor cannot have a return type
  constexpr ImVec2(float _x, float _y)    : x(_x), y(_y) { }
            ^~~~~~
  ././imgui/imgui.h:275:5: error: unknown type name 'constexpr'
  constexpr ImVec4()                                        : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { }
  ^
  ././imgui/imgui.h:275:15: error: constructor cannot have a return type
  constexpr ImVec4()                                        : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { }
            ^~~~~~
  ././imgui/imgui.h:276:5: error: unknown type name 'constexpr'
  constexpr ImVec4(float _x, float _y, float _z, float _w)  : x(_x), y(_y), z(_z), w(_w) { }
  ^
  ././imgui/imgui.h:276:15: error: constructor cannot have a return type
  constexpr ImVec4(float _x, float _y, float _z, float _w)  : x(_x), y(_y), z(_z), w(_w) { }
            ^~~~~~
  ././imgui/imgui.h:347:81: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API bool          BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), bool border = false, ImGuiWindowFlags flags = 0);
                                                                              ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:348:73: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API bool          BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), bool border = false, ImGuiWindowFlags flags = 0);
                                                                      ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:367:107: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API void          SetNextWindowPos(const ImVec2& pos, ImGuiCond cond = 0, const ImVec2& pivot = ImVec2(0, 0)); // set next window position. call before Begin(). use pivot=(0.5f,0.5f) to center on given point, etc.
                                                                                                        ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:509:76: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API bool          Button(const char* label, const ImVec2& size = ImVec2(0, 0));   // button
                                                                         ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:518:82: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API void          ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL);
                                                                               ^      ~~~~~~~~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:523:104: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
                                                                                                     ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:523:138: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
                                                                                                                                       ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:523:177: error: no matching constructor for initialization of 'ImVec4'
  IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
                                                                                                                                                                              ^      ~~~~~~~~~~
  ././imgui/imgui.h:272:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 4 were provided
  struct ImVec4
     ^
  ././imgui/imgui.h:272:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 4 were provided
  ././imgui/imgui.h:523:224: error: no matching constructor for initialization of 'ImVec4'
  IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
                                                                                                                                                                                                                             ^      ~~~~~~~~~~
  ././imgui/imgui.h:272:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 4 were provided
  struct ImVec4
     ^
  ././imgui/imgui.h:272:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 4 were provided
  ././imgui/imgui.h:524:130: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API bool          ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));
                                                                                                                               ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  ././imgui/imgui.h:524:164: error: no matching constructor for initialization of 'ImVec2'
  IMGUI_API bool          ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));
                                                                                                                                                                 ^      ~~~~
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit copy constructor) not viable: requires 1 argument, but 2 were provided
  struct ImVec2
     ^
  ././imgui/imgui.h:259:8: note: candidate constructor (the implicit default constructor) not viable: requires 0 arguments, but 2 were provided
  fatal error: too many errors emitted, stopping now [-ferror-limit=]
  20 errors generated.
  make: *** [cimgui.o] Error 1

• Then, I tried building the Makefile myself using cmake CMakelists.txt. This seemed to work. I ran make again and this time it succeeded. I copied cimgui.dylib into my project directory under cimgui/cimgui.dylib and tried to load this from my project. I got the following error:

  Error: error loading module 'cimgui' from file 'cimgui/cimgui.dylib':
      dlsym(0x20a1576a0, luaopen_cimgui): symbol not found

Some googling told me this might mean a mismatch between the LOVE version targeted in cimgui.dylib and my project, but I don't think this is the case. I'm running LOVE 11.4.

Any suggestions for how to troubleshoot this?

[apicici]

It seems like the pre-compiled release only works on x64 architectures.

The version you were able to compile yourself should work, but it seems that, when you are trying to load cimgui, lua is attempting to open the shared library directly (by searching for the luaopen_cimgui symbol, which is not there). Can you try having the same folder structure as the release but replacing the dylib with the one you compiled?

[javi7]

I got it working now. I totally forgot to include the rest of the release directory 🤦 . Thank you for catching my mistake!

[apicici]

Was the original error that you got also in the scenario in which the other files are missing? It would be useful to know if indeed the library needs to be recompiled to use it on the M1.

[javi7]

I just re-tested with both versions of cimgui.dylib (the original one in the releases file and the one I built on my m1) and it original one throws the same error even when all the files are present. When I use the version built on my m1, it works as expected. So, I think it will be necessary to recompile the library for use on an M1.

[apicici]

Thanks for testing. I'll look into building a version that works on M1.

[apicici]

@javi7 I set up appveyor to build a universal dylib that should work on both x64 and arm64. Could you test if the new release works?

[javi7]

I just tried this out and it initially crashed my game due to a system security policy.

a prompt that popped up:

the error in the command line:

Error: cimgui/init.lua:10: dlopen(cimgui/cimgui.dylib, 0x0005): tried: '/Applications/love.app/Contents/MacOS/../Frameworks/cimgui/cimgui.dylib' (no such file), '/Applications/love.app/Contents/MacOS/../Frameworks/cimgui/cimgui.dylib' (no such file), 'cimgui/cimgui.dylib' (code signature in <32213599-5520-3E06-B141-8167B83783C1> '/Users/javiermuhrer/things/whalin/cimgui/cimgui.dylib' not valid for use in process: library load disallowed by system policy), '/Users/javiermuhrer/things/whalin/cimgui/cimgui.dylib' (code signature in <32213599-5520-3E06-B141-8167B83783C1> '/Users/javiermuhrer/things/whalin/cimgui/cimgui.dylib' not valid for use in process: library load disallowed by system policy)

I was able to circumvent that by ctrl-clicking the .dylib file in Finder and opening it with the terminal. By opening it this way, it prompted me to approve the file which I assume added it to a safelist or something. When I subsequently re-ran my game, I didn't get any errors. However, the calls into cimgui are not working as expected. I have my game set up to show the imgui demo window. It works with the library I built manually, but it doesn't work with the universal library I just downloaded. Nothing appears in-game.

[javi7]

Actually, this does work after circumventing the error. With both versions of the library, I have an issue where the imgui windows sometimes don't show in my program. I suspect this is an unrelated issue in my own game.

[apicici]

Thanks for testing it! I think the problem with the security policy is caused by the fact that I'm now using Xcode to compile the library. I guess it's ok if the library is used for development, but if it's meant to be shipped with a game it would need to be recompiled and signed.