Merge pull request #53 from HashLips/dev

v1.0.6 Update

Author: HashLips

README.md

@@ -101,7 +101,11 @@ const layerConfigurations = [
 ];
 ```
 
-Then optionally, update your `format` size, ie the outputted image size, and the `growEditionSizeTo` on each `layerConfigurations` object, which is the amount of variation outputted.
+Update your `format` size, ie the outputted image size, and the `growEditionSizeTo` on each `layerConfigurations` object, which is the amount of variation outputted.
+
+You can mix up the `layerConfigurations` order on how the images are saved by setting the variable `shuffleLayerConfigurations` in the `config.js` file to true. It is false by default and will save all images in numerical order.
+
+If you want to have logs to debug and see what is happening when you generate images you can set the variable `debugLogs` in the `config.js` file to true. It is false by default, so you will only see general logs.
 
 If you want to play around with different blending modes, you can add a `blend: MODE.colorBurn` field to the layersOrder object. If you need a layers to have a different opacity then you can add the `opacity: 0.7` field to the layersOrder object as well. Both the `blend: MODE.colorBurn` and `opacity: 0.7` can be addes on the same layer if you want to.
 
@@ -157,7 +161,7 @@ const MODE = {
 };
 ```
 
-When you are all ready, run the following command and your outputted art will be in the `build/images` directory and the json in the `build/json` directory:
+When you are ready, run the following command and your outputted art will be in the `build/images` directory and the json in the `build/json` directory:
 
 ```sh
 npm run build
@@ -192,6 +196,20 @@ The program will output all the images in the `build/images` directory along wit
 }
 ```
 
+You can also add extra metadata to each metadata file by adding your extra items, (key: value) pairs to the `extraMetadata` object variable in the `config.js` file.
+
+```js
+const extraMetadata = {
+  creator: "Daniel Eugene Botha",
+};
+```
+
+If you don't need extra metadata, simply leave the object empty. It is empty by default.
+
+```js
+const extraMetadata = {};
+```
+
 That's it, you're done.
 
 ## Utils
@@ -232,14 +250,14 @@ The output will look something like this:
 
 ```sh
 Trait type: Bottom lid
-{ trait: 'High', chance: '20', occurrence: '40' }
-{ trait: 'Low', chance: '40', occurrence: '60' }
-{ trait: 'Middle', chance: '40', occurrence: '0' }
-
-Trait type: Top lid
-{ trait: 'High', chance: '30', occurrence: '20' }
-{ trait: 'Low', chance: '20', occurrence: '40' }
-{ trait: 'Middle', chance: '50', occurrence: '40' }
+{ trait: 'High', chance: '20', occurrence: '15% out of 100%' }
+{ trait: 'Low', chance: '40', occurrence: '40% out of 100%' }
+{ trait: 'Middle', chance: '40', occurrence: '45% out of 100%' }
+
+Trait type: Iris
+{ trait: 'Large', chance: '20', occurrence: '15% out of 100%' }
+{ trait: 'Medium', chance: '20', occurrence: '15% out of 100%' }
+{ trait: 'Small', chance: '60', occurrence: '70% out of 100%' }
 ```
 
 Hope you create some awesome artworks with this code 👄

index.js

@@ -1,4 +1,12 @@
-const { startCreating, buildSetup } = require("./src/main.js");
+"use strict";
+
+const path = require("path");
+const isLocal = typeof process.pkg === "undefined";
+const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
+const { startCreating, buildSetup } = require(path.join(
+  basePath,
+  "/src/main.js"
+));
 
 (() => {
   buildSetup();

package.json

@@ -6,13 +6,10 @@
   "bin": "index.js",
   "pkg": {
     "assets": [
-      "layers/**/*"
-    ],
-    "scripts": [
-      "src/main.js",
-      "src/config.js"
-    ],
-    "outputPath": "dist"
+      "layers/**/*",
+      "node_modules/**/*",
+      "src/**/*"
+    ]
   },
   "scripts": {
     "build": "node index.js",

src/blendMode.js

@@ -1,3 +1,5 @@
+"use strict";
+
 const MODE = {
   sourceOver: "source-over",
   sourceIn: "source-in",

src/config.js

@@ -1,11 +1,16 @@
-const { MODE } = require("./blendMode.js");
+"use strict";
+
+const path = require("path");
+const isLocal = typeof process.pkg === "undefined";
+const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
+const { MODE } = require(path.join(basePath, "src/blendMode.js"));
 const description =
   "This is the description of your NFT project, remember to replace this";
-const baseUri = "ipfs://QmNfPMWLPTEbFpBtPFy4wkYEHRVWcz8dzjziTcPbebzF53";
+const baseUri = "ipfs://NewUriToReplace";
 
 const layerConfigurations = [
   {
-    growEditionSizeTo: 20,
+    growEditionSizeTo: 10,
     layersOrder: [
       { name: "Background" },
       { name: "Eyeball" },
@@ -18,6 +23,10 @@ const layerConfigurations = [
   },
 ];
 
+const shuffleLayerConfigurations = false;
+
+const debugLogs = false;
+
 const format = {
   width: 512,
   height: 512,
@@ -28,17 +37,19 @@ const background = {
   brightness: "80%",
 };
 
+const extraMetadata = {};
+
+const rarityDelimiter = "#";
+
+const uniqueDnaTorrance = 10000;
+
 const preview = {
   thumbPerRow: 5,
   thumbWidth: 50,
   imageRatio: format.width / format.height,
   imageName: "preview.png",
 };
 
-const rarityDelimiter = "#";
-
-const uniqueDnaTorrance = 10000;
-
 module.exports = {
   format,
   baseUri,
@@ -48,4 +59,7 @@ module.exports = {
   layerConfigurations,
   rarityDelimiter,
   preview,
+  shuffleLayerConfigurations,
+  debugLogs,
+  extraMetadata,
 };

src/main.js

@@ -1,11 +1,17 @@
-const fs = require("fs");
+"use strict";
+
 const path = require("path");
-const sha1 = require("sha1");
-const { createCanvas, loadImage } = require("canvas");
 const isLocal = typeof process.pkg === "undefined";
 const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
-const buildDir = `${basePath}/build`;
-const layersDir = `${basePath}/layers`;
+const fs = require("fs");
+const sha1 = require(path.join(basePath, "/node_modules/sha1"));
+const { createCanvas, loadImage } = require(path.join(
+  basePath,
+  "/node_modules/canvas"
+));
+const buildDir = path.join(basePath, "/build");
+const layersDir = path.join(basePath, "/layers");
+console.log(path.join(basePath, "/src/config.js"));
 const {
   format,
   baseUri,
@@ -14,8 +20,10 @@ const {
   uniqueDnaTorrance,
   layerConfigurations,
   rarityDelimiter,
+  shuffleLayerConfigurations,
+  debugLogs,
+  extraMetadata,
 } = require(path.join(basePath, "/src/config.js"));
-const console = require("console");
 const canvas = createCanvas(format.width, format.height);
 const ctx = canvas.getContext("2d");
 var metadataList = [];
@@ -27,8 +35,8 @@ const buildSetup = () => {
     fs.rmdirSync(buildDir, { recursive: true });
   }
   fs.mkdirSync(buildDir);
-  fs.mkdirSync(`${buildDir}/json`);
-  fs.mkdirSync(`${buildDir}/images`);
+  fs.mkdirSync(path.join(buildDir, "/json"));
+  fs.mkdirSync(path.join(buildDir, "/images"));
 };
 
 const getRarityWeight = (_str) => {
@@ -107,6 +115,7 @@ const addMetadata = (_dna, _edition) => {
     image: `${baseUri}/${_edition}.png`,
     edition: _edition,
     date: dateTime,
+    ...extraMetadata,
     attributes: attributesList,
     compiler: "HashLips Art Engine",
   };
@@ -183,20 +192,50 @@ const writeMetaData = (_data) => {
 };
 
 const saveMetaDataSingleFile = (_editionCount) => {
+  let metadata = metadataList.find((meta) => meta.edition == _editionCount);
+  debugLogs
+    ? console.log(
+        `Writing metadata for ${_editionCount}: ${JSON.stringify(metadata)}`
+      )
+    : null;
   fs.writeFileSync(
     `${buildDir}/json/${_editionCount}.json`,
-    JSON.stringify(
-      metadataList.find((meta) => meta.edition == _editionCount),
-      null,
-      2
-    )
+    JSON.stringify(metadata, null, 2)
   );
 };
 
+function shuffle(array) {
+  let currentIndex = array.length,
+    randomIndex;
+  while (currentIndex != 0) {
+    randomIndex = Math.floor(Math.random() * currentIndex);
+    currentIndex--;
+    [array[currentIndex], array[randomIndex]] = [
+      array[randomIndex],
+      array[currentIndex],
+    ];
+  }
+  return array;
+}
+
 const startCreating = async () => {
   let layerConfigIndex = 0;
   let editionCount = 1;
   let failedCount = 0;
+  let abstractedIndexes = [];
+  for (
+    let i = 1;
+    i <= layerConfigurations[layerConfigurations.length - 1].growEditionSizeTo;
+    i++
+  ) {
+    abstractedIndexes.push(i);
+  }
+  if (shuffleLayerConfigurations) {
+    abstractedIndexes = shuffle(abstractedIndexes);
+  }
+  debugLogs
+    ? console.log("Editions left to create: ", abstractedIndexes)
+    : null;
   while (layerConfigIndex < layerConfigurations.length) {
     const layers = layersSetup(
       layerConfigurations[layerConfigIndex].layersOrder
@@ -214,24 +253,29 @@ const startCreating = async () => {
         });
 
         await Promise.all(loadedElements).then((renderObjectArray) => {
+          debugLogs ? console.log("Clearing casvas") : null;
           ctx.clearRect(0, 0, format.width, format.height);
           if (background.generate) {
             drawBackground();
           }
           renderObjectArray.forEach((renderObject) => {
             drawElement(renderObject);
           });
-          saveImage(editionCount);
-          addMetadata(newDna, editionCount);
-          saveMetaDataSingleFile(editionCount);
+          debugLogs
+            ? console.log("Editions left to create: ", abstractedIndexes)
+            : null;
+          saveImage(abstractedIndexes[0]);
+          addMetadata(newDna, abstractedIndexes[0]);
+          saveMetaDataSingleFile(abstractedIndexes[0]);
           console.log(
-            `Created edition: ${editionCount}, with DNA: ${sha1(
+            `Created edition: ${abstractedIndexes[0]}, with DNA: ${sha1(
               newDna.join("")
             )}`
           );
         });
         dnaList.push(newDna);
         editionCount++;
+        abstractedIndexes.shift();
       } else {
         console.log("DNA exists!");
         failedCount++;

utils/createPreviewCollage.js

@@ -1,13 +1,14 @@
 "use strict";
 
+const isLocal = typeof process.pkg === "undefined";
+const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
 const fs = require("fs");
 const path = require("path");
 const { createCanvas, loadImage } = require("canvas");
-const isLocal = typeof process.pkg === "undefined";
-const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
 const buildDir = `${basePath}/build`;
 
-const { preview } = require("../src/config.js");
+console.log(path.join(basePath, "/src/config.js"));
+const { preview } = require(path.join(basePath, "/src/config.js"));
 
 // read json data
 const rawdata = fs.readFileSync(`${basePath}/build/json/_metadata.json`);

utils/rarityData.js

@@ -1,12 +1,13 @@
 "use strict";
 
-const fs = require("fs");
 const path = require("path");
 const isLocal = typeof process.pkg === "undefined";
 const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
+const fs = require("fs");
 const layersDir = `${basePath}/layers`;
 
-const { layerConfigurations } = require("../src/config.js");
+console.log(path.join(basePath, "/src/config.js"));
+const { layerConfigurations } = require(path.join(basePath, "/src/config.js"));
 
 const { getElements } = require("../src/main.js");
 
@@ -70,7 +71,7 @@ for (var layer in rarityData) {
 
     // show two decimal places in percent
     rarityData[layer][attribute].occurrence =
-      rarityData[layer][attribute].occurrence.toFixed(0);
+      rarityData[layer][attribute].occurrence.toFixed(0) + "% out of 100%";
   }
 }
 

utils/regenerateMetadata.js

@@ -1,9 +1,9 @@
 "use strict";
 
-const fs = require("fs");
-const path = require("path");
 const isLocal = typeof process.pkg === "undefined";
 const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
+const fs = require("fs");
+const path = require("path");
 const jsonDir = `${basePath}/build/json`;
 const metadataFilePath = `${basePath}/build/json/_metadata.json`;
 

utils/updateBaseUri.js

@@ -1,11 +1,12 @@
 "use strict";
 
-const fs = require("fs");
 const path = require("path");
 const isLocal = typeof process.pkg === "undefined";
 const basePath = isLocal ? process.cwd() : path.dirname(process.execPath);
+const fs = require("fs");
 
-const { baseUri } = require("../src/config.js");
+console.log(path.join(basePath, "/src/config.js"));
+const { baseUri } = require(path.join(basePath, "/src/config.js"));
 
 // read json data
 let rawdata = fs.readFileSync(`${basePath}/build/json/_metadata.json`);