Git Product home page Git Product logo

imgui's Introduction

Development Paused Notification

Development of Hello ImGui is paused because I'm preparing for the National Postgraduate Entrance Examination in China. I'll restart the development once the exam is over on 26th of December.

Hello ImGui,

Hello ImGui is an immediate mode GUI library inspired by IMGUI of Unity3D and dear imgui.

code sample

Now it runs on Win10 x64, Ubuntu 16.04, and Android. See platforms. MAC and iphone are not supported because I don't have them.

Please be infromed that ImGui is just released. There's a lack of usability and documentation. But all will be improved gradually.

Please note that the API is unstable and will change at any time.

Get Started

For Windows and Linux

  1. Preparation

    • Download msjh.ttf to directory ImGui\src\ImGui\assets\fonts. See font note.
    • Add a local directory as a new nuget package source and put ImageSharp.1.0.0-alpha9.nupkg inside. (The offical ImageSharp package is a dummy one on nuget.org. This is a modified version of the lastest ImageSharp so it supports .NET Standard 2.0.)
  2. Create a .NET Core 2.0 project and reference ImGui.

  3. Add follwing code files to your project,

    Program.cs

    namespace YourApp
    {
        class Program
        {
            [STAThread]
            static void Main()
            {
                Application.Init();
                Application.Run(new MainForm());
            }
        }
    }

    MainForm.cs

    namespace YourApp
    {
        public class MainForm : Form
        {
            public MainForm() : base(new Rect(320, 180, 1280, 720)) { }
    
            protected override void OnGUI()
            {
                //your GUI code here
            }
        }
    }
  4. Build your project

  5. Run

    • run in VS2017: Press F5

    • run in Windows console:

      cd MyApp/bin/Debug/netcoreapp2.0
      dotnet MyApp.dll
      
    • run in Linux terminal:

      cd MyApp/bin/Debug/netcoreapp2.0
      dotnet MyApp.dll
      
  6. Exit

    Press Esc or click the close button of the window.

For Android

  1. Preparation
    • Add a local directory as a new nuget package source and put ImageSharp.1.0.0-alpha9.nupkg inside. (The offical ImageSharp package is a dummy one on nuget.org. This is a modified version of the lastest ImageSharp so it supports .NET Standard 2.0.)
  2. Copy Android Templates project. The referenced Demo can be removed if you don't need that.
  3. Add your GUI code in MainForm.OnGUI.
  4. Build and depoly it to your Android device.

For now, please refer to the shared project Demo for how to use Hello ImGui.

Target

A Real Universal GUI Framework.

Dependency

  • ImageSharp: A cross-platform library for the processing of image files; written in C#. It provides image loading functions for ImGui.
  • Xamarin.Android: Xamarin.Android provides open-source bindings of the Android SDK for use with .NET managed languages such as C#. It mainly provides C# runtime for ImGui.

Credits

DroidSans.ttf, Droid Sans is a humanist sans serif typeface designed by Steve Matteson licenced under Apache 2.

ImGui doesn't depends on following projects, code used by ImGui are taken from them.

  • Typography: C# Font Reader (TrueType / OpenType / OpenFont) , Glyphs Layout and Rendering
  • OpenTK: low-level C# wrapper for OpenGL
  • CSharpGL: Object Oriented OpenGL in C#
  • LogUtility: a light log tools

License

Hello ImGui is licensed under the LGPL License, see LICENSE for more information.

imgui's People

Contributors

zwcloud avatar

Watchers

James Cloos avatar MysticBoy avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.