# Melodix documentation

Start with a released binary, play a track, then change settings as needed.
These pages describe the development source; each release bundles its own docs.

## Run and use Melodix

- [Running Melodix](<https://melodix.keshon.ru/docs/running.md>): install on Windows, Linux or macOS; configure a
  Discord bot or start the terminal player; verify playback.
- [Playback](<https://melodix.keshon.ru/docs/playback.md>): search, play playlists, manage the queue and replay history.
- [Troubleshooting](<https://melodix.keshon.ru/docs/troubleshooting.md>): missing commands, silent playback,
  interrupted streams, storage locks and container settings.
- [Docker](<https://melodix.keshon.ru/docker/README.md>): build and operate a container with persistent data.
- [Configuration](<https://melodix.keshon.ru/docs/running.md#configuration>) and
  [backup/update procedures](<https://melodix.keshon.ru/docs/running.md#persistent-data-and-restart-behavior>).

## Change or embed Melodix

- [Conventions](<https://melodix.keshon.ru/docs/conventions.md>): local checks, extension steps and release workflow.
- [Architecture](<https://melodix.keshon.ru/docs/architecture.md>): components, playback, recovery and persistence.
- [Ownership](<https://melodix.keshon.ru/docs/ownership.md>): lifecycle and concurrency contracts and their checks.
- [Go music library](<https://melodix.keshon.ru/pkg/music/README.md>): use the playback engine in another program.
- [Brand assets](<https://melodix.keshon.ru/docs/brand.md>): mark, favicon sources and small-size constraints.

The [repository README](<https://github.com/keshon/melodix/blob/b191282f08193ccf22c8c0215d786e6069e317f8/README.md>) introduces the project and includes the
generated command catalog. Runtime `help` and Discord `/help flat` list commands
for the version you are running.