1.1.0 • Published 1 year ago

@fysikrevy/backstage-ticker v1.1.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Det her er en infoskærm til backstage, som viser hvilket nummer, der er på scenen, og de to næste numre, og hvem der er skuespillere og ninjaer i de næste to numre (hvis den er konfigureret korrekt).

Et eksempel på `backstage-ticker` i brug

Selve skærmen kører bare i et browservindue. Som server bruger vi sse-server, som også ligger bag FysikRevyens AV™.

Installation

Fra scratch

Serveren kører på node.js. Hvis du ikke har Node installeret, så gør det først. Åben så en frisk terminal, og skriv (det er også kommandoen i inforammen på pakkens side på npmjs)

npm i @fysikrevy/backstage-ticker

Server-delen bliver installeret som en afhængigned, så du kan bare starte den med kommandoen

node node_modules/@fysikrevy/sse-server.js

men hvis du har andre ting at bruge serveren til, så kan den installeres globalt med

npm i @fysikrevy/sse-server

og så kan du starte den, ved bare at sige

sse-server

Oven i AV™

Hvis du allerede har fulgt instruktionerne til at sætte AV™ op, så behøver du bare, at installere backstage-ticker i den samme mappe, med

npm i @fysikrevy/backstage-ticer

Den deler server med AV-delen.

Forbindelse til browser

I bund og grund skal du bare hente siden backstage-ticker.html fra den server, vi lige startede. På den samme computer, som serveren kører på, burde du bare kunne gå til

http://localhost/backstage-ticker.html

Det er simpelt nok, hvis serveren og browseren er på samme LAN. Der er mange andre muligheder, som kan være mere eller mindre hardware eller softwrebaserede. Et forslag, som kan forbinde computerne, bare de har en internetforbindelse, er ngrok. Det er et produkt i udvikling, så følgende instruktioner kan være forældede, men here goes:

Valgfri: Sæt ngrok op

  • Følg instruktionerne på ngroks hjemmeside, til at lave en konto og hente programmet
  • Hvis du downloadede programmet fra hjemmesiden, får du en program-("exe"-)fil i et zip-arkiv. Pak den ud et sted, hvor du kan finde den med en terminal.
  • Følg igen instruktionerne på ngroks hjemmeside, til at koble din computer op til din konto.
  • Start ngrok med argumenterne http og localhost. Fx på Windows siger du, i en ny terminal, som kan se ngrok.exe filen:

      ./ngrok.exe http localhost

    (Hvis det ikke virker, prøv at skrive ngrok.exe eller bare ngrok i stedet for ./ngrok.exe)

    Du får en statusside fra ngrok, som blandt andet lister den url, der nu peger på din computer. Den kunne godt ligne noget à la https://ba98-120-225-131.ngrok-free.app. Kald det dit værtsnavn.

  • Du kan nu navigere til backstage-tickeren, ved at sætte /backstage-ticker.html efter værtsnavnet. Altså i det her eksempel https://ba09-120-225-121.ngrok-free.app/backstage-ticker.html.

Styring og data

Browsersiden opdateres, ved at sende http POST-forespørgsler til serveren på stien /set-bck, med data om de næste numre som tekst i det rette format som body, og en ekstra header, der hedder sl-cmd, med værdien waiting. Ideelt set burde de her tekniske detaljer være implementeret i det AV-system, din revy alligevel kører.

Tekst-formatet, som beskriver, hvad browsersiden skal vise, har en linje pr. nummer, og på hver af de linjer en række værdier, som er adskilt af semikolonner. Værdierne er først nummerets titel, derefter dets varighed (anbefalet i formatet m:ss), derefter listen med scenegængere i nummeret, hvor første element er ordet actors, og til sidst listen med ninjaer, hvor det første element er ordet ninjas. Så for eksempel kunne kommandoen, der satte eksemplet længere oppe op være:

Velkommen til SPS;3:00;actors;Søren Holm Risum;Sejr Sebastian;Anna Boye;Therese 
Kurser der findes;4:30;actors;Sune Halkjær;Sangboss-Jakob;ninjas;Line;Seberg;Sejr 
Min lille fysiker;0:45;actors;Sia;Tobias Juul;Caitlin Buch;Therese;Onkel Anders;Oliver Solow

Hvis forespørgslen indeholder mere end tre linjer, bliver de første tre linjer vist, og resten ignoreret.

Du vil måske bemærke, at der ikke er nogen sikkerhedsforanstaltninger på plads i forhold til det er indhold, så vær forsigtig med tekst, som kan fortolkes som html, ting som <, > og &.

Hvis du bruger FysikRevyens AV™, så se dens side for instruktioner i at interagere med backstage-ticker. De bruger begge sse-server som server-del.

Hvis du bruger Jeriks Unity-system, så er der en implementeret en integration, hvis du har en ny nok version. Se den dertil hørende dokumentation.

Versioner

v1.0.1

Tilføjet README

v1.0.2

Rettelser til README.

v1.0.3

Flere rettelser til README.

v1.1.0

Opstartsbeskeder, der giver mere mening. Besked ved forbindelsesfejl. Rettet filnavn til skuespiller-ikon. Opdateret READMME.

1.1.0

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago