Update README to 1.1.1

Nolway · Mar 16, 2022 · 87266ca · 87266ca
1 parent 37764b9
commit 87266ca
Showing 1 changed file with 97 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <h1>Woka NFT Generator 🧙‍♂️</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-1.1.1-blue.svg?cacheSeconds=2592000" />
   <a href="LICENSE.txt" target="_blank">
     <img alt="License: AGPL--3.0" src="https://img.shields.io/badge/License-AGPL--3.0-yellow.svg" />
   </a>
@@ -37,42 +37,87 @@ Configure the **/src/config.ts** file as needs :
 import { Config } from "./guards/ConfigGuards";
 
 const config: Config = {
-    blockchain: {
-        type: "ethereum", // ethereum|solana
-        metadata: {
-            /* Ethereum */
-            // Optional: Manage the NFT name
-            name: {
-                prefix: "My awesome Woka edition ", // Optional: NFT name prefix
-                suffix: " wow !", // Optional: NFT name suffix
-            },
-            description: "Awesome Woka", // Description of your NFT
-            image: "ipfs://mylink/", // Base URI to your avatar files
-            /* Avalanche */
-            /*
-            name: {
-                prefix: "My awesome Woka edition ",
-                suffix: " wow !",
-            },
-            description: "Awesome Woka",
-            image: "ipfs://mylink/",
-            */
-        },
-    },
-    collection: {
-        size: 10, // Number of NFTs to be created
-        crop: {
-            size: 512, // Optional: Resize of Woka in pixels to stick it above background (must be smaller than the background)
-            marging: {
-                // Optional: Add a margin to the woka in pixel
-                left: 64,
-                right: 64,
-                top: 64,
-                bottom: 64,
-            },
-        },
-        rarity: {
-            /**
+	blockchain: {
+		type: "ethereum", // ethereum|avalanche
+		metadata: {
+			/* Ethereum */
+			// Optional: Manage the NFT name
+			name: {
+				prefix: "My awesome Woka edition ", // Optional: NFT name prefix
+				suffix: " wow !", // Optional: NFT name suffix
+			},
+			description: "Awesome Woka", // Description of your NFT
+			image: "ipfs://mylink/", // Base URI to your avatar files
+		},
+	},
+	collection: {
+		size: 10, // Number of NFTs to be created
+		layers: [
+			// Layers used to generate the collection in order
+			{
+				name: "Body", // Attribute generated on metadata & folder name on assets/layers/
+			},
+			{
+				name: "Eyes",
+			},
+			{
+				name: "Hair",
+				skip: {
+					// Optional: Define a none value (required if have constraint)
+					allow: true,
+					value: "None",
+					rarity: 50,
+				},
+			},
+			{
+				name: "Clothes",
+			},
+			{
+				name: "Hat",
+				skip: {
+					allow: true,
+					value: "None",
+					rarity: 10,
+				},
+				constraints: {
+					/*linked: { // Optional: Use the layer texture of an other layer by name
+                            layer: "Hair",
+                            textures: [
+                                {
+                                    on: "Redhead",
+                                    with: "Crown",
+                                }
+                            ],
+                    },
+                    with: [ // Optional: Use the layer only if has all parts required
+                        "Hair"
+                    ],
+                    without: [ // Optional: Use the layer only if has all parts not required is none
+                        "Hair"
+                    ],*/
+				},
+			},
+			{
+				name: "Accessory", // Attribute generated on metadata & folder name on assets/layers/
+				skip: {
+					allow: true,
+					value: "None",
+					rarity: 500,
+				},
+			},
+		],
+		crop: {
+			size: 512, // Optional: Resize of Woka in pixels to stick it above background (must be smaller than the background)
+			marging: {
+				// Optional: Add a margin to the woka in pixel
+				left: 64,
+				right: 64,
+				top: 64,
+				bottom: 64,
+			},
+		},
+		rarity: {
+			/**
              * Give a rarity to a part.
              * A table will be displayed after the generation to known how rare a part is.
              *
@@ -81,28 +126,29 @@ const config: Config = {
              *  if a file doesn't have a delimiter, the rarity will be set to 100.
              * none: Don't give a rarity.
              */
-            method: "delimiter",
-            /* random */
-            edges: {
-                // Only on random & optional: Delimit the rarity
-                min: 1, // Min rarity, cannot be under 1
-                max: 100, // Max rarity
-            },
-        },
-        background: {
-            /**
+			method: "delimiter",
+			/* random */
+			edges: {
+				// Only on random & optional: Delimit the rarity
+				min: 1, // Min rarity, cannot be under 1
+				max: 100, // Max rarity
+			},
+		},
+		background: {
+			/**
              * Optional: Method for adding a background (transparent by default)
+             * none: Transparent background.
              * image: Get a random background from the backgrounds folder.
              * linked: Use the background with the same name in the backgrounds folder.
              * color: Use a color.
              */
-            method: "image",
-            /*color: {
+			method: "image",
+			/*color: {
                 hex: "#EACCFF",
                 alpha: 1,
             },*/
-        },
-    },
+		},
+	},
 };
 
 export default config;