{"id":13767099,"url":"https://github.com/alephao/nftool","last_synced_at":"2025-04-22T20:32:01.835Z","repository":{"id":40239543,"uuid":"403986539","full_name":"alephao/nftool","owner":"alephao","description":"A suite of tools for NFT generative art.","archived":false,"fork":false,"pushed_at":"2022-10-21T19:04:21.000Z","size":218,"stargazers_count":155,"open_issues_count":2,"forks_count":29,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-16T13:55:22.370Z","etag":null,"topics":["generative-art","hacktoberfest","ipfs","nft","opensea","pfp","profile-picture"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alephao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-07T13:21:23.000Z","updated_at":"2025-03-08T16:30:29.000Z","dependencies_parsed_at":"2023-01-19T18:47:22.164Z","dependency_job_id":null,"html_url":"https://github.com/alephao/nftool","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fnftool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fnftool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fnftool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fnftool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alephao","download_url":"https://codeload.github.com/alephao/nftool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250318821,"owners_count":21410995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generative-art","hacktoberfest","ipfs","nft","opensea","pfp","profile-picture"],"created_at":"2024-08-03T16:01:04.604Z","updated_at":"2025-04-22T20:32:01.421Z","avatar_url":"https://github.com/alephao.png","language":"Go","funding_links":[],"categories":["Resources, frameworks, blockchain orchestration, testing, and command line interface.","Go"],"sub_categories":["**Podcast Episodes**"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" height=\"200\" /\u003e\n\u003c/p\u003e\n\n# nftool\n[![Tests](https://github.com/alephao/nftool/actions/workflows/test.yml/badge.svg)](https://github.com/alephao/nftool/actions/workflows/test.yml)\n\nA suite of tools for NFT generative art.\n\n## Features\n\n* Metadata\n   * Generate ERC-721 and ERC-1155 compatible metadata\n* Traits/Attributes/Properties Generation\n   * Configure custom rarity\n   * Generate collection attributes configuration file\n   * Merge collections\n   * Shuffle collection\n   * Find collisions between collections\n* Image Generation\n   * Generate images from collection description\n   * Generate images in parallel\n   * Generate only missing images (if you delete a few images from the output folder)\n* Rarity\n   * Generate traits rarity\n   * Generate collection rarity\n* Provenance\n   * Generate provenance\n* OpenSea\n   * Update metadata of collection\n\n## Install\n\n### Homebrew on Macos\n\n`brew install alephao/formulae/nftool`\n\n### Using Go\n\n`go install github.com/alephao/nftool@latest`\n\nOr clone the repository, change to the root folder and run `go install`.\n\n### Manually\n\nDownload the binary from the [releases page](https://github.com/alephao/nftool/releases) and move it to your bin path like `/usr/local/bin`.\n\n## Getting Started\n\nTo get started, install `nftool` following the instructions above and cd to the examples folder in this repo.\n\nYou can always use `nftool help [command]` to see all the documentatio and all the options of a command.\n\nFirst generate the configuration file from the layers folders.\n\n```sh\nmkdir -p out\nnftool traits dump --layers ./layers --out ./out/config.yaml\n```\n\nYou can open `config.yaml` and play around with the rarity weights, and optional configuration.\n\nThen generate a collection from the `config.yaml`\n\n```sh\nnftool traits make --amount 10 --config ./out/config.yaml --out ./out/collection.json\n```\n\nNow we can use the collection.json to generate the images. Run the following commands:\n\n```sh\nmkdir -p ./out/images\nnftool img gen --width 300 --height 300 --collection ./out/collection.json --config ./out/config.yaml --out ./out/images\n```\n\nWe can also generate rarity reports for traits (which trait is more rare and how many times it shows up) and the collection rarity rank.\n\n```sh\n# Generate traits rarity report\nnftool rarity traits --collection ./out/collection.json --out ./out/traits_rarity.json\n\n# Generate collection rarity rank report\nnftool rarity collection --collection ./out/collection.json --out ./out/collection_rarity.json\n```\n\nTo generate the provenance for this collection it's easy:\n\n```sh\nnftool provenance --images ./out/images --out ./out/provenance.json --startingIndex 2\n```\n\nNote: the startingIndex should be a number smaller than the total amount of items in the collection and it's usually generated on-chain.\n\nNow we need to generate the actual metadata that we'll upload to IPFS (or another storage service).\n\n```\n\tmkdir -p ./out/metadata\n\t# Generate ERC-721 metadata\n\tnftool metadata --collection ./out/collection.json --config ./out/config.yaml --out ./out/metadata\n```\n\nNote: if you want to generate the metadata following the erc-1155 convention for the id/file-name, add the flag --erc1155\n\nCheck out the output in `./out/metadata/1`. If you want to change anything, you can do so by editing the values in `./out/config.yaml`.\n\n## Documentation\n\n[Link to the generated docs](./docs/docs.md)\n\n## Contributing\n\n* For requests and questions, please open an issue.\n* PRs accepted.\n\n## Releasing\n\nTo release a new version\n\n```\ngit tag vx.x.x\ngit push origin vx.x.x\ngoreleaser release --rm-dist  \n```\n\n## License\n\n[MIT © Aleph Retamal](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falephao%2Fnftool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falephao%2Fnftool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falephao%2Fnftool/lists"}