Update

README.md

@@ -7,7 +7,7 @@
 
 [![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)
 
-**Druid** - powerful **Defold** component UI framework that empowers developers to create stunning and customizable GUIs by leveraging a wide range of embedded components or effortlessly designing their own game-specific components.
+**Druid** - a powerful, flexible and easy to use **Defold** component UI framework. Contains a wide range of components and features to create stunning and customizable GUIs. Provides a powerful way to create, compose and manage your custom components and scenes.
 
 ## Druid Example
 

docs/druid/archive/game0.projectc

@@ -213,8 +213,6 @@ max_time_step = 0.5
 
 [druid]
 no_auto_input = 0
-no_stencil_check = 0
-no_auto_template = 0
 input_text = text
 input_touch = touch
 input_marked_text = marked_text

druid/base/button.lua

@@ -16,7 +16,7 @@ local component = require("druid.component")
 ---@field on_mouse_hover fun(self, node, hover_state)|nil
 ---@field on_set_enabled fun(self, node, enabled_state)|nil
 
----Clickable node with various interaction callbacks
+---Druid component to make clickable node with various interaction callbacks
 ---@class druid.button: druid.component
 ---@field on_click event function(self, custom_args, button_instance)
 ---@field on_pressed event function(self, custom_args, button_instance)
@@ -218,7 +218,7 @@ end
 
 ---Set additional button click area.
 ---Useful to restrict click outside out stencil node or scrollable content.
----This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
+---If button node placed inside stencil node, it will be automatically set to this stencil node.
 ---@param zone node|string|nil Gui node
 ---@return druid.button self
 function M:set_click_zone(zone)

druid/druid.lua

@@ -89,6 +89,7 @@ local WRAPPED_WIDGETS = {}
 
 ---Set a widget to the current game object. The game object can acquire the widget by calling `bindings.get_widget`
 ---It wraps with events only top level functions cross-context, so you will have no access to nested widgets functions
+---Only one widget can be set per game object.
 ---@param widget druid.widget
 function M.set_widget(widget)
 	local object = msg.url()
@@ -113,6 +114,7 @@ function M.set_widget(widget)
 end
 
 
+---Get a binded widget to the current game object.
 ---@param object_url string|userdata|url|nil Root object, if nil current object will be used
 ---@return druid.widget|nil
 function M.get_widget(object_url)

example/components/druid_logo/druid_logo.lua

@@ -3,7 +3,7 @@ local component = require("druid.component")
 
 local druid_logo_panthera = require("example.components.druid_logo.druid_logo_panthera")
 
----@class druid_logo: druid.component
+---@class examples.druid_logo: druid.component
 ---@field root druid.container
 ---@field text_description druid.text
 ---@field druid druid.instance

example/components/example_scene/example_scene.lua

@@ -1,6 +1,6 @@
 local component = require("druid.component")
 
----@class example_scene: druid.component
+---@class examples.example_scene: druid.component
 ---@field root druid.container
 ---@field text_debug_info druid.text
 ---@field text_gui_path druid.text

game.project

@@ -36,8 +36,6 @@ game_binding = /builtins/input/all.input_bindingc
 
 [druid]
 no_auto_input = 0
-no_stencil_check = 0
-no_auto_template = 0
 input_text = text
 input_touch = touch
 input_marked_text = marked_text