DiceBear 5.0 - Release Notes #255
FlorianKoerner
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I am very happy to present you the new DiceBear version today. In these release notes I would like to introduce you to the new tools, avatar styles and features.
📚 New Documentation
The documentation has been completely rewritten. I would like to highlight the new options overview. For each avatar style option there is now a preview that makes it easier for you to find the option you want.
Also worth mentioning are the new documentations for the JS-Library, HTTP-API and the CLI. They now go into much more detail than before.
In addition, you will now find many new instructions in the documentation, such as:
🛝 New Playground
The new Playground helps you to configure your avatars. It supports all avatar styles and almost all available options! Discover how to use your configuration with the JS-Library, HTTP-API or CLI. Alternatively, you can download or copy the created avatars directly!
🤩 New Avatar Styles
Avataaars Neutral
This implementation is a remix of Avataaars by
Pablo Stanley. Licensed under
Free for personal and commercial use.
Documentation
Bottts Neutral
This implementation is a remix of Bottts by
Pablo Stanley. Licensed under
Free for personal and commercial use.
Documentation
Fun Emoji
This implementation is a remix of
Fun Emoji Set by
Davis Uche. Licensed under
CC BY 4.0.
Documentation
Icons
This implementation is a remix of
Bootstrap Icons by
The Bootstrap Authors. Licensed under
MIT.
Documentation
Lorelei
This implementation is a remix of Lorelei by
Lisa Wischofsky. Licensed under
CC0 1.0.
Documentation
Lorelei Neutral
This implementation is a remix of Lorelei by
Lisa Wischofsky. Licensed under
CC0 1.0.
Documentation
Pixel Art (Updated)
Licensed under CC0 1.0.
Documentation
Pixel Art Neutral (Updated)
Licensed under CC0 1.0.
Documentation
🌎 New API Endpoint
The API endpoint has changed. In addition, the options are now much easier to specify than before. For more detailed information, I recommend you to read this release notes or the documentation.
Note that the old API endpoint and versions <= 4.10 will be discontinued at the end of 2023. From that point on, the new API endpoint must be used.
🏞️ New Export Formats
In addition to the HTTP API and the CLI, the JS library now also supports export to raster graphics.
💪 Further Optimizations
DiceBear has no hard dependencies now. Due to this and other internal optimizations, the packages are up to 72% smaller (minified + gzipped) than in the previous version! The optimizations also affect the performance. So DiceBear is now up to 3,200% faster. I posted more about this here some time ago: #172
🏆 How To Upgrade
I recommend you to take another look at the documentation. In your used avatar style, the option names may have changed. The exact changes would go beyond the scope of these release notes. However, I would like to mention the following changes.
New package names
If you use the JS-Library, this information is relevant for you: Some package names have changed. The package
@dicebear/avatars
is now called@dicebear/core
and all avatar styles with a package name following the pattern@dicebear/avatar-X-sprites
are now simply called@dicebear/X
. This makes the avatar package names shorter and easier to remember.Removed Avatar Styles
As announced, the avatar styles "gridy" and "jdenticon" have been removed. More information:
"gridy" and "jdenticon" avatar styles are now deprecated #187
❤️ Thank you
I would like to thank the fansatic designers who provide their work for free. Without you DiceBear would not be possible! Also I want to thank our sponsor bunny.net who helps me to keep the costs for the HTTP API low. You are great guys! Thanks for your support!
Beta Was this translation helpful? Give feedback.
All reactions