CandyMint is a platform for creating and minting NFTs. This repository contains the svg-composite template to help creators building their own assets repository.
- Click
Use this template
to create your own repository - Put images in the
image
directory - Update the
layouts.yaml
file - Connect your repository with your collection created in the CandyMint platform
image
├── graphic # suite
│ ├── 01_circie # layer, should be sequential
│ │ ├── circle_01.svg # item, should be sequential
│ │ ├── circle_02.svg
│ ├── other layers...
├── other suites...
README.md
layouts.yaml
image/<suite>/<layer>/<item>.svg
is the core structure of the SVG Composite template:README.md
is the README file of the repository.layouts.yaml
is the configuration file of the NFT items, see Anatomy for more details.
template: svg_composite # template name, DO NOT change
engine: 0.1.0 # engine version, DO NOT change
config:
mime: image/svg+xml # image mime type
size:
width: 512 # image width
height: 512 # image height
# ... # other properties used internally, DO NOT change
suites:
- name: graphic # suite name, should be unique and same as the directory name
layers:
- name: 01_circle # layer name, should be unique and same as the directory name
items:
- value: circle_01 # trait value of the item, will include in the NFT metadata
image: circle_01.svg # file name of the item
trait_type: circle # trait type, can be arbitrary string, will include in the NFT metadata
display_type: string # display type of the trait, can be string or number, etc.
- value: circle_02
image: circle_02.svg
trait_type: circle
display_type: string
# other items...
# other layers...
# other suites...
Caveats:
- The
image
directory MUST contain only images. - The
layouts.yaml
file MUST be valid YAML. - In order to build a solid collection, the layers and their items MUST be sequential.
- Preserving order in
layouts.yaml
: CandyMint allows managing multiple collection versions. When adding new images and updating thelayouts.yaml
, it's crucial to append new elements at the end. DO NOT rearrange the existing order of backgrounds, layers, or items. This ensure all versions function correctly.
- Add a license
- CandyMint
- CandyMint Testnet
- CandyMint Docs
- PNG Composite Tool
- Discord
- Telegram