RimGui

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 11 Open GitHub ↗

Simple code-driven GUI for rapid iteration

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Introduction
![card-image.](https://raw.githubusercontent.com/Gridrand/RimGui/main/card-image.png)

[RimGui](https://assetstore.unity.com/packages/slug/375796)

# RimGui

## Introduction  
RimGui is an easy-to-use, code-driven Immediate Mode GUI library built from scratch for rapid iteration, rather than extending existing UI Toolkit or uGUI.

**I’ve often found existing GUI libraries frustrating to use:**
- Building UIs usually involves tedious drag-and-drop operations
- Even simple UI can involve a lot of boilerplate code
- Adding, removing, and managing UI elements like buttons can be a hassle
- Registering and unregistering events like click handlers takes unnecessary effort

With RimGui, there's no need to build UIs with drag-and-drop or manually manage the lifecycle of UI elements.
You can render them with very concise code, like **Gui.Button()**.

Works with all Unity versions 2021+ including 2021, 2022, 2023 & Unity 6.

**Render Pipeline Support**  
- Supports Built-in Render Pipeline, URP, and HDRP.

**Customizable**  
- Easily tweak various parameters to fit your needs.  
- You can even render freely from the triangle mesh level for complete control.

**Cross-platform Support**  
- Works not only on PC but also on WebGL and mobile platforms.

**Font Support**  
- Supports custom fonts and texture atlas generation.

**Optimized Immediate Mode GUI (ImGui)**
- Designed with minimized GC (Garbage Collection) allocation.
- Draw calls are reduced by using a single Shader and Material, and by consolidating all images, including text, into one Texture.

**Build UI Rapidly with Code Only**
- To add a slider, **just write a single line of code**—no drag-and-drop required. To remove it, simply delete that single line.

**Flexible Scalability:**
- You can easily change the size and scale of UI widgets, making it **simple to support multiple resolutions.** This enables optimal UI display across various screen sizes.

It's not designed for GUIs that require flashy effects, but it's perfect if you need a simple and clean interface.

## Example Code

```csharp
Gui.Heading("ChangeAlpha");

using (ImageColors.Begin(new Color(1f, 1f, 1f, alpha)))
    Gui.Image(Sprite);

Gui.Slider(ref alpha, 0f, 1f);
Gui.Text(alpha.ToString("F2"));

if (Gui.NextHeight(100f).BeginScroll())
{
    for (int i = 0; i < 11; i++)
    {
        if (Gui.Button($"Set {i / 10f}"))
            alpha = i / 10f;
    }
    Gui.EndScroll();
}
```
The following UI is displayed by the code above.

![code-gui-comparison](https://raw.githubusercontent.com/Gridrand/RimGui/main/code-gui-comparison.png)

---

## Goals
- Easy-to-use GUI library
- Rapid UI creation
- Simplicity
- High performance
- Usable not only for debugging and tools but also in actual games
- Minimal dependencies

---

## Non-goals
- Support for GUIs with heavy visual effects

---

## Features  
- Box
- Button
- ToggleButton
- RadioButton
- CheckBox
- ColorPreview
- Custom
- Foldout
- Frame
- InputText
- Scroll
- Separator
- Slider
- Sprite
- Text
-- Various numeric types
-- bool
-- char
- Texture
- Window
- Heading
- Spacing
- InteractiveItem
- Drag and Drop
- SliderNumeric
- Splitter
- VerticalBarHandle
- SnapVerticalBarHandle
- RectInnerPointHandle
- SnapRectInnerPointHandle
- Hyperlink
- Label
- ComboBoxButton
- SlidePad
- EditableText
- Dropdown
- InputDropdown
- DragInput
- Input
-- Various numeric types
-- char
-- bool
-- Vector2
-- Vector3
-- Vector4
-- Vector2Int
-- Vector3Int
-- Rect
-- RectInt
-- Bounds
-- BoundsInt
-- Color
-- Color32
-- HsvColor
- Utilities for drawing tree
- **And many more!**

Rendering
- Line, Anti-Aliased Line,Closed Anti-Aliased Line
- Triangle
- Rectangle
- Circle
- Grid
- Anti-Aliased Convex Polygon
- BezierCurve
- Text
- Texture
- **And many more!**

## Differences Between Unity IMGUI and RimGui

- **High-Performance Design:** RimGui is designed for high performance, including efforts to minimize GC (Garbage Collection) allocation. It also reduces draw calls by using a single Shader and Material, and by consolidating all images, including text, into one Texture.
- **Modern Rendering Pipeline Compatibility:** RimGui is compatible with the **URP (Universal Render Pipeline) and HDRP (High Definition Render Pipeline)**, enables seamless integration with the latest Unity projects.
- **Wide Platform Support:** RimGui supports a diverse range of platforms, including **PC, Mobile, and WebGL**, allowing you to **target your desired environments without limitations.**
- **Flexible Scalability:** With RimGui, you can easily change the size and scale of UI elements, making it **simple to support multiple resolutions.** This enables optimal UI display across various screen sizes.

## Links
[AssetStore Page](https://assetstore.unity.com/packages/slug/375796)
[Demo1](https://gridrand.com/rimgui/webgl/core)
[Demo2](https://gridrand.com/rimgui/webgl/extensions/)
[Github](https://github.com/Gridrand/RimGui)
[Introduction \| RimGui](https://gridrand.com/rimgui/docs/introduction)
[Unity Discussions](https://discussions.unity.com/t/released-rimgui-code-driven-gui-library/1637582)

## Support
If you have any bugs or feature requests, please submit them via [this page](https://github.com/Gridrand/RimGui/issues).
For direct support, you can reach us at **support [at] gridrand [dot] com**.
You are also welcome to post questions or feedback on the [Unity Discussions](https://discussions.unity.com/t/released-rimgui-code-driven-gui/1637582) thread.

RimGui

Today's picks

Was this content helpful?

Recent Feedback

RimGui

Today's picks

Was this content helpful?

Recent Feedback

Download README