{"id":20696108,"url":"https://github.com/haliphax/hxavatars","last_synced_at":"2025-04-22T20:41:53.750Z","repository":{"id":143025683,"uuid":"469560335","full_name":"haliphax/hxavatars","owner":"haliphax","description":"Front-end-only Stream Avatars clone for Twitch","archived":false,"fork":false,"pushed_at":"2024-02-22T15:50:02.000Z","size":107,"stargazers_count":15,"open_issues_count":1,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-29T18:41:24.931Z","etag":null,"topics":["chat-bot","twitch","twitch-bot","twitch-game","twitch-overlay"],"latest_commit_sha":null,"homepage":"https://haliphax.github.io/hxavatars/","language":"JavaScript","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/haliphax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"haliphax","ko_fi":"haliphax"}},"created_at":"2022-03-14T02:55:58.000Z","updated_at":"2025-02-22T17:52:06.000Z","dependencies_parsed_at":"2024-11-17T00:31:24.172Z","dependency_job_id":null,"html_url":"https://github.com/haliphax/hxavatars","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haliphax%2Fhxavatars","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haliphax%2Fhxavatars/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haliphax%2Fhxavatars/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haliphax%2Fhxavatars/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haliphax","download_url":"https://codeload.github.com/haliphax/hxavatars/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250320176,"owners_count":21411318,"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":["chat-bot","twitch","twitch-bot","twitch-game","twitch-overlay"],"created_at":"2024-11-17T00:12:37.897Z","updated_at":"2025-04-22T20:41:53.728Z","avatar_url":"https://github.com/haliphax.png","language":"JavaScript","funding_links":["https://github.com/sponsors/haliphax","https://ko-fi.com/haliphax"],"categories":[],"sub_categories":[],"readme":"# 👾 hxAvatars\n\nA front-end-only stream overlay that represents your chat as animated sprites.\n\n# 🎥 Using the overlay\n\nVisit https://haliphax.github.io/hxavatars to either build an overlay URL for\nyourself or to view a demonstration (with no chat integration and a fixed\nbackground color).\n\n# 🎲 Commands\n\nThe following commands are available from the overlay's chat integration, with\nmore to come:\n\n| Command           | Description                                  |\n| ----------------- | -------------------------------------------- |\n| `!avatar \u003cvalue\u003e` | Sets the user's avatar (if the value exists) |\n\n# 🏠 Running it yourself\n\nIf you have a web server of your own, you will need to serve the contents of\nthe `html` folder. That's it!\n\nYou can also host it yourself by using `docker-compose`. It will spin up an\ninstance of the [Traefik] load balancer (for managing hostname association\nand HTTPS certificates) and the [nginx] web server (for serving the files).\nBy default, it will be available at https://localhost.\n\n```shell\ndocker-compose up\n```\n\n## 🐧 WSL (Windows)\n\nIf you are running the system with docker on WSL, it is likely that you will\nnot be able to use `localhost` as the hostname for the web application. In this\ncase, add a [hosts file] mapping for `avatars.localdomain` to the WSL system's\naddress. (Use `ip addr` and check the output for `eth0` in most cases.) Copy\nthe `wsl.yml` file to a new `docker-compose.override.yml` file. This file will\nbe automatically merged with the base configuration at runtime.\n\n```shell\ncp wsl.yml docker-compose.override.yml\ndocker-compose up\n```\n\nYou may craft an override file with a different hostname if you just want to\nuse something other than `localhost`, of course; you don't have to be using WSL\nto take advantage of this.\n\n[hosts file]: https://www.freecodecamp.org/news/how-to-find-and-edit-a-windows-hosts-file/\n[nginx]: https://nginx.org\n[Traefik]: https://traefik.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaliphax%2Fhxavatars","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaliphax%2Fhxavatars","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaliphax%2Fhxavatars/lists"}