How to install LOVE-IMGUI on Windows?

Download pre-built binaries from the releases page and copy the dynamic module to the LÖVE application data folder (e.g., C:/Users/ /AppData/Roaming/LOVE). Alternatively, build the project manually for custom setups.

Is LOVE-IMGUI better than native LÖVE GUI libraries for game UI?

LOVE-IMGUI is ideal for debug tools and editors due to ImGui's efficiency and immediate-mode design, but native LÖVE libraries like LoveFrames might be better for stylized, production game UI with more customization options.

How to create a simple debug window with LOVE-IMGUI?

Use imgui.Begin() and imgui.End() to define the window, and add widgets like imgui.Text() or imgui.SliderFloat() inside. Refer to the example code in the README for a step-by-step integration.

Can I use LOVE-IMGUI with the latest ImGui version?

No, it's currently bound to ImGui 1.53, so newer features and improvements in later versions aren't supported. Check the project's updates for potential version upgrades.

How to handle mouse input without capturing all events?

Use imgui.GetWantCaptureMouse() in love.mousemoved or love.mousepressed callbacks to conditionally pass events to your game, as shown in the example where input is only passed if not captured by ImGui.

What are the limitations of LOVE-IMGUI's docking system?

The docking system is based on a deprecated extension and lacks stability; it will be replaced by native ImGui docking in the future, so avoid it for long-term projects requiring reliable layouts.

How to change the return value order in LOVE-IMGUI?

Call imgui.SetReturnValueLast(false) at the start of your application to revert to the original ImGui return order, where status comes before value, though the default is reversed for Lua convenience.

Love Imgui — LÖVE Engine ImGui Binding

What is Love Imgui?

LOVE-IMGUI is a Lua binding of the Dear ImGui library for the LÖVE game engine. It enables developers to embed immediate-mode graphical user interfaces directly into their LÖVE games or tools, facilitating the creation of debug panels, editors, and in-game overlays without external dependencies.

Target Audience

LÖVE game developers and tool creators who need efficient, real-time GUI components for debugging, prototyping, or building editor interfaces within their 2D games.

Value Proposition

It provides a performant, well-integrated ImGui experience tailored for LÖVE's Lua environment, with Lua-friendly API design choices like string-based enums and configurable return value ordering.

imgui module for the LÖVE game engine

Use Cases

Best For

Adding real-time debug overlays to LÖVE games
Building in-game level editors or tooling
Creating prototype UI for game mechanics
Developing custom development tools within LÖVE
Integrating ImGui's widget system into 2D games
Making interactive config menus or settings panels

Not Ideal For

Projects requiring polished, production-ready user interfaces for players, as ImGui is optimized for debugging and tools, not final game UI.
Teams needing stable, advanced docking systems, since the included docks extension is deprecated and pending replacement.
Developers using LÖVE versions beyond 11.1, due to potential compatibility issues with the module's specific binding.
Applications demanding extensive custom theming or animations, as ImGui's minimal styling requires additional effort for visual customization.

Pros & Cons

Pros

Lua-Friendly API

Uses string-based enums (e.g., 'ImGuiWindowFlags_AlwaysAutoResize') and configurable return value ordering, making the code more readable and intuitive for Lua developers.

Seamless Input Integration

Automatically handles LÖVE input callbacks (keyboard, mouse, text) with capture control via functions like GetWantCaptureKeyboard(), simplifying event management.

Immediate-Mode Efficiency

Bridges ImGui's performant C++ backend with LÖVE's Lua environment, enabling real-time GUI updates for debug tools and editors with minimal overhead.

Comprehensive Binding

Provides access to 275 ImGui functions, covering most needs for in-game interfaces, as noted in the README, despite some unsupported features.

Cons

Deprecated Docking

The docks extension is marked as deprecated and will be replaced, leading to instability and future breaking changes for advanced layout management.

Incomplete Function Coverage

With 43 unsupported functions out of ImGui's API, some features may be missing, limiting functionality for complex GUI requirements.

Setup and Build Hurdles

Requires building the module or managing pre-built binaries, which adds complexity compared to pure Lua libraries and may deter quick prototyping.

Frequently Asked Questions

What is Love Imgui?

Target Audience

LÖVE game developers and tool creators who need efficient, real-time GUI components for debugging, prototyping, or building editor interfaces within their 2D games.

Value Proposition

It provides a performant, well-integrated ImGui experience tailored for LÖVE's Lua environment, with Lua-friendly API design choices like string-based enums and configurable return value ordering.

Use Cases

Best For

Adding real-time debug overlays to LÖVE games
Building in-game level editors or tooling
Creating prototype UI for game mechanics
Developing custom development tools within LÖVE
Integrating ImGui's widget system into 2D games
Making interactive config menus or settings panels

Not Ideal For

Projects requiring polished, production-ready user interfaces for players, as ImGui is optimized for debugging and tools, not final game UI.
Teams needing stable, advanced docking systems, since the included docks extension is deprecated and pending replacement.
Developers using LÖVE versions beyond 11.1, due to potential compatibility issues with the module's specific binding.
Applications demanding extensive custom theming or animations, as ImGui's minimal styling requires additional effort for visual customization.

Pros & Cons

Pros

Lua-Friendly API

Uses string-based enums (e.g., 'ImGuiWindowFlags_AlwaysAutoResize') and configurable return value ordering, making the code more readable and intuitive for Lua developers.

Seamless Input Integration

Automatically handles LÖVE input callbacks (keyboard, mouse, text) with capture control via functions like GetWantCaptureKeyboard(), simplifying event management.

Immediate-Mode Efficiency

Bridges ImGui's performant C++ backend with LÖVE's Lua environment, enabling real-time GUI updates for debug tools and editors with minimal overhead.

Comprehensive Binding

Provides access to 275 ImGui functions, covering most needs for in-game interfaces, as noted in the README, despite some unsupported features.

Cons

Deprecated Docking

The docks extension is marked as deprecated and will be replaced, leading to instability and future breaking changes for advanced layout management.

Incomplete Function Coverage

With 43 unsupported functions out of ImGui's API, some features may be missing, limiting functionality for complex GUI requirements.

Setup and Build Hurdles

Requires building the module or managing pre-built binaries, which adds complexity compared to pure Lua libraries and may deter quick prototyping.

Frequently Asked Questions

Love Imgui

What is Love Imgui?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Love Imgui

What is Love Imgui?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?