{"id":16239238,"url":"https://github.com/stack-chan/m5stack-avatar","last_synced_at":"2025-04-09T10:09:24.505Z","repository":{"id":37819499,"uuid":"127986677","full_name":"stack-chan/m5stack-avatar","owner":"stack-chan","description":"An M5Stack library for rendering avatar faces","archived":false,"fork":false,"pushed_at":"2024-09-13T09:43:07.000Z","size":1309,"stargazers_count":182,"open_issues_count":8,"forks_count":35,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-02T15:14:22.353Z","etag":null,"topics":["arduino","esp32","m5stack"],"latest_commit_sha":null,"homepage":"","language":"C++","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/stack-chan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-04-04T00:56:04.000Z","updated_at":"2025-03-31T02:42:28.000Z","dependencies_parsed_at":"2023-11-18T12:27:41.801Z","dependency_job_id":"42064647-9d9e-4a05-98f8-78d74ec44898","html_url":"https://github.com/stack-chan/m5stack-avatar","commit_stats":null,"previous_names":["stack-chan/m5stack-avatar"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-chan%2Fm5stack-avatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-chan%2Fm5stack-avatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-chan%2Fm5stack-avatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-chan%2Fm5stack-avatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stack-chan","download_url":"https://codeload.github.com/stack-chan/m5stack-avatar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018061,"owners_count":21034048,"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":["arduino","esp32","m5stack"],"created_at":"2024-10-10T13:42:52.273Z","updated_at":"2025-04-09T10:09:24.452Z","avatar_url":"https://github.com/stack-chan.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notice\n\nThis repository is temporarily frozen at v0.10.0. (Due to the absence of the administrator) We cannot respond to pull requests or ISSUE received.\n\n- We may update this repository in the future when we find bugs due to version upgrades of related libraries.\n- If there is anyone who can maintain this repository, please let us know.\n\n# M5Stack-Avatar\n\n[![Powered By PlatformIO](https://img.shields.io/badge/powered-PlatformIO-brightgreen)](https://platformio.org/)\n[![Build Status](https://travis-ci.com/meganetaaan/m5stack-avatar.svg?branch=master)](https://travis-ci.com/meganetaaan/m5stack-avatar)\n\n![M5Stack-Avatar](docs/image/avatar.gif)\n\nVideo: https://www.youtube.com/watch?v=C1Hj9kfY5qc\n\n[日本語](README_ja.md)\n\n## Features\n\n* :neutral_face:     Draw avatar face\n* :smile:            Expression(Happy, Angry, Sad etc.)\n* :smiley_cat:       Customize face\n* :kiss:             Lip sync\n* :art:              Color Palette\n* :arrows_clockwise: Move, Zoom and Rotation\n* :two:              Compatible with M5Stack Core2\n\n## Installation\n\n### Prerequisites\n\n* USB Driver is installed throwgh [Getting Started: Installing the USB Driver](http://www.m5stack.com/assets/docs/)\n* Any of IDE is set up\n  * This library is confirmed on __Arduino IDE__ and __Platform IO__ for now\n\n### Using Arduino IDE\n\n* On Arduino IDE, Select \"Sketch \u003e Include Library \u003e Manage Libraries...\"\n* Search \"m5stack avatar\"\n* Select \"M5Stack_Avatar\" from the results then click \"Install\"\n* The library gets installed\n\n### Using Platform IO\n\n* Initialize your Platform IO project\n```sh\nmkdir my-avatar\ncd my-avatar\nplatformio init -d . -b m5stack-core-esp32\n```\n* Install the library and its dependency\n```sh\nplatformio lib install M5Unified\nplatformio lib install M5Stack-Avatar\n```\n* The library gets downloaded from repository to .piolibdeps directory\n\n## Usage\n\n```cpp\n\n#include \u003cM5Unified.h\u003e\n#include \u003cAvatar.h\u003e\n\nusing namespace m5avatar;\n\nAvatar avatar;\n\nvoid setup()\n{\n  M5.begin();\n  avatar.init(); // start drawing\n}\n\nvoid loop()\n{\n  // avatar's face updates in another thread\n  // so no need to loop-by-loop rendering\n}\n```\n\n### Using LipSync\n\n* setup AquesTalk-ESP32 (http://blog-yama.a-quest.com/?eid=970195).\n  * (For parsing Kainji statement) Copy the dictionary file from above link to the microSD card.\n  * You don't need to copy AquesTalkTTS files. They are included in this library.\n\n* Write below to open avatar mouth according to the audio output.\n\n```cpp\n#include \u003cAquesTalkTTS.h\u003e\n#include \u003cM5Unified.h\u003e\n#include \u003cAvatar.h\u003e\n#include \u003ctasks/LipSync.h\u003e\n\nusing namespace m5avatar;\n\n// AquesTalk License Key\n// NULL or wrong value is just ignored\nconst char* AQUESTALK_KEY = \"XXXX-XXXX-XXXX-XXXX\";\nAvatar avatar;\n\nvoid setup() {\n  int iret;\n  M5.begin();\n  // For Kanji-to-speech mode (requires dictionary file saved on microSD)\n  // iret = TTS.createK(AQUESTALK_KEY);\n  iret = TTS.create(AQUESTALK_KEY);\n  avatar.init();\n  avatar.addTask(lipSync, \"lipSync\");\n}\n\nvoid loop() {\n  M5.update();\n  if (M5.BtnA.wasPressed()) {\n    // For Kanji-to-speech mode\n    // TTS.play(\"こんにちは。\", 80);\n    TTS.play(\"konnichiwa\", 80);\n  }\n}\n\n```\n\n### Further usage\n\nsee `examples` directory.\n\n### Migration from 0.7.x to 0.8.x\n\n`M5Stack-Avatar` now depends on `M5Unified`, the integrated library for all devices of M5Stack series.\nSince 0.8.0, Sketches with avatar should include `M5Unified.h` instead of `M5Stack.h` or `M5Core2.h`\n\n### Notes for v0.10.0\n\nSome applications may reboot due to insufficient stack size for other tasks. In such cases, increase the stack size of the relevant task.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstack-chan%2Fm5stack-avatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstack-chan%2Fm5stack-avatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstack-chan%2Fm5stack-avatar/lists"}