Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.53 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.53 KB

MagicUI

GitHub Build Workflow Status GitHub Docs Workflow Status GitHub release (latest by date) Downloads GitHub all releases

A core mod for Hollow Knight that takes all the fuss of dealing with GameObjects behind the scenes, allowing mod authors to seamlessly create in-game UIs for their mod with an easy-to-use hierarchical layout system inspired by WPF.

Features

  • Layout & component system, with no GameObjects (but you can access them if you really want to)
  • Several built-in elements and layouts for general use, such as:
    • Stack layout
    • Images
    • Buttons
    • Text display
    • Text input fields
  • API to create custom components and layouts to suit your needs
  • Persistent and non-persistent layout types
  • Ability to show UI elements only while the game is paused
  • Utility to listen for specific hotkeys given modifier keys and an optional condition

Get started

To use MagicUI, install it like you would any other mod and declare a dependency in your mod project. See the MagicUIExamples project for samples of what you can do, or view the full docs.