Contents

• Contents
• About The Project
• Getting Started
• Roadmap
• Contributing
• License
• Contact

About The Project

Continuum Avatars is an open-source avatar generator inspired by the robohash project, designed to provide diverse, customizable avatars for various applications. We offer a range of features, including personalization, scalability, and easy integration. Our community-driven project welcomes contributors from around the world, making it a versatile and evolving tool for creating unique avatars. Join us to explore the possibilities of Continuum Avatars and unleash your creativity.

Getting Started

Getting Started with Continuum Avatars

Creating unique avatars with Continuum Avatars is a simple process, and you can easily integrate it into your Node.js projects using our package, "@continuum-ai/avatars". Here's how to get started:

1. Install the Package:

   Begin by installing the "@continuum-ai/avatars" package into your Node.js project. You can do this using npm or yarn:

   npm install @continuum-ai/avatars
   # or
   bun add @continuum-ai/avatars

   Make sure that sharp is installed, if it isn't you'll get a warning and will have to execute a command similar to this one:

   npm install --platform=linux --arch=x64 sharp

2. Import the Module:

   In your application, import the Continuum Avatars module:

   import { Avatar, AvatarType, BackgroundType } from "@continuum-ai/avatars"

3. Generate an Avatar:

   Now, you can use the module to generate avatars with ease. Simply call the assemble method, providing customization options as parameters. Here's a basic example:

   const avatar = Avatar.assemble("[email protected]", AvatarType.Robot, BackgroundType.Landscape);

4. Use the Avatar:

   You can use the generated avatar in your application as needed. This could involve displaying it in user profiles, chat applications, or any other context where avatars are required.

    // Convert the "sharp" object to a buffer
    const buffer = await avatar.toBuffer();
   
    fs.writeFileSync("./avatar.png", buffer);

5. Explore Advanced Customization:

   Continuum Avatars offers advanced customization options beyond the basic example provided here. Check out our documentation for in-depth guidance on creating avatars that match your project's requirements.

Join the Continuum Avatars Community:

We invite you to join our community of developers and enthusiasts. Share your avatar creations, seek assistance, and contribute to the project's development on our GitHub repository. We value your input and creativity!

Roadmap

• [ ] Advanced customization (de-selecting layers)
• [ ] Output shape customization
• [ ] Additional Character-sets
  • [ ] Semi-Realistic Humans
  • [ ] Drawings
  • [ ] Modern 2.5D Illustrations

See the open issues for a full list of proposed features (and known issues).

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Moritz Utcke - [email protected]

Project Link: https://github.com/Continuum-AI-Inc/continuum-avatars