Merge pull request #8 from HashLips/dev

Windows delimiter fix

Author: HashLips

README.md

@@ -1,55 +1,139 @@
-# Welcome to HashLips
+# Welcome to HashLips 👄
+
+![](https://github.com/HashLips/hashlips_art_engine/blob/main/logo.png)
 
 All the code in these repos was created and explained by HashLips on the main YouTube channel.
 
 To find out more please visit:
 
-[HashLips YouTube](https://www.youtube.com/channel/UC1LV4_VQGBJHTJjEWUmy8nA)
+[📺 YouTube](https://www.youtube.com/channel/UC1LV4_VQGBJHTJjEWUmy8nA)
+
+[💬 Telegram](https://t.me/hashlipsnft)
 
-[HashLips Telegram](https://t.me/hashlipsnft)
+[🐦 Twitter](https://twitter.com/hashlipsnft)
 
-[HashLips Twitter](https://twitter.com/hashlipsnft)
+[ℹ️ Website](https://hashlips.online/HashLips)
 
-[HashLips Website](https://hashlips.online/HashLips)
+# HashLips Art Engine 🔥
 
-# HashLips Art Engine
+![](https://github.com/HashLips/hashlips_art_engine/blob/main/banner.png)
 
 Create generative art by using the canvas api and node js. Before you use the generation engine, make sure you have node.js and yarn installed.
 
-## Installation
+## Installation 🛠️
+
+If you are cloning the project then run this first, otherwise you can download the source code on the release page and skip this step.
 
 ```sh
 git clone https://github.com/HashLips/hashlips_art_engine.git
+```
+
+Go to the root of your folder and run this command if you have yarn installed.
 
+```sh
 yarn add all
 ```
 
-## Usage
+Alternatively you can run this command if you have node installed.
 
-Create your different layers as folders in the 'layers' directory, and add all the layer assets in these directories. You can name the assets anything as long as it has a rarity weight attached in the file name like so: `example element*70.png`
+```sh
+npm install
+```
+
+## Usage ℹ️
 
-Once you have all your layers, go into `src/config.js` and update the `layersOrder` array to be your layer folders name in order of the back layer to the front layer.
+Create your different layers as folders in the 'layers' directory, and add all the layer assets in these directories. You can name the assets anything as long as it has a rarity weight attached in the file name like so: `example element#70.png`. You can optionally change the delimiter `#` to anything you would like to use in the variable `rarityDelimiter` in the `src/config.js` file.
 
-*Example:* If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear, so your `layersOrder` would look something like this:
+Once you have all your layers, go into `src/config.js` and update the `layerConfigurations` objects `layersOrder` array to be your layer folders name in order of the back layer to the front layer.
+
+_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear, so your `layersOrder` would look something like this:
 
 ```js
-const layersOrder = [
-    { name: 'Background'},
-    { name: 'Ball'},
-    { name: 'Eye color' },
-    { name: 'Iris' },
-    { name: 'Shine' },
-    { name: 'Bottom lid' },
-    { name: 'Top lid' },
+const layerConfigurations = [
+  {
+    growEditionSizeTo: 100,
+    layersOrder: [
+      { name: "Head" },
+      { name: "Mouth" },
+      { name: "Eyes" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+    ],
+  },
 ];
 ```
 
-The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in. 
+The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in.
+
+Optionally you can now add multiple different `layerConfigurations` to your collection. Each configuration can be unique and have different layer orders, use the same layers or introduce new ones. This gives the artist flexibility when it comes to fine tuning their collections to their needs.
 
-Then optionally, update your `format` size, ie the outputted image size, and the `editionSize`, which is the amount of variation outputted.
+_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear and you want to create a new race or just simple re-order the layers or even introduce new layers, then you're `layerConfigurations` and `layersOrder` would look something like this:
+
+```js
+const layerConfigurations = [
+  {
+    // Creates up to 50 artworks
+    growEditionSizeTo: 50,
+    layersOrder: [
+      { name: "Background" },
+      { name: "Head" },
+      { name: "Mouth" },
+      { name: "Eyes" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+    ],
+  },
+  {
+    // Creates an additional 100 artworks
+    growEditionSizeTo: 150,
+    layersOrder: [
+      { name: "Background" },
+      { name: "Head" },
+      { name: "Eyes" },
+      { name: "Mouth" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+      { name: "AlienHeadwear" },
+    ],
+  },
+];
+```
+
+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.
 
 When you are all ready, run the following command and your outputted art will be in the `build` directory:
 
 ```sh
 npm run build
 ```
+
+or
+
+```sh
+node index.js
+```
+
+The program will output all the images in the `build` directory along with the metadata files. Each collection will have a `_metadata.json` file that consists of all the metadata in the collection inside the `build` folder. The `build` folder also will contain all the images as well as single json files that represent each image file. The single json file of a image will look something like this:
+
+```json
+{
+  "dna": "d956cdf4e460508b5ff90c21974124f68d6edc34",
+  "name": "#1",
+  "description": "This is the description of your NFT project",
+  "image": "https://hashlips/nft/1.png",
+  "edition": 1,
+  "date": 1731990799975,
+  "attributes": [
+    { "trait_type": "Background", "value": "Black" },
+    { "trait_type": "Eyeball", "value": "Red" },
+    { "trait_type": "Eye color", "value": "Yellow" },
+    { "trait_type": "Iris", "value": "Small" },
+    { "trait_type": "Shine", "value": "Shapes" },
+    { "trait_type": "Bottom lid", "value": "Low" },
+    { "trait_type": "Top lid", "value": "Middle" }
+  ],
+  "compiler": "HashLips Art Engine"
+}
+```
+
+That's it, you're done. Hope you create some awesome artworks with this code 👄.