Documentation pour développeurs

Tout pour écrire un mod, un skin, un script de map ou un thème pour Prism, et pour le publier.

API des mods version 2

Pour les assistants IA et les éditeurs

Le SDK typé et un fichier unique à coller dans un assistant de code. Les adresses sont stables.

• Télécharger llms.txt Contexte complet pour un assistant IA (en anglais). Adresse stable: https://dev.prism.am/llms.txt Version française
• Télécharger modding.d.ts Les types du SDK, générés depuis le code du jeu. Adresse stable: https://dev.prism.am/sdk/modding.d.ts

Démarrer

• Écrire un mod pour Prism

  Démarrage rapide : le dossier d'un mod, main.ts, un premier HUD, l'installation et l'export.

• Concepts : comment fonctionne un mod

  Cycle de vie, threads et budgets, événements, permissions, erreurs, déterminisme et interdits.

• Référence de l'API des mods (version 2)

  Référence de l'API des mods (version 2), espace de noms par espace de noms, vérifiée contre le SDK.

• Livre de recettes

  Recettes complètes et testées contre le SDK : HUD, rendu natif, réglages, jeux de jugement, notes de difficulté.

Mods

• Mods TypeScript

  Le guide détaillé des mods TypeScript : événements, entités, HUD, stage, stockage, paquets .pvmod, sécurité, budgets.

• Mods : accès au classement local et onglets de la sélection

  Classement local et onglets de la sélection de maps, écrits par des mods.

• Mods et téléchargements

  Les mods qui ajoutent des téléchargements à la page Télécharger du jeu.

Skins, thèmes et menus

• Skins

  Écrire un skin : defineSkin, référence du playfield, dessin natif, configuration du joueur.

• Scripts de map

  Scripts de map (defineChart) : ce qu'ils changent, budgets, replays.

• Thèmes d'interface

  Thèmes d'interface : le contrat des jetons, les choix de mise en page, écrire un thème.

• Menus : comportement et thèmes

  Menus : comportement, API de comportement et thèmes, sélecteur de modificateurs.

Distribution et contrats

• Catalogue de mods et de skins (page Télécharger)

  Le catalogue de mods et de skins du site : contrat de l'API, installation en un clic, vérification.

• Catalogue de mods et de skins : contrat

  Le contrat du serveur : GET /api/catalog, règles de publication, vérification des archives, fichiers servis.

• Canaux, publication et mises à jour

  Mises à jour du jeu : le contrat de releases.json, canaux, signature, ce que fait le client.

• API de l'index de maps

  L'API JSON publique, en lecture seule, de l'index de maps : identité d'un chart, sources, sets, fichier .rox, limites.

• Proposer un mod au catalogue vérifié

  Construire un .pvmod, ce que regarde la vérification, comment l'envoyer, ce qui se passe après l'approbation.

Proposer un mod au catalogue vérifié