Pular para o conteúdo
Lyrius

Lyrius ScriptEm testes

Automatize o culto com pequenos scripts

Scripts em TypeScript que conversam com o Lyrius: projetar, avisar a banda, ligar a luz, preparar o telão. Cada um com as permissões que declarar, rodando isolado do resto do app.

Ainda não está pronto. O Lyrius Script está em fase de testes e não foi liberado nas versões públicas. Esta página mostra como ele vai funcionar — a API pode mudar até lá.

Como vai funcionar

Você escreve no seu editor, com tipos e autocompletar, e instala no Lyrius como um pacote.

  1. 1

    Escreva em TypeScript

    O SDK @lyrius/script-sdk traz a API tipada (lyrius.songs, lyrius.stage…), mocks para testar e uma linha de comando para começar.

  2. 2

    Declare as permissões

    No manifesto, o script diz o que pode fazer: ler músicas, controlar o palco, acessar a rede local. O resto é recusado.

  3. 3

    Instale no Lyrius

    Empacote em um arquivo .lyrius-script e instale em Automação › Scripts. No modo desenvolvedor, cada build recarrega sozinho.

  4. 4

    Rode quando precisar

    Num botão, num atalho, numa macro, no menu de uma música ou num gatilho: quando o refrão entra, o timer zera ou o culto começa.

Exemplos

Escritos com a API que já existe no SDK. Os nomes e as funções ainda podem mudar antes do lançamento.

Começar o culto

Um botão que abre o telão, coloca a primeira música da fila no ar e avisa a banda.

Permissões: display.control, output.control, queue.read, songs.control, stage.control, notifications

src/index.ts
import { defineScript, lyrius } from "@lyrius/script-sdk";

// Um botão (ou atalho) que deixa tudo pronto para começar o culto.
export default defineScript({
  async main() {
    await lyrius.displays.public.open(); // abre o telão
    await lyrius.output.live();

    const [first] = (await lyrius.queue.list()).filter((item) => item.songId);
    if (!first?.songId) {
      await lyrius.ui.notify({ type: "warning", message: "A fila não tem músicas." });
      return;
    }

    await lyrius.songs.show(first.songId);
    await lyrius.stage.message(`Começando: ${first.title}`);
  },
});

Aviso de refrão no palco

Ligado a um gatilho de troca de slide, avisa os músicos quando o refrão entra e conta quantas vezes ele já foi cantado.

Permissões: presentation.read, songs.read, stage.control, storage

src/index.ts
import { defineScript, lyrius } from "@lyrius/script-sdk";

// Gatilho: presentation.slideChanged. Avisa a banda quando entra o refrão.
export default defineScript({
  async main() {
    const current = await lyrius.presentation.current();
    if (current.source !== "song" || !current.songId) return;

    const song = await lyrius.songs.get(current.songId);
    const slide = song.slides.find((s) => s.id === current.slideId);
    if (!slide || !/refr/i.test(slide.type)) return;

    // Cada script tem o próprio armazenamento.
    const count = (await lyrius.storage.get<number>("refroes", 0)) + 1;
    await lyrius.storage.set("refroes", count);
    await lyrius.stage.message(`Refrão (${count}) • ${song.title}`);
  },
});

Luz que acompanha a música

Quando uma música começa, manda o título para a mesa de luz na rede da igreja. O endereço é uma configuração do script, ajustada dentro do Lyrius.

Permissões: presentation.read, songs.read, network.local

src/index.ts
import { defineScript, lyrius } from "@lyrius/script-sdk";

// Gatilho: song.started. Troca a cena da mesa de luz pela rede da igreja.
export default defineScript({
  async main(context) {
    const current = await lyrius.presentation.current();
    if (!current.songId) return;

    const song = await lyrius.songs.get(current.songId);
    const url = String(context.settings.lightsUrl); // configurado no Lyrius

    // Só funciona com a permissão "network.local" no manifesto.
    await lyrius.http.post(`${url}/scene`, { scene: song.title });
    lyrius.log.info("Cena da luz:", song.title);
  },
});

O manifesto

Todo script tem um lyrius.manifest.json: nome, versão, a versão da API que usa, as permissões e as configurações que aparecem no Lyrius.

lyrius.manifest.json
{
  "id": "br.com.minhaigreja.luz",
  "name": "Luz por música",
  "version": "1.0.0",
  "api": "^1.0.0",
  "entry": "dist/index.js",
  "permissions": ["presentation.read", "songs.read", "network.local"],
  "settings": {
    "lightsUrl": { "type": "string", "label": "Endereço da mesa de luz", "default": "http://192.168.0.50" }
  }
}

Feito para não atrapalhar o culto

O culto é ao vivo. Um script com erro nunca pode travar a apresentação.

  • Isolado em sandbox

    Cada script roda num motor próprio (QuickJS), separado do app. Sem acesso a arquivos, shell ou outros programas.

  • Só o que foi permitido

    Chamar algo fora das permissões do manifesto é recusado. Rede só com permissão, e a rede local é separada da internet.

  • Com limites

    Tempo, memória e chamadas por minuto têm limite. Um script que falha várias vezes é pausado sozinho (circuit breaker).

  • Live Lock e registro

    Durante o culto, o Live Lock pode bloquear scripts sem tocar na apresentação. Cada execução fica registrada, sem segredos no log.

A API

Tudo fica em lyrius.* — algumas das funções que o SDK já tem:

lyrius.presentation
next · previous · current · showSong · showSlide
lyrius.output
live · clear · black
lyrius.songs
list · search · get · show
lyrius.bible
show("jo 3 16")
lyrius.media
list · search · show · play · pause
lyrius.queue
list · addSong · remove
lyrius.stage
message · clear
lyrius.displays
public.open · stage.toggle
lyrius.storage
get · set · delete
lyrius.events
on(name, listener)
lyrius.http
get · post · request
lyrius.ui
notify

Quer testar antes de todo mundo?

Se a sua igreja tem alguém que programa e quer ajudar a testar o Lyrius Script, fale com a gente.

Falar com a equipe