https://github.com/hexaengine/hexa.net.kittyui
https://github.com/hexaengine/hexa.net.kittyui
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/hexaengine/hexa.net.kittyui
- Owner: HexaEngine
- License: mit
- Created: 2024-07-10T15:06:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T09:42:23.000Z (about 1 year ago)
- Last Synced: 2025-04-13T09:54:44.212Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 18 MB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Hexa.NET.KittyUI (WIP)
Hexa.NET.KittyUI is a minimalistic UI framework built around the popular **imgui** library, designed to be lightweight and highly portable. It supports cross-platform development and comes with rendering backends for both **Direct3D 11 (D3D11)** and **OpenGL 4**.
## Features
- **Minimalistic Design**: Focused on providing a clean and simple interface for building user interfaces quickly and efficiently.
- **Cross-Platform Support**: Compatible with multiple platforms, allowing you to develop and deploy your applications on different operating systems with ease.
- **Rendering Backends**: Supports **Direct3D 11 (D3D11)** and **OpenGL 4**, giving you flexibility in choosing the right rendering backend for your project.
- **Integration with imgui**: Leverages the powerful **imgui** library, providing an intuitive and efficient way to build UI components.
- **AOT Ready**: Supports AOT publishing and code trimming.
## Getting Started
### Prerequisites
Before you start using Hexa.NET.KittyUI, ensure you have the following prerequisites installed:
- **.NET SDK**: .NET 8.0 or higher.
### Installation
1. **Install the NuGet Package**:
You can install the Hexa.NET.KittyUI package via NuGet by adding `Hexa.NET.KittyUI` to your project dependencies.
2. **Integrate with Your Project**:
After installing the package, simply include it in your project and start building your UI components.
### Usage
```cs
// See https://aka.ms/new-console-template for more information
using Hexa.NET.ImGui;
using Hexa.NET.KittyUI;
AppBuilder builder = new();
builder.AddWindow("Main Window", () =>
{
ImGui.Text("Hello, World!");
});
builder.Run();
```
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/HexaEngine/Hexa.NET.KittyUI/blob/master/LICENSE.txt) file for details.