Skip to content

Commit 6e1998b

Browse files
committed
Update changelog
1 parent 225fa0a commit 6e1998b

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

wiki/changelog.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -583,29 +583,34 @@ Hello there, Druid users!
583583

584584
The wait is over - **Druid 1.1** has arrived! This update brings substantial improvements and exciting new features that make building UI in Defold easier and more powerful than ever.
585585

586+
By the way, the PR number of this release is #300. Sounds veeery hude and long journey for me!
587+
586588
## Highlights
587589

588-
- **Widgets** are here! This is the evolution of custom components, but with no boilerplate code and far more convenient usage. All Druid examples have been migrated to use widgets.
590+
- **Widgets** are here! This is the evolution of custom components, but with no boilerplate code and far more convenient usage. All Druid examples have been migrated to use widgets. Widgets are now a default way to create a new custom components (basically any of your GUI element on the screen).
589591

590592
- **Experimental features** like shader pipeline in GUI and widget usage in GO scripts. Curious Defolders can find examples of these features and try them out.
591593

592594
- **No more calling `druid.register()`!** All Druid components are now available by default with `self.druid:new_*` functions, making getting started simpler than ever.
593595

594-
- **Druid UI Kit** brings fonts, atlas, and ready-to-use GUI templates right out of the box - a long-requested feature that lets you use Druid UI elements instantly in your projects. I think now it's a possible to create a external dependency with a set of GUI and Druid's widgets to make a ready to use UI kit for projects!
596+
- **Druid UI Kit** brings fonts, atlas, and ready-to-use GUI templates right out of the box - a long-requested feature that lets you use Druid UI elements instantly in your projects. I think now it's a possible to create a external dependencies with a set of GUI templates and Druid's widgets to make a ready to use UI kit for projects! The flow to init widgets always now from two steps:
597+
- Add GUI template to your GUI scene
598+
- Call `self.widget = self.druid:new_widget(widget_file, "template_id")` to init widget
599+
595600

596-
- **Completely reworked documentation** with full code annotations. Start with the Quick API Reference to get familiar with Druid.
601+
- **Completely reworked documentation** with full code annotations. Start with the [Quick API Reference](/api/quick_api_reference.md) to get familiar with **Druid**. Any documentation are generated from the code annotations, so in case to update documentation, you need to update annotations in the code.
597602

598603
## Breaking Changes
599604

600-
- `druid.event` has been replaced with the `defold-event` library, requiring a small migration in your code if you were using events directly.
605+
- `druid.event` has been replaced with the [defold-event](https://github.com/Insality/defold-event) library, requiring a small migration in your code if you were using events directly. Double dependencies are now required to use Druid.
601606

602607
## Improved Workflow
603608

604-
The editor scripts have been updated too. Now they use pure Lua instead of Python, meaning there's no additional setup required to start using them!
609+
The editor scripts have been updated too. Now they use pure **Lua** instead of **Python**, meaning there's no additional setup required to start using them! This is a "Create Druid Widget" and "Assign Layers" editor scripts at the moment.
605610

606611
---
607612

608-
This release represents a major step forward in making Druid more maintainable, readable, and powerful. Check out the full changelog for all the details!
613+
This release represents a major step forward in making Druid more maintainable, readable, and powerful. Check out the full changelog for all the details! The [contributing guide](/CONTRIBUTING) is created for people who want to contribute to the Druid.
609614

610615
Thank you for using Druid and please share your feedback!
611616

@@ -620,7 +625,6 @@ Thank you for using Druid and please share your feedback!
620625
- The old API website is removed
621626
- The API now placed as a markdown files in the `api` folder
622627
- Start with [Quick API Reference](/api/quick_api_reference.md) to learn how to use Druid
623-
- All documentation pages are updated
624628
- [BREAKING] Remove `druid.event`, replaced with `defold-event` library. Now it required to two dependencies to use Druid.
625629
- This allow to make more flexible features, like shaders and sync init functions between script and gui_script in various cases.
626630
- You need to migrate from `require("druid.event")` to `require("event.event")` if you are using it in your project
@@ -630,6 +634,7 @@ Thank you for using Druid and please share your feedback!
630634
- [UI Kit] Add Druid UI Kit, contains `druid.atlas`, `druid_text_bold.font`, `druid_text_regular.font` so now you can use Druid GUI files in your projects.
631635
- Contains mostly basic shapes for the UI and can contains several icons. Atlas is a small, only `128x128` size and will be included in build only if you use it. Probably will grow a little bit in future.
632636
- A long waited feature which allows try or just use some **Druid** GUI features almost instantly.
637+
- No more "rich_input" template is not working! Should be good for now.
633638
- Now GUI files from **Druid** can be added inside your project.
634639
- This allow to include `Default Widgets` - ready to use GUI templates
635640
- [Widgets] Widgets here!
@@ -641,7 +646,7 @@ Thank you for using Druid and please share your feedback!
641646
- You can use `druid.get_widget(class, url)` to get a Druid instance in GO context.
642647
- All top level functions from widget are available in GO context.
643648
- It uses an `defold-event` library, so wrapping have a costs.
644-
- [Tada!] No need for the `druid.register()`! Now all Druid's components are available by default and available with `self.druid:new_*` functions
649+
- [System] 🎉 No need for the `druid.register()`! Now all Druid's components are available by default and available with `self.druid:new_*` functions
645650
- This means the Druid will be bigger in size, but it's much comfortable to use
646651
- In case you want to delete components you are not using, you can do it in fork in `druid.lua` file
647652
- Read [optimize_druid_size.md](optimize_druid_size.md) to learn how to reduce the size of the Druid library if you need

0 commit comments

Comments
 (0)