FableBound

Welcome to FableBound, an open-source hardware/software project inspired by stories and Norse mythology. This repository powers the ESP32 control code for Fable Bound’s Pneumatic system. The control board, called "Ymir," is named after the first of the Giants in Norse mythology.

Overview

FableBound comprises several subprojects for controlling and monitoring pneumatic, lighting, and interactive systems. The goal: to create immersive, story-driven experiences using a combination of microcontrollers and web dashboards.

Main Components

• Ymir – Firmware running on the ESP32 for pneumatic control
• Yggdrasil – Backend (Node.js/TypeScript) handling API, control, and backend services
• Sleipnir – Angular frontend dashboard for system control and monitoring

Getting Started

Ymir Control Code

• Located in the /Ymir directory
• Built using PlatformIO
• See /Ymir/README.md and /Ymir/platformio.ini for board/env config

Backend (Yggdrasil)

• Located in the /Yggdrasil folder
• See /Yggdrasil/README.md for API/CLI instructions

Frontend (Sleipnir)

• Located in the /Sleipnir folder
• See /Sleipnir/README.md for setup/use

Contributing

We welcome contributions! Please open issues and pull requests. Code of Conduct and Contribution Guidelines coming soon.

Security & Privacy

• All credentials, secrets, and tokens have been removed.
• Please open an issue if you believe any sensitive info remains.
• If you use this codebase, audit your own deployments for secrets and access control.

License

Licensed under the MIT License.