starkillercrypto/nft-art-maker

NFT Art Maker - generates a randomized set of images or encoded SVGs from provided PNG layers

NFT art maker v4.0

The tool generates a randomized set of images or encoded SVGs from provided PNG layers.

Please test it before using it for the real stuff. It can always be buggy.

Older versions (check changelog):

• v3 Video for v3.0
• v2 Video for v2.0
• v1 Video for v1.0

Based on:

• HashLips art engine - only main functionality (output metadata.json is not standarized in any way)
• Pixels to SVG - SVG code from images
• SVGO - SVG optimization and base64 data uri generation
• ipfs-car - optionally for handling ipfs .car archives

This lib is a customized and simplified version of the HashLips art engine. If you need more options and functionality, please use HashLips.

How to use it:

• minimum version of Node is 14.14.0 it doesn't work on v17 yet
• create a project directory -> mkdir my-nft-collection ; cd my-nft-collection
• in that directory, create the layers directory with all of your layers split into proper directories
• create a configuration file .nftartmakerrc (other file names also allowed, check out cosmiconfig for more info). This file should be a JSON formatted config file. You'll find all configuration options below.
• run npx nft-art-maker generate - it will generate all files or encoded SVG with metadata json file for each, plus it will generate one big metadata file with all editions and provenance hash. Additionally, there is also an option to pack all images into an ipfs car file.

You can always install it globally by npm install nft-art-maker -g and then use it like nft-art-maker generate.

Updating: when using npx, make sure that it takes the new version. You can always install it globally using npm install nft-art-maker@latest -g.

Additionally you can:

• generate a preview - run npx nft-art-maker preview
• you can also pack files using npx nft-art-maker pack - this will pack all files using ipfs-car into one images.car and metadata.car files, which you can upload using services like nft.storage

Basically, the tool offers two different outputs:

1. png and metadata files packed into the ipfs .car files. Base image CID will be updated in all metadata files automatically after running nft-art-maker pack and base CID for metadata files will be added to the summary metadata json file.
2. (experimental) all data with encoded svgs in one big metadata.json file, without any additional files. This will be useful when you want to have non-standard on-chain only nfts. Be aware that the SVG output can be buggy on very complicated and big images. This experimental option is for small simple images, like pixel art etc.

nft-art-maker tool doesn't assume any way of uploading to ipfs, but I would recommend nft.storage where you can upload whole .car file. They offer free pinning service and Filecoin storage. So even if you delete it there or nft.storage stops working for some reason, the data will persist. Of course, learn about it first. They have a friendly UI, but you can also use the CLI tool for that.

Configuration options

You should use the config file at least for layers configuration. But there are also other configuration options. Whole config example (of course remove comments when copying):

{
  "description": "Your collection name",
  "svgBase64DataOnly": true,
  "layerConfigurations": [
    // 100 artworks
    {
      "growEditionSizeTo": 100,
      "layersOrder": [{ "name": "face" }, { "name": "head" }, { "name": "eyes" }]
    },
    // additional 10 artworks with pinky face
    {
      "growEditionSizeTo": 110,
      "layersOrder": [{ "name": "pinkyFace" }, { "name": "head" }, { "name": "eyes" }]
    }
  ],
  "shuffleLayerConfigurations": false,
  "format": {
    "width": 20,
    "height": 20
  },
  "rarityDelimiter": "#",
  "uniqueDnaTorrance": 10000,
  "layersDirName": "layers",
  "outputDirName": "output",
  "outputJsonDirName": "json",
  "outputImagesDirName": "images",
  "outputJsonFileName": "metadata.json",
  "outputImagesCarFileName": "images.car",
  "outputMetadataCarFileName": "metadata.car",
  "editionNameFormat": "#",
  "tags": "tag1,tag2,tag3",
  "preview": {
    "thumbPerRow": 20,
    "thumbWidth": 60,
    "imageRatio": 1,
    "imageName": "preview.png"
  },
}

layers configuration

Every subdirectory in your layers directory should be named after the type of the layer, and inside, you should put your png files. The name structure should be as follows: filename1#100.png, where the #100 is a rarity level from 0 to 100.

shuffleLayerConfigurations

Disabled by default, but you can always enable it to shuffle items from different layerConfigurations.

Output type configuration

You can decide if you want to have encoded SVGs or standard PNGs files. Use svgBase64DataOnly setting.

The example of output metadata.json file structure with empty values (this is one big file with all editions):

{
  "editions": [
    {
      "name": "",
      "description": "",
      "properties": {
        "edition": 0,
        "attributes": [
          {
            "trait_type": "",
            "value": ""
          }
        ],
        "base64SvgDataUri": "",
      },
      "image": {
        "href": "",
        "hash": "",
        "ipfsUri": "",
        "ipfsCid": "",
        "fileName": ""
      }
    }
  ],
  "provenanceHash": "",
  "metadataFilesIpfsBaseCid": ""
}

Layers directory structure (example)

Here is an example of the layers directory structure with the configuration from the example above.

layers/
├── eyes
│   ├── eyes1#100.png
│   ├── eyes2#100.png
│   ├── eyes3#100.png
│   ├── eyes4#100.png
│   ├── eyes5#100.png
│   └── eyes6#100.png
├── face
│   ├── face1#100.png
│   ├── face2#100.png
│   ├── face3#100.png
│   ├── face4#100.png
│   └── face5#100.png
└── head
    ├── head1#100.png
    ├── head2#100.png
    ├── head3#100.png
    ├── head4#100.png
    ├── head5#100.png
    ├── head6#100.png
    ├── head7#100.png
    └── head8#100.png

License

MIT

Contact

• Twitter
• WWW