stack-chan

# Sample Mods

This is a collection of sample Stack-chan user applications (MODs).
For instructions on how to write mods, please refer to [Build and Write Programs](../docs/flashing-firmware.md).

Some mods require a network connection or an external server to run (as of writing).

Installing a MOD replaces the product default behavior supplied by the host.
Button and screen behavior therefore depends on the installed MOD.

MODs can be authored as JavaScript or TypeScript modules.
TypeScript MODs should use only the public Stack-chan capability types and Moddable module specifiers.
MODs for the WASM host should also be built with a TypeScript-capable target such as `lin`, then loaded from the generated `.xsb` or archive.

## M5StackChan CoreS3 Smoke

- [m5stackchan_smoke](./examples/m5stackchan_smoke/): Servo-power and head LED smoke check for M5StackChan CoreS3. See [M5StackChan CoreS3 smoke check](../docs/m5stackchan-cores3-smoke.md).

## Look Around: Kyoro-kyoro gaze Stack-chan

![squeaking Stack-chan](../docs/images/stackchan.gif)

- [look_around](./examples/look_around/)

## Monologue: Posho-posho soliloquy stackchan

- [monologue](./examples/monologue/)

## Cheerup: Stack-chan cheerleaders!

![face-sync](../docs/images/face-sync.gif)
![Stack-chan Cheerup](../docs/images/cheerup.gif)

- [cheerup_ble_lite](./examples/cheerup_ble_lite/): BLE version
- [cheerup_ws](./examples/cheerup_ws/): WebSocket version

## Mimic: Manekko mimicing stack chan.

![manekko_stackchan](../docs/images/mimic.gif)

- [mimic_main](./examples/mimic_main/): the one the user runs
- [mimic_follow](./examples/mimic_follow/): The one that mimics the user.

## Face Tracker: Stack-chan that tracks faces.

![face tracker stack chan](../docs/images/face-tracker.gif)

- [face_tracker](./examples/face_tracker/)