edubart / otclient

An alternative tibia client for otserv written in C++11 and Lua, made with a modular system that uses lua scripts for ingame interface and functionality, making otclient flexible and easy to customize
Other
652 stars 399 forks source link

OTUI documentation #1081

Open Zbizu opened 4 years ago

Zbizu commented 4 years ago

Problem: There is no documentation regarding UI in modules. New developers are very lost and it's very hard to get into writing modules without having some kind of mentor. Those who learn things by themselves have no motivation to give back.

Issue goal: I want to build some kind of documentation for new users to get into coding modules faster and accelerate coding speed for intermediate users. With good documentation and examples, modules would be made faster and people would be more prone to share their work because their investment would be lower than current. More activity around the client and better documentation would bring us more contributors that would eventually fix other problems.

Information needed to begin: Where I can find otui attributes and their supported values?

also, can I start wiki in this repo?

diath commented 4 years ago

You should be able to tell the supported value types based on these, also I don't think the Wiki access is currently restricted.

https://github.com/edubart/otclient/blob/63f5351016322ac1101222deffb2a8bd557ecf3e/src/framework/ui/uiwidgetbasestyle.cpp#L72-L333 https://github.com/edubart/otclient/blob/63f5351016322ac1101222deffb2a8bd557ecf3e/src/framework/ui/uiwidgetimage.cpp#L36-L75 https://github.com/edubart/otclient/blob/63f5351016322ac1101222deffb2a8bd557ecf3e/src/framework/ui/uiwidgettext.cpp#L61-L80