Skip to content

Commit 4c8a461

Browse files
Update README.md
1 parent be934d9 commit 4c8a461

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
# Nuklear-Visual-Style-Editor
1+
# Allegro Nuklear Visual Style Editor (ANVSE)
22
Visually edit Nuklear GUI style files.
3+
4+
## About
5+
The Nuklear GUI, Visual Styles Editor is a fast and easy way to create or modify style tables for the Nuklear GUI system.
6+
Style files can be loaded, modified and then saved. Just copy and paste the created style table into your project source code.
7+
The output file is a correctly formatted Nuklear style.c table.
8+
The editing interface is quite straight forward. Each NK COLOR style can be adjusted using the colour sliders. Click apply under the adjuster and the NK COLOR is applied to the current GUI.
9+
You can preview the widget that each colour applies to in the right interface, or browse the default Nuklear demo widgets in the example drop down menu.
10+
If you don't like the colour for that style item, you can reset the colour back to the default loaded from the style file.
11+
If you want to start with a blank GUI, you can reset all colours with the top button, or reload an existing style file.
12+
You can load, and modify an existing style file at any time.
13+
14+
The background Colour drop down is separate from the other adjusters.Here you can adjust alpha transparency for a single colour or for the entire GUI colours as a group.
15+
You can adjust and set a solid background colour, or use a choice of 2 background images to test the transparency on a background.
16+
Use the "Lock All" and "Lock None" to switch between single and group alpha adjustment.
17+
Select "Lock None" followed by "Reset all colours" to clear all adjustments and start again.
18+
19+
Hopefully developers that make use of Nuklear GUI can find this useful.
20+
21+
The visual editor is based upon the Allegro 5 graphics library and Nuklear and is available for Windows and Ubuntu x86-64.Allegro, Nuklear Visual Style Editor (ANVSE).Allegro Visual Style Editor (std) source is licenced under MIT0 and free to modify and use.
22+
23+
## More information
24+
I had just began familiarizing my self with Allegro 5 and Nuklear when I made this. I quickly discovered that there wasn't any easy way to edit the 28 style colors in the style.c file and thought 28 x 4(rgba) colors to manually edit was a no go for me lol
25+
Creating ANVSE turned out to be a good way to become familiar with Nuklear :)
26+
Some of the code can be improved and I may well do so in the future, but for now the application does what I require.
27+
I made this for my self but have put it up on GitHub so others can make use of it or even find ideas from the code.
28+
I used the MIT-0 licence so you can do what you like with it. That being said an attribute is always welcome ;)
29+
30+
I am looking at implimenting some addition in the future such as more options to test alpha transparency on the backgrounds.
31+
I am also looking at pulling the current operating system theme colors into a style file. If you have ever tried to do this you will know that it is fraught with inconsistancies and gotchas, so don't hold your breath too long :)
32+
33+
## Some picks to muse at

0 commit comments

Comments
 (0)