nftgen #

NFT unqiue image generator and metadata analyzer. It can be used as a Dart library or from the command line.

This is work in progress. At the moment, it cannot be used by Flutter Web.

Generate NFTs follows these procedure:

1. Generate config-file based on layers directory
2. Manually: Adjust probabilities in config-file
3. Generate NFT metadata files
4. Analyse rarity distribution, backtrace to 2.
5. Generate NFT images
6. Manually: Upload NFT images and get a CID
7. Update all metadata files with CID
8. Manually: Upload metadata files

Which boils down to these commands:

1. nftgen config ...
2. ( ... )
3. nftgen meta ...
4. nftgen rarity ...
5. nftgen nft ...
6. ( ... )
7. nftgen cid ...
8. ( ... )

TODO #

• Automatic setting of weights and probabilities for nice NFT distribution.
• Implement proper command line invocation.
• Add proper unit tests
• ...

Quickstart #

Project Structure

A project.json file and the existing layer-directories are required to create a specific config-file organizing the layers and their weights.

A working example is available on Github.

// required directory structure and files

./project/project.json
./project/layer/layer1/fileA.png
./project/layer/layer2/fileB.png
  (...)

// ./project/project.json

{
    "configName": "Your NFT name",
    "configWeightsFactor": 3.0,
    "configLayersOrder": [
        "Background",
        "Eyeball",
        "Eye color",
        "Iris",
        "Shine",
        "Bottom lid",
        "Top lid"
    ],
    "configFile": "config_gen.json",
    "layerDir": "layer",
    "metaDir": "meta",
    "imageDir": "image",
    "rarityNftCsv": "rarity_nft.csv",
    "rarityNftPng": "rarity_nft.png",
    "rarityLayersCsv": "rarity_layers.csv",
    "rarityLayersPng": "rarity_layers.png"
}

Generate NFTs and metadata

From outside the ./project/ folder run these commands in sequence:

dart pub global activate nftgen

nftgen config   // generates config-file based on project.json and layers
nftgen meta     // generates metadata for each NFT
nftgen rarity   // generates rarity CSV  based on metadata
nftgen nft      // generates images for each NFT based on metadata
nftgen cid CID  // updates all metadata with new CID

Generated config_gen.json #

Running nftgen config will generate the file ./project/config_gen.json.

1. The layer's sequence determines the NFT rendering.
2. Adjust the weights of individual layers and weights to your needs.
3. Update the CID of all metadata files by running nftgen cid YOUR-CID. The cidCode in ./project/config_gen.json represents the current CID and is needed for updating the metadata. No need to adjust that manually.

// config_gen.json

{
  // How many NFTs to generate.
  // Defaults to 0.6 * all-combinations-equal-weights to avoid
  /// rendering slowing down when reaching all-combinations-equal-weights
  /// number. 
  "generateNfts": 250, 
  // Run "nftgen cid" to update the metadata files.
  "cidCode": "your CID code", 
  // The order of layer entries matters.
  "layers": [ 
    {
      // Shown in generated metadata JSON.
      "name": "Eyeball",  
      // Your local directory.
      "directory": "Eyeball",
      // Probability: 0.0...1.0 
      // Which euqals: = 0...100% 
      "probability": 1.0, 
      // Sum of all weights is 17
      "weights": {
        // Probability: 1 / 17
        "Red.png": 1, 
        // Probability: 16 / 17
        "White.png": 16 
      }
    },
    
    ( ... more layers ...)

}

Notes

1. The probability of the rare layers can be set to e.g. 0.05, 0.1, 0.25 etc.
2. The larger the NFTs collection, the steeper the weights within each layer have to be. This can be achived setting the exponential factors to 2.0, 3.0, 4.0 etc. Possible numeric sequences are:

 x*2 1,4,9,16,...
 x^3 1,8,27,64,125,216,343,512
 x^4 1, 16, 81, 256, 625, 1296, 2401, 4096

How to Use #

Library #

Please refer to the API for details, some functions have additonal parameters.

final sep = Platform.pathSeparator;
final project = Directory('project');
// For CONFIG and NFT
final layerDir = Directory('${project.path}${sep}layer');
final imageDir = Directory('${project.path}${sep}image');
final metaDir = Directory('${project.path}${sep}meta');
// To ANALYZE NFT
final csvNft = File('${project.path}${sep}rarity_nft.csv');
final csvLayers = File('${project.path}${sep}rarity_layers.csv');

// Write config JSON based on layers directory

final Map<String, dynamic> config =
    Config.generate('Your NFT', layerDir, factor: 3);
final configFile = File('${project.path}${sep}config_gen.json');
Io.writeJson(configFile, config);

// Generate metadata based on config JSON

Nft.generateMeta(configFile, metaDir);

// Generate NFTs based on config JSON

await Nft.generateNft(configFile, layerDir, imageDir, metaDir);

// Analyze generated NFT metadata and save it

final nftAnalysis = Rarity.nfts(metaDir);
final layersAnalysis = Rarity.layers(metaDir);
Io.writeCsv(nftAnalysis, csvNft);
Io.writeCsv(layersAnalysis, csvLayers);

// Update metadata json with CID code given in config

Config.updateCidMetadata(configFile, metaDir,
    cidSearch: "<-- Your CID Code-->", cidReplace: "NEW-CID");

Command Line #

• Activate shell command: dart pub global activate nftgen

• Deactivate shell command: dart pub global deactivate nftgen

Command line invocations accept an optional parameter specifying the project-directory:

• Runs in ./project/: nftgen config

• Runs in ./differentFolder/: nftgen differentFolder config

All commands available:

* Generate a config-json file basd on ./project/project.json:

nftgen [<PROJECT-DIR>] config 

* Generate metadata based on ./project/project.json:

nftgen nft [<PROJECT-DIR>] meta 

* Generate NFTs based on ./project/project.json and ./project/meta/<metadata.json>:

nftgen [<PROJECT-DIR>] nft 

* Add CID code to metadata from ./project/project.json or command line parameter:

nftgen [<PROJECT-DIR>] cid <CID>

* Generate rarity reports basd on ./project/project.json and ./project/meta/<metadata.json>:

nftgen [<PROJECT-DIR>] rarity 

References #

The example layers are from Hashlips (MIT livense):

https://github.com/HashLips/hashlips_art_engine

License #

MIT