Le guide NodeCG

Pourquoi ce guide ?

J’utilise NodeCG dans une grande partie de mes projets de streaming mais au fil du temps, j’ai fait le constat qu’il existait assez peu de ressources en français permettant de découvrir NodeCG progressivement.

Ce guide est donc avant tout un retour d’expérience et l’objectif n’est pas de remplacer la documentation officielle de NodeCG, ni de couvrir l’intégralité de ses fonctionnalités.

Je ne suis pas développeur de métier, pardonnez d’avance certaines erreurs ou imprécisions. C’est d’ailleurs un peu grâce à NodeCG que j’ai appris à developper, en expérimentant et en l’insérant peu à peu dans mes propres projets depuis 2023.

Si vous avez une expérience certaine dans le développement web, vous trouverez peut-être certaines de mes approches “discutables” ou sous-optimales et c’est très bien aussi.

• Le site officiel de NodeCG
• Le projet sur Github

À qui s’adresse ce guide ?

Disons le tout de suite, si vous n’avez aucune notion en développement web, ce guide n’est pas pour vous.

Si par exemple la phrase “Ouvrez le terminal dans le dossier et tapez la commande ‘npm install nodecg’” ne vous évoque rien du tout, NodeCG ne sera probablement pas l’outil le plus adapté pour vous.

En revanche, si vous avez quelques bases en développement web et que vous aimez explorer, bricoler, automatiser et construire vos propres outils, NodeCG pourrait vous interesser.

Quelques connaissances sont nécessaires, par exemple :

• quelques bases pour naviguer dans un terminal
• quelques bases en HTML, CSS & Javascript
• quelques notions sur Node.js et comment se construit un projet

Pour commencer rapidement sans se perdre dans trop de détail au début, je vous mets à disposition un bundle d’initiation de base pour ce guide.

Téléchargement direct

Comment est organisé le guide ?

Pour l’heure, voici les éléments disponibles :

Partie théorique

• Qu’est-ce que NodeCG ? À quoi ça sert ? : Découvrir la philosophie de NodeCG, ses cas d’usage, ses forces et comprendre dans quels projets il est pertinent de l’utiliser.

• Prérequis techniques et matériels : Faire le point sur les connaissances minimales (Node.js, terminal, HTML/CSS/JavaScript) et les outils nécessaires pour suivre le guide.

• Installer NodeCG et lancer son premier projet : Installer NodeCG, comprendre son fonctionnement de base et démarrer un premier bundle.

• Comprendre l’arborescence d’un projet NodeCG : Découvrir les différents dossiers (dashboard, graphics, extension, schemas, assets…) et le rôle de chacun dans un bundle.

• Dashboards et Graphics : le côté navigateur : Comprendre les deux types d’interfaces fournies par NodeCG : les tableaux de bord destinés aux opérateurs et les overlays affichés à l’écran.

• Les Extensions : le côté serveur : Découvrir le rôle des extensions NodeCG, leur cycle de vie et les tâches qui doivent être exécutées côté serveur.

• Replicants et Messages : Comprendre comment partager et synchroniser des données en temps réel entre toutes les parties d’un projet. Apprendre quand utiliser les messages (sendMessage, listenFor) plutôt que les Replicants, et comment faire communiquer dashboards, graphics et extensions.

• Aller plus loin dans NodeCG : Quelques réflexions personnelles, des utilisations avancées, des bugs courants…

Partie pratique

Deux cas concrets pour comprendre l’intérêt de NodeCG dans des situations réelles :

• Créer l’habillage visuel d’un overlay de jeu de rôle : Un exemple concret de la façon dont NodeCG s’intègre dans la création d’overlays de jeu de rôle, pour afficher en temps réel les statistiques des personnages ou encore afficher les résultats des jets de dés

A venir : Gérer l’habillage d’un festival de podcast