Skip to content

A tool to generate a randomized 2D-image NFT collection based on nft attribute layers

License

Notifications You must be signed in to change notification settings

nanolaboratory/nft-toolkit

Repository files navigation

nft-toolkit

Build Status PyPI version Code style: black contributions welcome

A tool to generate a randomized 2D-image NFT collection based on nft attribute layers

About

nft-toolkit is a general purpose nft library to make generating thousands of nft's really easy

Made by Nano Labs in 2021

Installation

PIP

pip install nft-toolkit

Documentation

To view documentation, after pip installation run the following commands in a python3 interactive shell.

from nft.image import RandomImageGenerator
help(RandomImageGenerator)

Examples

Generate 100 Images:

Steps

  1. Create a directory of attributes that you would like to layer on top of each other. Each attribute must be of the same image size so that the overlays will line up properly.

  2. Create a script similar to below. RandomImageGenerator uses 3 parameters: Number of permutations to generate, filepath to attributes, and filepath to place the images generated.

from nft.image import RandomImageGenerator
nft_collection = RandomImageGenerator(100, "./my-nft-project/nft_images", "./my-nft-project/collection")

nft_collection.generate_collection()
  1. Your collection should be generated with each image's filename describing the attributes that are used.

Contribute

Issues and pull requests are welcome. If you add functionality, then please add unit tests to cover it. Continuous Integration is handled by CircleCI.

About

A tool to generate a randomized 2D-image NFT collection based on nft attribute layers

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published