Partydeck/Extension-Druid
3
0
Fork 0
mirror of https://github.com/Insality/druid.git synced 2025-06-27 10:27:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README, move emmylua section to Advanced Setup manual

Browse Source
This commit is contained in:
Insality 2023-07-16 12:28:46 +03:00
parent 556e1a9bae
commit 5a0cf42e3d
2 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -23,7 +23,7 @@ To integrate the **Druid** extension into your own project, add this project as
Here is a list of [all releases](https://github.com/Insality/druid/releases). Here is a list of [all releases](https://github.com/Insality/druid/releases).
Size: **68.73 KB** Size: **67.16 KB**
> The size metrics exlcude the extended components, which are including only on demand. > The size metrics exlcude the extended components, which are including only on demand.
@ -87,25 +87,7 @@ For all **Druid** instance functions, [see here](https://insality.github.io/drui
Start reading the API documentation [here](https://insality.github.io/druid/modules/Druid.html). Start reading the API documentation [here](https://insality.github.io/druid/modules/Druid.html).
**Druid** provide the *EmmyLua* annotations to add autocomplete inside your IDE. Check [EmmyLua Setup here](docs_md/advanced-setup.md#emmylua-annotations).
### EmmyLua Annotations [optional]
[EmmyLua](https://emmylua.github.io/annotation.html) is a Lua annotation library. It is a useful tool for enabling Lua code autocompletion in editors such as [VSCode](https://github.com/EmmyLua/VSCode-EmmyLua) and [IntelliJ IDEA](https://github.com/EmmyLua/IntelliJ-EmmyLua).
Since dependencies cannot be processed by external editors, to use the EmmyLua annotations, you should copy the _druid/annotations.lua_ file to your project.
Remember that you can restart the EmmyLua server to refresh the changes if something goes wrong.
After the annotations are processed, you should specify the type of "Druid" in the "require" statement:
```lua
---@type druid
local druid = require("druid.druid")
-- Now the autocomplete is working
```
<img src="media/emmy_lua_preview.png" width="700">
### Create custom components ### Create custom components

30
docs_md/advanced-setup.md
View File

@ -20,7 +20,7 @@ By default, **Druid** utilizes the `/builtins/input/all.input_binding` for input
![](../media/input_binding_1.png) ![](../media/input_binding_1.png)
## Changing Key Bindings (optional) ## Changing Key Bindings
If you need to use your own key bindings or key names, you can modify them in your *game.project* file. If you need to use your own key bindings or key names, you can modify them in your *game.project* file.
@ -40,7 +40,7 @@ input_scroll_down = mouse_wheel_down
``` ```
## Input Capturing (optional) ## Input Capturing
By default, **Druid** automatically captures input focus if any input component is created. Therefore, you do not need to call `msg.post(".", "acquire_input_focus")`. By default, **Druid** automatically captures input focus if any input component is created. Therefore, you do not need to call `msg.post(".", "acquire_input_focus")`.
@ -51,7 +51,7 @@ no_auto_input = 1
``` ```
## Template Name Check (optional) ## Template Name Check
By default, **Druid** automatically checks the parent component's template name to construct the full template name for the component. It's used in user custom components. By default, **Druid** automatically checks the parent component's template name to construct the full template name for the component. It's used in user custom components.
@ -63,7 +63,7 @@ no_auto_template = 1
``` ```
## Stencil Check (optional) ## Stencil Check
When creating input components inside stencil nodes, **Druid** automatically sets up `component:set_click_zone()` during the _late_init_ component step to restrict input clicks outside of the stencil zone. This is particularly useful for buttons inside scroll stencil nodes. When creating input components inside stencil nodes, **Druid** automatically sets up `component:set_click_zone()` during the _late_init_ component step to restrict input clicks outside of the stencil zone. This is particularly useful for buttons inside scroll stencil nodes.
@ -74,7 +74,7 @@ no_stencil_check = 1
``` ```
## Code Bindings (optional) ## Code Bindings
Adjust **Druid** settings as needed: Adjust **Druid** settings as needed:
```lua ```lua
@ -109,3 +109,23 @@ local function on_window_callback(self, event, data)
end end
window.set_listener(on_window_callback) window.set_listener(on_window_callback)
``` ```
## EmmyLua Annotations
[EmmyLua](https://emmylua.github.io/annotation.html) is a Lua annotation library. It is a useful tool for enabling Lua code autocompletion in editors such as [VSCode](https://github.com/EmmyLua/VSCode-EmmyLua) and [IntelliJ IDEA](https://github.com/EmmyLua/IntelliJ-EmmyLua).
Since dependencies cannot be processed by external editors, to use the EmmyLua annotations, you should copy the _druid/annotations.lua_ file to your project.
Remember that you can restart the EmmyLua server to refresh the changes if something goes wrong.
After the annotations are processed, you should specify the type of "Druid" in the "require" statement:
```lua
---@type druid
local druid = require("druid.druid")
-- Now the autocomplete is working
```
<img src="../media/emmy_lua_preview.png" width="700">