+
+Druid - powerful defold component UI library. Use basic druid components or make your own game-specific components to make amazing GUI in your games.
+ + +Setup
+Dependency
+You can use the druid extension in your own project by adding this project as a Defold library dependency. Open your game.project file and in the dependencies field under project add:
+ ++ ++ +
Or point to the ZIP file of a specific release.
+ + +Code
+Adjust druid settings, if needed:
+ ++local druid = require("druid.druid") + +-- Used for button component and custom components +druid.set_sound_function(callback) + +-- Used for lang_text component +druid.set_text_function(callback) + +-- Used for change default druid style +druid.set_default_style(your_style) ++ + + +
Components
+Druid provides next basic components: +- Button - Basic game button
+ +-
+
Text - Wrap on text node with text size adjusting
+ Blocker - Block input in node zone
+ Back Handler - Handle back button (Android, backspace)
+ Lang text - Text component with handle localization system
+ Timer - Run timer on text node
+ Progress - Basic progress bar
+ Scroll - Basic scroll component
+ Grid - Component for manage node positions
+ Slider - Basic slider component
+ Checkbox - Basic checkbox component
+ Checkbox group - Several checkboxes in one group
+ Radio group - Several checkboxes in one group with single choice
+
Full info see on components.md
+ + +Creating components
+Any components creating via druid:
+ ++local druid = require("druid.druid") + +local function init(self) + self.druid = druid.new(self) + local button = self.druid:new_button(node_name, callback) + local text = self.druid:new_text(node_text_name) +end + +function update(self, dt) + self.druid:update(dt) +end + +function on_message(self, message_id, message, sender) + self.druid:on_message(message_id, message, sender) +end + +function on_input(self, action_id, action) + self.druid:on_input(action_id, action) +end ++ + + +
Examples
+See the example folder for examples of how to use Druid +See the druid-assets repository for examples of how to create custom components and styles +Try the HTML5 version of the example app
+ + +Documentation
+To learn druid better, read next documentation: +- Druid components +- Create custom components +- Druid asset store +- Druid Styles
+ +Full druid documentation you can find here: +https://insality.github.io/druid/
+ + +Games powered by Druid:
+Will fill later
+ + +Future plans
+ +-
+
Basic input component
+ Add onlayoutchange support (to keep gui data between layout change)
+ Add onchangelanguage support (call single function to update all druid instance)
+ Better documentation and examples
+ Add more comfortable gamepad support for GUI (ability to select button with DPAD and other stuff)
+
License
+Original idea by AGulev +Developed and supporting by Insality +MIT License
+ + + +Issues and suggestions
+If you have any issues, questions or suggestions please create an issue or contact me: insality@gmail.com + +