druid

[![](media/druid_logo.png)](https://insality.github.io/druid/)

[![GitHub release (latest by date)](https://img.shields.io/github/v/tag/insality/druid?style=for-the-badge&label=Release)](https://github.com/Insality/druid/tags)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/insality/druid/ci-workflow.yml?branch=master&style=for-the-badge)](https://github.com/Insality/druid/actions)
[![codecov](https://img.shields.io/codecov/c/github/Insality/druid?style=for-the-badge)](https://codecov.io/gh/Insality/druid)

To make UI you need to place nodes in the Defold GUI editor, then attach a logic (button, scroll, data list or your own component) to them.

## Layout the window

Build the window in Defold GUI editor, for example:

```
shop
├── title          text
├── close          button
├── scroll         scroll view (stencil, this size is the window)
│   └── content    scroll content (child, taller than the view)
│       └── row    item prefab (cloned into the list)
└── buy            button
```

## Assign the ids to the components

Now we can assign components inside `init` of this GUI gui_script file:

```lua
self.druid = druid.new(self)

self.druid:new_text("title", "Shop")
self.druid:new_button("close", self.on_close)
self.druid:new_scroll("scroll", "content")
self.druid:new_button("buy", self.on_buy)
```

## Custom widgets is a `.gui` plus a `.lua` files

For example you did `health_bar.gui` (`root`, `fill`, `label`).
Now you can make `health_bar.lua` next to it:

```lua
function M:init()
	self.progress = self.druid:new_progress("fill", "x")
	self.label = self.druid:new_text("label")
end
```

Add this `health_bar.gui` template on your screen, and init with `new_widget` function:

```lua
self.health_bar = self.druid:new_widget(health_bar, "health_bar")
```

[Live examples](https://insality.github.io/druid/)

## Features

- **Components** - Button, scroll, infinity lists, input and the many others. Logic over nodes you already placed inside GUI
- **Widgets** - A reusable piece is a `.gui` plus a `.lua`
- **Input** - Stack-based, with priority. Last created is checked first
- **Events** - Callbacks via [Defold Event](https://github.com/Insality/defold-event)

## Quick Links

- [Basic Usage](wiki/basic_usage.md)
- [Quick API Reference](api/quick_api_reference.md)
- [List of Components](#druid-components)
- [Contributors](#contributors)

## Setup

### [Dependency](https://defold.com/manuals/libraries/#setting-up-library-dependencies)

> Can be installed from the [Asset Store](https://github.com/Insality/asset-store) extension to skip this step.

Open your `game.project` file and add the following lines to the dependencies field under the project section:


**[Defold Event](https://github.com/Insality/defold-event)**

```
https://github.com/Insality/defold-event/archive/refs/tags/21.zip
```

**[Druid](https://github.com/Insality/druid/)**

```
https://github.com/Insality/druid/archive/refs/tags/1.4.0.zip
```

After that, s