# Mendil

> A self-hosted music bot for TeamSpeak 3 and 6. People type a song in the TeamSpeak chat (`!play <search or link>`) and Mendil plays it in the voice channel. It runs as one Docker container, with a queue, Spotify links, internet radio, admin/listener roles and a web panel. Open source, GPL-3.0.

Every page is also available as Markdown (the links below). All of them in one file: https://ulaski.github.io/mendil/llms-full.txt

## Start here

- [Introduction](https://ulaski.github.io/mendil/start/introduction.md): What Mendil is, where the name comes from, and what you need to run it.
- [Quick start](https://ulaski.github.io/mendil/start/quick-start.md): From nothing to the first song: download two files, set your server, start the container.

## Guides

- [Where is your server?](https://ulaski.github.io/mendil/guides/your-server.md): How Mendil reaches your TeamSpeak server: remote, in Docker on the same host, on the host, or not yet installed.
- [Server settings](https://ulaski.github.io/mendil/guides/server-settings.md): Codec, talk power and anti-flood settings that make Mendil sound good and answer reliably.
- [Roles](https://ulaski.github.io/mendil/guides/roles.md): Admins and listeners: who may request songs, and who controls playback.
- [Web panel](https://ulaski.github.io/mendil/guides/web-panel.md): Mendil's browser panel: what's playing, the queue and controls, with TeamSpeak sign-in.
- [Radio and quiet channels](https://ulaski.github.io/mendil/guides/radio.md): Internet radio for an empty queue, and pausing while nobody is listening.
- [YouTube blocks](https://ulaski.github.io/mendil/guides/youtube.md): Why YouTube sometimes refuses servers, and how cookies or a proxy fix it.
- [Updating](https://ulaski.github.io/mendil/guides/updating.md): Updating Mendil, pinning a version, and what survives an update.
- [Unraid](https://ulaski.github.io/mendil/guides/unraid.md): Install Mendil on Unraid from Community Applications, with its data in appdata.
- [Pterodactyl](https://ulaski.github.io/mendil/guides/pterodactyl.md): Run Mendil from a Pterodactyl or Pelican panel with the Mendil egg.

## Reference

- [Commands](https://ulaski.github.io/mendil/reference/commands.md): Every chat command, its aliases, and who may use it.
- [Configuration](https://ulaski.github.io/mendil/reference/configuration.md): Every setting, its default, and what it does.

## Help

- [Troubleshooting](https://ulaski.github.io/mendil/help/troubleshooting.md): What to check when Mendil does not connect, play or sound right.
- [FAQ](https://ulaski.github.io/mendil/help/faq.md): Classic or Native, several bots, TeamSpeak 6, Spotify and who can use the bot.

## Project

- [How it works](https://ulaski.github.io/mendil/project/how-it-works.md): The two voice engines, how audio gets into TeamSpeak, and where things live in the code.
- [Contributing](https://ulaski.github.io/mendil/project/contributing.md): Reporting bugs, running the tests, translating Mendil and sending pull requests.
- [Changelog](https://ulaski.github.io/mendil/project/changelog.md): What changed in each release.
- [Legal and license](https://ulaski.github.io/mendil/project/legal.md): Trademarks, the TeamSpeak client license, your responsibility for content, and the GPL.

## Optional

- [Source code](https://github.com/ulaski/mendil): the repository on GitHub