Skip to content
This repository was archived by the owner on Feb 11, 2024. It is now read-only.

Commit e131f6f

Browse files
committed
2 parents bac9761 + 37b8bb2 commit e131f6f

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# COM3D2.GUIAPI
2+
An API for making the tedious task of modifying COM's NGUI UI a trivial matter only requiring a few lines to complete complex tasks.
3+
4+
COM is one of those games where the UI is never edited and the plugins utilizing NGUI were seen as black magic. The work involved is more-over tedious and modders who are capable of making a GUI API just don't, doing the work only for their own plugins.
5+
6+
GUIAPI aims to change that, putting powerful functions into the hands of less experienced modders allowing them to make robust changes to Kiss's very own GUI with only a few lines of code. Gone are the days of NGUI UI changes being exclusive to seasoned programmers.
7+
8+
Implemented
9+
- Fully functional configuration menu API. You can create new tabs, add sliders, switches, dropdowns and input fields which you can reference and get changes from.
10+
11+
Planned
12+
- Edit Mode API that allows the addition of new categories, sliders and/or dropdowns and similar controls.
13+
- Plugin API. A simple API that allows you to create NGUI UIs for your plugins with IMGUI-like calls.
14+
15+
Why this API is better than other UI edits.
16+
17+
1. Simple to use. Dirt simple.
18+
2. Changes occur in runtime and are gone when you close your game. No game files are ever modified and removing the plugin is enough to remove it's functionality.
19+
3. We use COM's own sprite data to make UIs that fit seamlessly with the game's own UIs.
20+
4. Way better for performance than IMGUI.
21+
5. Sizing, component setup and everything is handled for you.
22+
23+
![COM3D2x64_cdvdzY1IlE](https://user-images.githubusercontent.com/29824718/125689541-14028a54-4ee2-4f42-b378-381ba052ab09.png)

0 commit comments

Comments
 (0)