Skip to content

qhariN/himnario-adventista-obs

Repository files navigation

Himnario Adventista Broadcast

obs-websocket GitHub

Preview

¿Qué es?

Himnario Adventista Broadcast es una GUI web diseñada para ser usada con OBS Studio o simplemente como un reproductor de himnos.

Esta GUI permite:

  • Buscar himnos por número o nombre
  • Mostrar número, título, verso y letra del himno en pantalla
  • Reproducir la melodía del himno (instrumental o cantado)
  • Controlar la letra y la melodía del himno
  • Personalizar los estilos de la letra y el fondo

Instalación

Para usarla con OBS Studio, es requerido tener instalado el plugin obs-websocket versión 5. La GUI usa el puerto 4455 por defecto de este plugin.

Tip

Si usas la versión 4.x de obs-websocket, puedes leer la documentación de la versión 1 de la GUI.

La GUI se encuentra en la siguiente dirección: https://himnario-adventista-broadcast.vercel.app. Puedes usarla directamente en tu navegador web o agregarla como un panel de navegador personalizado en OBS Studio.

Configuración básica

La GUI requiere que tengas obligatoriamente la siguiente escena y fuentes en OBS Studio:

ESCENA
└── Himnario (nombre de ejemplo)
    └── FUENTES (las fuentes se pueden agrupar)
        ├── himno_numero
        ├── himno_titulo
        ├── verso_numero
        └── verso_contenido

Todas las fuentes requeridas deben ser de tipo Texto (GDI+) en Windows o Texto (FreeType 2) en Linux y macOS.

La visibilidad de las fuentes son administradas por la GUI, pero la personalización de los estilos de las fuentes (fuente, tamaño, color, etc.) es responsabilidad del usuario.

Si bien la GUI requiere que tengas la escena y fuentes mencionadas, puedes agregar libremente otras fuentes a la escena para personalizarla a tu gusto como por ejemplo: un fondo, un logo, etc.

Finalmente, en la GUI debes conectarla con OBS Studio usando el botón Conectar.

Configuración avanzada

La GUI tiene una configuración avanzada que puedes acceder desde el botón tuerca en la parte superior derecha de la GUI. En la configuración avanzada puedes establecer:

Al buscar un himno

  • Solo instrumental: Melodía solo instrumental (si no está marcado, se reproducirá la melodía cantada)
  • Autoreproducir música: Auto reproduce la melodía
  • Autoconducir versos: Auto dirigir la letra del himno en pantalla
  • Cambiar a escena de himno: Cambiar a la escena del himno (ninguna por defecto)
  • Escena de himno: Escena donde se encuentran las fuentes que usará la GUI (puedes seleccionar la escena una vez que conectaste la GUI al OBS)

Al terminar de reproducir un himno

  • Cambiar a escena: Cambiar a una escena específica (ninguna por defecto)

Red

  • URL de OBS Websocket: Usar un servidor websocket de OBS Studio personalizado (por defecto usa localhost:4444)
  • URL de host de música: Usar un servidor de melodías personalizado (por defecto usa el del Himnario Adventista API)
  • URL de API de himnario: Usar un servidor de la API de Himnario Adventista personalizado (por defecto usa el Himnario Adventista API)

La GUI está pensada para usarla online, pero gracias a la configuración avanzada puedes usarla sin conexión a internet levantando localmente el Himnario Adventista API y configurando la GUI para usarlo.

Necesito ayuda

Si tienes alguna duda o sugerencia, puedes abrir un issue o ponerte en contacto conmigo en mi LinkedIn.