Kappapps SDK

Appearance

Développer une appli Kappapps — instructions pour l’agent ​

Tu développes une appli : un jeu ou outil web installé par un streamer sur son channel. Ce parcours concerne le SDK app V2, les préférences d’appli et ses pages plugins. Les widgets ont leur propre parcours.

Trouver la documentation ​

Avec le DEV HUB, lis le contexte de l’appli dans HUB-DEV.md s’il existe. Il indique le workspace, le runtime publié et le dossier global du knowledge ; ce dossier est aussi donné par get_app_status dans knowledge_dir. Ne suppose pas qu’un dossier ai-knowledge/ existe dans chaque appli. Le HUB régénère HUB-DEV.md et conserve les autres consignes des fichiers agents.

Sans HUB, le ZIP documentaire contient ce guide à sa racine et le corpus dans ai-knowledge/. Dans les deux cas, les identifiants ci-dessous désignent des fichiers relatifs au corpus, avec l’extension .md.

Avec MCP, read_app_doc sans doc donne l’index ; read_app_doc avec doc: "CHEATSHEET" lit l’entrée. search_app_knowledge recherche une méthode ou un concept. Pour une référence commune, utilise aussi reference/chat, par exemple, sans préfixe common/.

Lire juste ce qui sert ​

  1. Lis CHEATSHEET, puis les fiches correspondant à la tâche. La version web du mémo propose le même aiguillage.
  2. Avant une API incertaine, vérifie sa fiche et la signature dans app-sdk.d.ts, à la racine de l’appli. N’invente ni méthode, ni événement, ni champ de configuration. Si le contrat manque, signale cette limite. Si la fiche et les types divergent, la fiche décrit le comportement constaté : suis-la et signale l’écart. KappappsHost (plugins) et KappappsPrefs (panneaux) n’ont pas de types : leurs fiches font foi.
  3. Pour démarrer ou tester, lis reference/dev-workflow, reference/bootstrap et un exemple adapté dans examples/. Avant livraison, reference/delivery couvre guides, présentation, ressources et recette.
  4. Pour une mise à niveau, consulte CHANGELOG, puis les migrations concernées. Relis PITFALLS et common-PITFALLS pour les sujets touchés avant livraison. Inutile de charger tout le corpus au démarrage.

Règles de travail ​

  • Conserve le bootstrap : le code métier démarre après AppliLoaded. Applique l’état initial avant d’attendre des événements.
  • Distingue l’iframe d’appli (kapp), le plugin (KappappsHost) et le panneau de préférences (KappappsPrefs). Leurs objets et garanties ne sont pas interchangeables.
  • Vérifie les scopes requis dans chaque fiche et dans infos.json, ainsi que les prérequis Twitch ou du channel. Un scope applicatif ne remplace pas une autorisation Twitch.
  • Modifie les sources, compile les configurations et, si nécessaire, construis le runtime. Ne corrige pas à la main les JSON générés ou dist/.
  • Teste les surfaces déclarées, le rafraîchissement des préférences et les chemins de sortie concernés. Distingue une simulation d’une recette dans le HUB ; rapporte les résultats et les limites observées.
  • Respecte la demande du développeur pour les synchronisations et la publication. Si le HUB refuse push ou pull, utilise son parcours prévu, sans contourner le refus.