Skip to content
melophosPublic

About

MELOPHOS documentation: architecture, protocol, roadmap, accessibility, self-hosting and guides. Read-only copy published from melophos/melophos.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

MELOPHOS documentation

Note

This folder is published to melophos/docs as a read-only copy. Edit it in melophos/melophos.

Start here

Document What it covers
overview.md What MELOPHOS is, what it does and why it exists
architecture.md How the hub, server, Studio and integrations fit together
roadmap.md What ships in v1, v2 and v3

Reference

Document What it covers
protocol.md Note events, MQTT topics and the HTTP API
instruments.md Instrument profiles and lining LEDs up with keys
accessibility.md Design choices for low vision, monocular vision, colour blindness and hearing loss
integrations.md Spotify, WLED, Home Assistant and webhooks
song-import.md Importing MIDI, audio and tutorial videos
self-hosting.md Running the server stack with Docker Compose
repositories.md The monorepo and the published component repositories
decisions.md Architecture decision records
inventory.md Parts on hand for the prototype and parts still to buy
assets/brand Logo files, colours and usage, in the monorepo

About

MELOPHOS documentation: architecture, protocol, roadmap, accessibility, self-hosting and guides. Read-only copy published from melophos/melophos.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors