cartel

README

Cartel Bot

The Cartel Bot is an instantiation of the NFT Stamper designed to support Mutant Cartel/Novel Lab collections

Installation

Standard go installation

$ go get github.com/avislash/nftstamper@latest

The bot currently assumes acess to a locally running IPFS node for any IPFS retrievals it may need to perform.

Refer to the instructions found in the Kubo IPFS repository for how to download, install, and configure a local IPFS node.

Configuration

The Bot Configuration is driven through the config.yaml file.

The ipfs_endpoint is the endpoint to an IPFS node that can be used to retrive files off IPFS. The endpoint format must be in multiaddr format.

• Note: While any available IPFS endpoint can be specified for better performance consider hosting and running a local IPFS node. Refer to the instructions found in the Kubo IPFS repository for how to download, install, and configure a local IPFS node.

The metadata_endpoint is the primary web endpoint for scraping metadata against.

The image_procesor section is for configuring the image processor and defining mappings of characteristics to overlay images.

• The gm_mappings section is used to map Hound Background Traits to overlay images. These mappings directly impact the output of the /gm command

Usage & Examples

Before running the bot ensure that the CARTEL_DISCORD_BOT environemnt variable is set.

To run the bot use

./nftstamper cartelbot

This will instantiate the NFT Stamper to use mappings for The Mutant Cartel for its image processing and other commands.

Supported Collections

• The Mutant Cartel
  • Mutant Hounds
    • Mega Hound Support Pending

How do I get a collection integrated

You may add the collection yourself by either

1. Cloning the repo and modifying the source code and/or artwork
2. Contacting me using one of the options listed in the Contact Me section
3. Opening an issue via the Github Issue Tracker

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgements

• Line Hammett
  • Thank you for the amazing Mutant Hound bowl artwork you designed and contributed. Please checkout her otherwork here
• The Best Online README Generator

Contact Me

TODO

1. Scrape MH Metadata endpoint per token from The Mutant Hounds smart contract
2. Update IPFS client to parse Files/Metadata + Images
3. Update Metadata Fetcher to fetch from either IPFS and/or Web Endpoint
4. Consider refactoring and abstracting bot to lib