Stack-chan

日本語

Stack-chan is a JavaScript-driven M5Stack-embedded super-kawaii robot.

• Video (with English subtitles): https://youtu.be/fZb_mF08xV0
• Official hashtag: #stackchan | #ｽﾀｯｸﾁｬﾝ (JP).

Features

• :neutral_face: Show cute face
• :smile: Expression(Happy, Angry, Sad etc.)
• :smiley_cat: Customize face
• :eyes: Glance/stare/gaze
• :speech_balloon: Say things
• :bulb: Addon M5Units
• :cyclone: Drive Serial(TTL)/PWM servos
• :game_die: Make applications on your own

Contents

This repository includes all the component of the robot.

• firmware : Source codes of the firmware.
• case : Stereolithography(STL) of the case.
• schematics : Schematics and board layout data.

Installation

Assemble board

• See schematics/README.md and case/README.md
• OR You can get a pre-assembled module(COMING SOON)

Flash firmware to M5Stack

• See firmware/README.md

Development

For contributor-oriented setup and pull request expectations, see CONTRIBUTING.md.

Typical firmware workflow:

cd firmware
npm run setup
npm run doctor
npm run test
npm run flash

Generated web assets under web/flash and web/schematics are published from the gh-pages branch by GitHub Actions. Treat them as deployment outputs, not hand-maintained source files.

Planning

• Development roadmap: docs/ROADMAP.md

Contribution

Feature requests/Bug reports are extremely welcome! See issues page to post some.

Wanna be a sponsor? It would be my great honor. please visit my sponsor page.

License

Resources of this repository are distributed under Apache version 2.0 license. See LICENSE.

BibTeX

@misc{stackchan,
  author       = {Shinya Ishikawa and the Stack-chan community},
  title        = {Stack-chan: A JavaScript-driven Super-kawaii Robot},
  year         = {2021},
  howpublished = {\url{https://github.com/stack-chan/stack-chan}},
  note         = {Open-source hardware and software.},
}