# Melodix

> A self-hosted Discord music bot and terminal player in Go, for YouTube, SoundCloud and internet radio.

These pages describe the development source. Release archives include their own
documentation. Follow individual links as needed.


## Use Melodix

- [Documentation](https://melodix.keshon.ru/docs/README.md): Choose setup, playback, troubleshooting or contributor instructions for Melodix.
- [Running Melodix](https://melodix.keshon.ru/docs/running.md): Install Melodix on Windows, Linux or macOS, configure a Discord bot or terminal player, and verify your first track. Includes configuration and backup procedures.
- [Playback](https://melodix.keshon.ru/docs/playback.md): Search for tracks, play YouTube playlists, manage a queue and replay history in Discord or the Melodix terminal player.
- [Troubleshooting](https://melodix.keshon.ru/docs/troubleshooting.md): Diagnose missing commands, silent audio, interrupted streams, locked storage and container settings in Melodix.
- [Docker deployment](https://melodix.keshon.ru/docker/README.md): Build and operate the Melodix Docker container with persistent data. Understand environment overrides, update downtime and recovery requirements.

## Develop Melodix

- [Conventions](https://melodix.keshon.ru/docs/conventions.md): Run Melodix development checks, add sources or parsers, preserve checked conventions and prepare release notes.
- [Architecture](https://melodix.keshon.ru/docs/architecture.md): Follow Melodix components, parser fallback, playback, Discord voice recovery, command dispatch and persistence.
- [Ownership](https://melodix.keshon.ru/docs/ownership.md): Look up Melodix lifecycle and concurrency contracts, their enforcement tests and known coverage limits.
- [Go music library](https://melodix.keshon.ru/pkg/music/README.md): Embed the Discord-independent Melodix playback engine in Go. Start with a runnable example and the sink, status and lifecycle contracts.
- [Brand assets](https://melodix.keshon.ru/docs/brand.md): Find Melodix mark and favicon sources, palette boundaries and constraints for small icon sizes.