Skip to content

NFTGEN is a Node.js command-line tool for generating unique NFTs (Non-Fungible Tokens) using multiple image layers. It supports both static images and animated GIFs, allowing users to create an infinite number of possible combinations. The tool provides options for customizing the collection name, number of layers, image size, and more.

License

Notifications You must be signed in to change notification settings

BankkRoll/NFTGEN-nft-generator

Repository files navigation

NFTGEN - NFT Image and GIF Generator

Completely Free! Supports .GIF , .JPG, .PNG, .JPEG

Overview

NFTGEN is an open-source tool for generating unique NFT images or GIFs, complete with metadata. You can easily customize and configure NFTGEN to suit your needs and generate your own NFTs in just a few simple steps.

Untitled.video.-.Made.with.Clipchamp.mp4

Installation

  1. Star the project so i know to keep making things others find useful.
  2. Download Node.js
  3. Clone the NFTGEN repository from GitHub: git clone https://github.com/BankkRoll/NFTGEN-nft-gif-generator.git
  4. Or download here -> https://github.com/BankkRoll/NFTGEN-nft-gif-generator/archive/refs/heads/main.zip
  5. Install the project dependencies: npm install

Configuration

  1. Update the configuration settings in the config.js file to customize the output of your NFTs.
  2. Here's a brief overview of the configuration settings:
    • traitsFolder: The name of the folder containing the image assets.
    • traitFolders: An array of the subfolders within traitsFolder containing the individual image assets.
    • outputFolder: The name of the folder where the generated NFTs will be saved.
    • layersNumber: The number of image layers to combine in each NFT.
    • numImages: The number of NFTs to generate.
    • startAt: The index number to start generating NFTs at. ex. ( 0 or 1 )
    • collectionName: The name of your NFT collection.
    • collectionDescription: The description for your NFT collection.
    • collectionExternal_url: The external URL for your NFT collection.

Usage

  1. Please complete the Configuration
  2. Generate your NFTs by running the command npm start in your terminal or command prompt.
  3. Choose whether to generate GIFs or Images when prompted.
  4. This will generate the specified number of NFTs and save them to the output folder you specified in the configuration settings.
  5. Decide whether to upload the files to IPFS or retain them locally. If you opt for the former, you'll need to input a thirdweb-provided secret key for API requests. This is stored locally and no information is transmitted, as we execute the thirdweb SDK during the IPFS upload initiation. The files will be subsequently uploaded to IPFS via thirdweb Storage. In case you opt to keep the files locally, they will remain in your local storage.
  6. Your NFTs have been generated and saved to the output folder you specified, and if you chose to upload them to IPFS, they are now available on the given URI.
┌────────────────────────────┐
│ Usage: npm run <command>   │
└────────────────────────────┘
┌──────────────────────┬───────────────────────────────┐
│ Command              │ Description                   │
├──────────────────────┼───────────────────────────────┤
│ start                │ Start the script              │
│ collection-info      │ Print collection information  │
│ help                 │ Prints this screen            │
└──────────────────────┴───────────────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────────────────┐
│ Usage:                                                                                   │
│ 1. Generate your NFTs by running the command "npm start" in your terminal.               │
│ 2. Choose whether to generate GIFs or Images when prompted:                              │
│    > GIFs                                                                                │
│    > Images                                                                              │
│ 3. This will generate the specified number of NFTs and save them to the output folder.   │
│ 4. Choose whether to upload the files to IPFS or keep them on your files local:          │
│    > Yes: Upload the files to IPFS using thirdweb Storage.                               │
│    > No: Keep the files on your local machine.                                           │
└──────────────────────────────────────────────────────────────────────────────────────────┘

Support

If you encounter any issues while using NFTGEN, please feel free to submit an issue on the GitHub repository. We'll do our best to help you resolve the issue as quickly as possible.

Contributing

We welcome contributions to the NFTGEN project! If you'd like to contribute, please fork the repository and submit a pull request with your changes. We'll review your changes and merge them if they meet our project standards.

License

NFTGEN is licensed under the Apache License, Version 2.0. See LICENSE for the full text.

Tip Jar

If you found NFTGEN useful, consider buying me a Red Bull to fuel future development at the following Ethereum wallet address: 0xB26b2f9786090A9f647a90979b48C4Be564D7ff9

About

NFTGEN is a Node.js command-line tool for generating unique NFTs (Non-Fungible Tokens) using multiple image layers. It supports both static images and animated GIFs, allowing users to create an infinite number of possible combinations. The tool provides options for customizing the collection name, number of layers, image size, and more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published