{"id":26105770,"url":"https://github.com/muhammadsaim/goavatar","last_synced_at":"2025-10-25T20:06:51.185Z","repository":{"id":281287381,"uuid":"943111370","full_name":"MuhammadSaim/goavatar","owner":"MuhammadSaim","description":"A lightweight Go package to generate unique, symmetric identicons based on an input string. Easily integrate with your Go project to create visual avatars for users.","archived":false,"fork":false,"pushed_at":"2025-03-08T03:24:29.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-08T04:20:07.437Z","etag":null,"topics":["avatar-generator","golang","identicons","package"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MuhammadSaim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-05T07:26:18.000Z","updated_at":"2025-03-08T03:24:32.000Z","dependencies_parsed_at":"2025-03-08T04:20:18.038Z","dependency_job_id":"3291d74b-22bc-4acf-a5a5-5a7983d0d009","html_url":"https://github.com/MuhammadSaim/goavatar","commit_stats":null,"previous_names":["muhammadsaim/goavatar"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuhammadSaim%2Fgoavatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuhammadSaim%2Fgoavatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuhammadSaim%2Fgoavatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuhammadSaim%2Fgoavatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MuhammadSaim","download_url":"https://codeload.github.com/MuhammadSaim/goavatar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242757001,"owners_count":20180204,"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":["avatar-generator","golang","identicons","package"],"created_at":"2025-03-09T21:53:56.817Z","updated_at":"2025-10-25T20:06:51.180Z","avatar_url":"https://github.com/MuhammadSaim.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goavatar Identicon Generator in Go\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"./arts/goavatar-banner.png\" alt=\"GoAvatar Banner\" /\u003e\n\u003c/p\u003e\n\nThis package provides a simple way to generate unique, symmetric identicons based on an input string (e.g., an email address or username). It uses an **MD5 hash** to create a deterministic pattern and color scheme, then mirrors the design for a visually appealing avatar.\n\n## User Avatars\n\n\u003cp align=\"center\"\u003e\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_1.png\" width=\"100\" alt=\"Avatar 1\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003eQuantumNomad42\u003c/strong\u003e\n  \u003c/kbd\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_2.png\" width=\"100\" alt=\"Avatar 2\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003eEchoFrost7\u003c/strong\u003e\n  \u003c/kbd\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_3.png\" width=\"100\" alt=\"Avatar 3\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003eNebulaTide19\u003c/strong\u003e\n  \u003c/kbd\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_4.png\" width=\"100\" alt=\"Avatar 4\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003eZephyrPulse88\u003c/strong\u003e\n  \u003c/kbd\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_5.png\" width=\"100\" alt=\"Avatar 5\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003eEmberNexus23\u003c/strong\u003e\n  \u003c/kbd\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ckbd\u003e\n    \u003cimg src=\"./arts/avatar_6.png\" width=\"100\" alt=\"Avatar 5\"/\u003e\u003cbr/\u003e\n    \u003cstrong\u003enice__user__name\u003c/strong\u003e\n  \u003c/kbd\u003e\n\u003c/p\u003e\n\n## Installation\n\nTo use this package in your Go project, install it via:\n\n```sh\ngo get github.com/MuhammadSaim/goavatar\n```\n\nThen, import it in your Go code:\n\n```go\nimport \"github.com/MuhammadSaim/goavatar\"\n```\n\n## Usage\n\n### **Basic Example**\n\n```go\npackage main\n\nimport (\n \"fmt\"\n \"image\"\n \"image/png\"\n \"os\"\n\n \"github.com/MuhammadSaim/goavatar\"\n)\n\nfunc main() {\n // empty slice.\n imgSlice := make([]image.Image, 0)\n\n // Generates a unique avatar based on \"QuantumNomad42\" with a custom width and height.\n // Saves the generated avatar as avatar_1.png\n image1 := goavatar.Make(\"QuantumNomad42\",\n  goavatar.WithSize(512),  // Set custom image widthxheight (default is 64)\n )\n\n // Generate the second avatar with a custom grid size with a 10x10 grid for more detail.\n // Saves the generated avatar as avatar_2.png\n image2 := goavatar.Make(\"EchoFrost7\",\n  goavatar.WithSize(512),   // Set custom image widthxheight (default is 64)\n  goavatar.WithGridSize(10), // Set custom grid size (default is 8), affects pattern complexity\n )\n\n // Generate the third avatar with a custom brownish background color.\n // Saves the generated avatar as avatar_3.png\n image3 := goavatar.Make(\"NebulaTide19\",\n  goavatar.WithSize(512),                 // Set custom image widthxheight (default is 256)\n  goavatar.WithBgColor(170, 120, 10, 255), // Change background color (default is light gray)\n )\n\n // Generate the fourth avatar with a custom brownish background and white foreground.\n // Saves the generated avatar as avatar_4.png\n image4 := goavatar.Make(\"ZephyrPulse88\",\n  goavatar.WithSize(512),                  // Set custom image widthxheight (default is 64)\n  goavatar.WithBgColor(170, 120, 10, 255),  // Change background color (default is light gray)\n  goavatar.WithFgColor(255, 255, 255, 255), // Change foreground color (default is extracted from hash)\n\n )\n\n // Generate an avatar using default settings\n // Saves the generated avatar as avatar_5.png\n image5 := goavatar.Make(\"EmberNexus23\")\n\n // Collect options dynamically\n var opts []goavatar.OptFunc\n\n // add size\n opts = append(opts, goavatar.WithSize(100))\n opts = append(opts, goavatar.WithGridSize(10))\n image6 := goavatar.Make(\"nice__user__name\", opts...)\n\n // append all the images into the list\n imgSlice = append(imgSlice, image1, image2, image3, image4, image5, image6)\n\n // loop through the image slice and save the images\n for i, img := range imgSlice {\n\n  filename := fmt.Sprintf(\"../arts/avatar_%d.png\", i+1)\n\n  // Create the file\n  file, err := os.Create(filename)\n  if err != nil {\n   fmt.Println(\"Error creating file:\", err)\n   continue\n  }\n  defer file.Close()\n\n  // Encode image as PNG and save\n  err = png.Encode(file, img)\n  if err != nil {\n   fmt.Println(\"Error saving image:\", err)\n  } else {\n   fmt.Println(\"Saved: \", filename)\n  }\n\n }\n}\n```\n\nThis will generate a unique identicons for the input string and save in the `arts` directory.\n\n## Package Documentation\n\n### **Generate Identicon**\n\n```go\nfunc Make(input, ...optFunc) image.Image\n```\n\n-   `input`: A string used to generate a unique identicon (e.g., email, username).\n-   `...optFunc`: Functional options to override the default values.\n-   `image.Image`: Function returns an `image.Image`, allowing the caller to handle image processing, encoding, and storage as needed.\n\n## License\n\nThis project is open-source under the MIT License.\n\n## Contributing\n\nContributions are welcome! Feel free to open a pull request or create an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammadsaim%2Fgoavatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuhammadsaim%2Fgoavatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammadsaim%2Fgoavatar/lists"}