Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 27 additions & 9 deletions README.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ y **rotación de DJ por turnos** — escuchad juntos, desde la terminal.

- 🎧 **Modo solo:** reproduce YouTube, radios, streams o archivos locales. Funciona sin servidor, incluso offline (archivos locales).
- 👥 **Modo sala (opcional):** entra a una sala con un código y escuchad lo mismo, sincronizado. Cada persona pincha **por turnos** (rotación en bucle).
- 🚫 **Sin descargar nada:** streaming puro. Sin Spotify Premium.
- 🌐 **Fuentes flexibles:** streaming puro para YouTube y Radios (sin necesidad de cuentas Premium). También soporta Apple Music (requiere una suscripción activa).
- 📊 **Visualizador reactivo real:** FFT en vivo (ffmpeg auto-instalado) con varios modos — barras, espejo, suave, osciloscopio, plasma (cambia con `v`).
- 🖥️ **Multiplataforma:** macOS, Linux y Windows.

Expand All @@ -19,6 +19,11 @@ y **rotación de DJ por turnos** — escuchad juntos, desde la terminal.

- [mpv](https://mpv.io) — motor de audio (obligatorio).
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — solo para YouTube y similares.
- [gamdl](https://github.com/glomatico/gamdl) — solo para Apple Music.

> **Nota sobre Apple Music:**
> Para reproducir desde Apple Music necesitas proveer tus cookies de autenticación dentro de la interfaz usando el comando `/auth <cookies>`.
> Este proyecto también utiliza un fork personalizado de `applemusic-api` para las búsquedas y resolución de catálogos.

Comprueba tu sistema con: `catunes doctor`

Expand All @@ -28,10 +33,25 @@ Comprueba tu sistema con: `catunes doctor`

```bash
npm install -g catunes
catunes play "https://www.youtube.com/watch?v=..."
catunes # Abre la interfaz completa (TUI)
```

Controles: `espacio` pausa · `← →` seek · `+ -` volumen · `q` salir.
### Controles de la Interfaz
Navega usando el teclado:
- `Tab` / `↑ ↓` para cambiar de panel y moverte.
- `Enter` para reproducir la canción seleccionada.
- Usa los comandos con barra (`/`) en el prompt inferior:
- `/search <query>` para buscar música.
- `/pause`, `/next`, `/prev` para controlar la reproducción.
- `/auth <cookies>` para configurar las cookies de Apple Music.
- `/help` para ver todos los comandos.

### Reproducir una canción suelta (Modo CLI)
Si no quieres usar la interfaz completa, puedes reproducir un stream directamente:
```bash
catunes play "https://www.youtube.com/watch?v=..."
```
Controles en modo CLI: `espacio` pausa · `← →` seek · `+ -` volumen · `q` salir.

---

Expand Down Expand Up @@ -112,13 +132,11 @@ catunes/

## Aviso legal

catunes **no** almacena ni convierte música — solo reproduce streams.
Úsalo únicamente con contenido que tengas derecho a reproducir y respetando
los términos de cada plataforma. El uso es responsabilidad de cada usuario.
catunes es únicamente una **interfaz de terminal y wrapper** de herramientas de terceros (`mpv`, `yt-dlp`, `gamdl`). No aloja, distribuye ni provee acceso a material protegido por derechos de autor por sí mismo.

Dependiendo de la fuente (ej. Apple Music), herramientas como `gamdl` pueden descargar archivos temporales localmente para permitir la reproducción. Debes usar este software únicamente con tus propias cuentas y credenciales legítimas, para uso personal, y respetando los términos de servicio de cada plataforma. El uso que le des es tu entera responsabilidad.

Usa mpv y yt-dlp para leer el contenido; respeta el copyright y los términos de
cada sitio (como advierte el propio yt-dlp). Este proyecto no está diseñado para
descargar música ni para saltarse ninguna protección.
Este proyecto respeta el copyright. No está diseñado para promover la piratería ni la distribución no autorizada de música protegida.

## Licencia

Expand Down
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A **retro** terminal music player with **synced rooms** and

- 🎧 **Solo mode:** play YouTube, radios, streams or local files. Works without a server, even offline (local files).
- 👥 **Room mode (optional):** join a room with a code and listen together, in sync. Everyone takes **turns** as DJ (round-robin).
- 🚫 **No downloads:** pure streaming. No Spotify Premium needed.
- 🌐 **Flexible sources:** pure streaming for YouTube and Radios (no Spotify Premium needed). Apple Music support is also available (requires an active subscription).
- 📊 **Real audio-reactive visualizer:** live FFT (auto-installed ffmpeg) with several modes — bars, mirror, smooth, oscilloscope, plasma (cycle with `v`).
- 🖥️ **Cross-platform:** macOS, Linux and Windows.

Expand All @@ -19,6 +19,11 @@ A **retro** terminal music player with **synced rooms** and

- [mpv](https://mpv.io) — audio engine (required).
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — only for YouTube and similar.
- [gamdl](https://github.com/glomatico/gamdl) — only for Apple Music.

> **Note on Apple Music:**
> To use Apple Music, you need to provide your authentication cookies inside the UI using the command `/auth <cookies>`.
> This project also relies on a custom fork of `applemusic-api` to fetch metadata and search the Apple catalog.

Check your system with: `catunes doctor`

Expand All @@ -28,10 +33,25 @@ Check your system with: `catunes doctor`

```bash
npm install -g catunes
catunes play "https://www.youtube.com/watch?v=..."
catunes # Opens the full terminal UI
```

Controls: `space` pause · `← →` seek · `+ -` volume · `q` quit.
### Full TUI Controls
Navigate the interface with the keyboard:
- `Tab` / `↑ ↓` to switch panels and scroll.
- `Enter` to play the selected track.
- Use slash commands at the bottom prompt:
- `/search <query>` to find music.
- `/pause`, `/next`, `/prev` to control playback.
- `/auth <cookies>` to set Apple Music cookies.
- `/help` to see all commands.

### Play a single track (CLI Mode)
If you don't want the full interface, you can play a stream directly:
```bash
catunes play "https://www.youtube.com/watch?v=..."
```
Controls in CLI mode: `space` pause · `← →` seek · `+ -` volume · `q` quit.

---

Expand Down Expand Up @@ -112,13 +132,11 @@ catunes/

## Disclaimer

catunes does **not** download, store or convert music — it only plays streams.
Use it only with content you have the right to play, and respect each
platform's terms of service. How you use it is your responsibility.
catunes is merely a **terminal UI and player wrapper** around third-party tools (`mpv`, `yt-dlp`, `gamdl`). It does not host, distribute, or provide access to any copyrighted material by itself.

Depending on the source (e.g., Apple Music), third-party tools like `gamdl` may download temporary files locally to allow playback. You must only use this software with your own legitimate accounts and credentials, for personal use, and in compliance with the terms of service of the respective platforms. How you use it is your sole responsibility.

It relies on mpv and yt-dlp to read media; respect copyright and the terms of
each site (as yt-dlp itself advises). This project is not designed to download
music or to circumvent any protection.
This project respects copyright. It is not designed to promote piracy or the unauthorized distribution of copyrighted music.

## License

Expand Down
Loading