@dicebear/definitions 9.0.0-alpha.0 → 9.0.0-beta.1

package/LICENSE.md

@@ -1,34 +1,228 @@
 # License
 
 The designs are licensed under different licenses, which the designers can
-choose themselves. You can find the license in the corresponding avatar style
-definition file.
-
-- [adventurer-neutral.json](src/adventurer-neutral.json)
-- [adventurer.json](src/adventurer.json)
-- [avataaars-neutral.json](src/avataaars-neutral.json)
-- [avataaars.json](src/avataaars.json)
-- [big-ears-neutral.json](src/big-ears-neutral.json)
-- [big-ears.json](src/big-ears.json)
-- [big-smile.json](src/big-smile.json)
-- [bottts-neutral.json](src/bottts-neutral.json)
-- [bottts.json](src/bottts.json)
-- [croodles-neutral.json](src/croodles-neutral.json)
-- [croodles.json](src/croodles.json)
-- [fun-emoji.json](src/fun-emoji.json)
-- [icons.json](src/icons.json)
-- [identicon.json](src/identicon.json)
-- [initials.json](src/initials.json)
-- [lorelei-neutral.json](src/lorelei-neutral.json)
-- [lorelei.json](src/lorelei.json)
-- [micah.json](src/micah.json)
-- [miniavs.json](src/miniavs.json)
-- [notionists-neutral.json](src/notionists-neutral.json)
-- [notionists.json](src/notionists.json)
-- [open-peeps.json](src/open-peeps.json)
-- [personas.json](src/personas.json)
-- [pixel-art-neutral.json](src/pixel-art-neutral.json)
-- [pixel-art.json](src/pixel-art.json)
-- [rings.json](src/rings.json)
-- [shapes.json](src/shapes.json)
-- [thumbs.json](src/thumbs.json)
+choose themselves.
+
+## Adventurer
+
+|     File | [src/adventurer.json](./src/adventurer.json)                           |
+| -------: | :--------------------------------------------------------------------- |
+| Designer | [Lisa Wischofsky](https://www.instagram.com/lischi_art/)               |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)              |
+|   Source | [Adventurer](https://www.figma.com/community/file/1184595184137881796) |
+
+## Adventurer Neutral
+
+|     File | [src/adventurer-neutral.json](./src/adventurer-neutral.json)                   |
+| -------: | :----------------------------------------------------------------------------- |
+| Designer | [Lisa Wischofsky](https://www.instagram.com/lischi_art/)                       |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                      |
+|   Source | [Adventurer Neutral](https://www.figma.com/community/file/1184595184137881796) |
+
+## Avataaars
+
+|     File | [src/avataaars.json](./src/avataaars.json)                     |
+| -------: | :------------------------------------------------------------- |
+| Designer | [Pablo Stanley](https://twitter.com/pablostanley)              |
+|  License | [Free for personal and commercial use](https://avataaars.com/) |
+|   Source | [Avataaars](https://avataaars.com/)                            |
+
+## Avataaars Neutral
+
+|     File | [src/avataaars-neutral.json](./src/avataaars-neutral.json)      |
+| -------: | :-------------------------------------------------------------- |
+| Designer | [Pablo Stanley](https://twitter.com/pablostanley)               |
+|  License | [Free for personal and commercial use.](https://avataaars.com/) |
+|   Source | [Avataaars](https://avataaars.com/)                             |
+
+## Big Ears
+
+|     File | [src/big-ears.json](./src/big-ears.json)                                  |
+| -------: | :------------------------------------------------------------------------ |
+| Designer | [The Visual Team](https://thevisual.team/)                                |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                 |
+|   Source | [Face Generator](https://www.figma.com/community/file/986078800058673824) |
+
+## Big Ears Neutral
+
+|     File | [src/big-ears-neutral.json](./src/big-ears-neutral.json)                  |
+| -------: | :------------------------------------------------------------------------ |
+| Designer | [The Visual Team](https://thevisual.team/)                                |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                 |
+|   Source | [Face Generator](https://www.figma.com/community/file/986078800058673824) |
+
+## Big Smile
+
+|     File | [src/big-smile.json](./src/big-smile.json)                               |
+| -------: | :----------------------------------------------------------------------- |
+| Designer | [Ashley Seo](http://www.ashleyseo.com/)                                  |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                |
+|   Source | [Custom Avatar](https://www.figma.com/community/file/881358461963645496) |
+
+## Bottts
+
+|     File | [src/bottts.json](./src/bottts.json)                        |
+| -------: | :---------------------------------------------------------- |
+| Designer | [Pablo Stanley](https://twitter.com/pablostanley)           |
+|  License | [Free for personal and commercial use](https://bottts.com/) |
+|   Source | [Bottts](https://bottts.com/)                               |
+
+## Bottts Neutral
+
+|     File | [src/bottts-neutral.json](./src/bottts-neutral.json)        |
+| -------: | :---------------------------------------------------------- |
+| Designer | [Pablo Stanley](https://twitter.com/pablostanley)           |
+|  License | [Free for personal and commercial use](https://bottts.com/) |
+|   Source | [Bottts](https://bottts.com/)                               |
+
+## Croodles
+
+|     File | [src/croodles.json](./src/croodles.json)                                               |
+| -------: | :------------------------------------------------------------------------------------- |
+| Designer | [vijay verma](https://vjy.me/)                                                         |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                              |
+|   Source | [Croodles - Doodle your face](https://www.figma.com/community/file/966199982810283152) |
+
+## Croodles Neutral
+
+|     File | [src/croodles-neutral.json](./src/croodles-neutral.json)                               |
+| -------: | :------------------------------------------------------------------------------------- |
+| Designer | [vijay verma](https://vjy.me/)                                                         |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                              |
+|   Source | [Croodles - Doodle your face](https://www.figma.com/community/file/966199982810283152) |
+
+## Fun Emoji
+
+|     File | [src/fun-emoji.json](./src/fun-emoji.json)                               |
+| -------: | :----------------------------------------------------------------------- |
+| Designer | [Davis Uche](https://www.instagram.com/davedirect3/)                     |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                |
+|   Source | [Fun Emoji Set](https://www.figma.com/community/file/968125295144990435) |
+
+## Icons
+
+|     File | [src/icons.json](./src/icons.json)                     |
+| -------: | :----------------------------------------------------- |
+| Designer | [The Bootstrap Authors](https://getbootstrap.com/)     |
+|  License | [MIT](https://github.com/twbs/icons/blob/main/LICENSE) |
+|   Source | [Bootstrap Icons](https://github.com/twbs/icons)       |
+
+## Identicon
+
+|     File | [src/identicon.json](./src/identicon.json)                    |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Florian Körner](https://dicebear.com)                        |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Identicon](https://dicebear.com)                             |
+
+## Initials
+
+|     File | [src/initials.json](./src/initials.json)                      |
+| -------: | :------------------------------------------------------------ |
+| Designer | [DiceBear](https://www.dicebear.com)                          |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [DiceBear](https://www.dicebear.com)                          |
+
+## Lorelei
+
+|     File | [src/lorelei.json](./src/lorelei.json)                              |
+| -------: | :------------------------------------------------------------------ |
+| Designer | [Lisa Wischofsky](https://www.instagram.com/lischi_art/)            |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)       |
+|   Source | [Lorelei](https://www.figma.com/community/file/1198749693280469639) |
+
+## Lorelei Neutral
+
+|     File | [src/lorelei-neutral.json](./src/lorelei-neutral.json)                      |
+| -------: | :-------------------------------------------------------------------------- |
+| Designer | [Lisa Wischofsky](https://www.instagram.com/lischi_art/)                    |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)               |
+|   Source | [Lorelei Neutral](https://www.figma.com/community/file/1198749693280469639) |
+
+## Micah
+
+|     File | [src/micah.json](./src/micah.json)                                                    |
+| -------: | :------------------------------------------------------------------------------------ |
+| Designer | [Micah Lanier](https://dribbble.com/micahlanier)                                      |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                             |
+|   Source | [Avatar Illustration System](https://www.figma.com/community/file/829741575478342595) |
+
+## Miniavs
+
+|     File | [src/miniavs.json](./src/miniavs.json)                                                   |
+| -------: | :--------------------------------------------------------------------------------------- |
+| Designer | [Webpixels](https://webpixels.io/)                                                       |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)                                |
+|   Source | [Miniavs - Free Avatar Creator](https://www.figma.com/community/file/923211396597067458) |
+
+## Notionists
+
+|     File | [src/notionists.json](./src/notionists.json)                  |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Zoish](https://bio.link/heyzoish)                            |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Notionists](https://heyzoish.gumroad.com/l/notionists)       |
+
+## Notionists Neutral
+
+|     File | [src/notionists-neutral.json](./src/notionists-neutral.json)  |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Zoish](https://bio.link/heyzoish)                            |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Notionists](https://heyzoish.gumroad.com/l/notionists)       |
+
+## Open Peeps
+
+|     File | [src/open-peeps.json](./src/open-peeps.json)                  |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Pablo Stanley](https://twitter.com/pablostanley)             |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Open Peeps](https://www.openpeeps.com/)                      |
+
+## Personas
+
+|     File | [src/personas.json](./src/personas.json)                  |
+| -------: | :-------------------------------------------------------- |
+| Designer | [Draftbit - draftbit.com](https://draftbit.com/)          |
+|  License | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) |
+|   Source | [Personas by Draftbit](https://personas.draftbit.com/)    |
+
+## Pixel Art
+
+|     File | [src/pixel-art.json](./src/pixel-art.json)                            |
+| -------: | :-------------------------------------------------------------------- |
+| Designer | [Florian Körner](https://www.dicebear.com)                            |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)         |
+|   Source | [Pixel Art](https://www.figma.com/community/file/1198754108850888330) |
+
+## Pixel Art Neutral
+
+|     File | [src/pixel-art-neutral.json](./src/pixel-art-neutral.json)                    |
+| -------: | :---------------------------------------------------------------------------- |
+| Designer | [Florian Körner](https://www.dicebear.com)                                    |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)                 |
+|   Source | [Pixel Art Neutral](https://www.figma.com/community/file/1198754108850888330) |
+
+## Rings
+
+|     File | [src/rings.json](./src/rings.json)                            |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Florian Körner](https://www.dicebear.com)                    |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Rings](https://www.dicebear.com)                             |
+
+## Shapes
+
+|     File | [src/shapes.json](./src/shapes.json)                          |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Florian Körner](https://www.dicebear.com)                    |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Shapes](https://www.dicebear.com)                            |
+
+## Thumbs
+
+|     File | [src/thumbs.json](./src/thumbs.json)                          |
+| -------: | :------------------------------------------------------------ |
+| Designer | [Florian Körner](https://www.dicebear.com)                    |
+|  License | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) |
+|   Source | [Thumbs](https://www.dicebear.com)                            |

package/README.md

@@ -1,3 +1,27 @@
-# DiceBear Avatar Style Definitions
+# DiceBear Definitions
 
+> [!NOTE]  
+> This project is still in alpha stage and will only be used in future versions
+> of DiceBear.
 
+This repository contains all official avatar style definitions for DiceBear. An
+avatar style definition is a JSON file that describes how to create an avatar.
+It contains all necessary information like available elements and colors. The
+JSON files are ideal for creating avatars in different programming languages
+with the corresponding DiceBear wrapper. The JSON schema for the avatar style
+definitions can be found here:
+[https://static.dicebear.com/schema/definition.json](https://static.dicebear.com/schema/definition.json)
+
+## Generate definitions
+
+Most of the JSON files were created using the
+[DiceBear Exporter](https://www.dicebear.com/guides/create-an-avatar-style-with-figma/)
+for Figma. The used Figma files are linked in the `figma` folder. Files created
+with this plugin are marked accordingly and should not be adjusted manually, but
+exported again with the Figma plugin.
+
+## License
+
+The avatar styles are licensed under different licenses. More information can be
+found in the file [LICENSE.md](./LICENSE.md) or in the definition files
+themselves.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@dicebear/definitions",
-  "version": "9.0.0-alpha.0",
+  "version": "9.0.0-beta.1",
   "description": "Definition files of the DiceBear avatar styles.",
   "keywords": [
+    "avatar",
     "dicebear"
   ],
   "bugs": {
@@ -12,7 +13,11 @@
     "type": "git",
     "url": "git+https://github.com/dicebear/definitions.git"
   },
+  "sideEffects": false,
   "type": "module",
+  "scripts": {
+    "build": "tsx ./scripts/build.ts"
+  },
   "files": [
     "LICENSE",
     "src",
@@ -20,5 +25,13 @@
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.6",
+    "@types/node": "^20.12.5",
+    "change-case": "^5.4.4",
+    "glob": "^10.3.12",
+    "markdown-table": "^3.0.3",
+    "tsx": "^4.7.2"
   }
 }