Default template for CandyMint

CandyMint is a platform for creating and minting NFTs. This repository contains the default template to help creators build their own asset repository.

Usage

1. Click Use this template to create your own repository
2. Upload images in the image directory
3. Update the layouts.yaml file
4. Connect your repository with your collection created in the CandyMint platform

Template Structure

image
├── item1.png
├── item2.png
├── ...
README.md
layouts.yaml

• image contains the images of the NFT items.
• README.md is the README file of the repository.
• layouts.yaml is the configuration file of the NFT items.

Anatomy

template: default             # template name, DO NOT change
engine: 0.1.0                 # engine version, DO NOT change
config:
  mime: image/png             # image mime type
  size:
    width: 64                 # image width
    height: 64                # image height
    # ...                     # other properties used internally, DO NOT change
items:
  - token_id: 1               # token id, should be unique and sequential
    image_uri: 'item_01.png'   # file name of the item, relative to the image directory
    token_trait:              # token traits
      - trait_type: letter
        display_type: string
        value: a
      # other traits...
  # other items...

Caveats:

• The image directory MUST contain only images.
• The layouts.yaml file MUST be valid YAML.
• Since the CandyMint platform supports multiple versions, when you adding new images and updating the layouts.yaml, DO NOT change existing token_id or the order of items.
• To enable on-chain storage, make sure your image file is no larger than 50KB.

TODO

• Add a license

Other Templates

• Default Template
• SVG Composite Template
• PNG Composite Template

Relative Links

• CandyMint
• CandyMint Testnet
• CandyMint Docs
• PNG Composite Tool
• Discord
• Twitter
• Telegram