▰ Prism Développeurs
Sur cette page

← Toute la documentation

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.

Le catalogue de la page Mods du site (et, dans le jeu, Télécharger → Mods) liste des mods que l'auteur de Prism a regardés et approuvés. Il n'y a ni formulaire d'envoi ni compte pour l'instant : l'auteur ajoute chaque élément à la main, et les comptes viendront plus tard. Les skins suivent le même chemin mais sont publics dès que leur archive passe les contrôles.

1. Construire le paquet

  1. Écrivez le mod comme un dossier avec un main.ts (démarrage) et essayez-le dans le dossier des mods du jeu.
  2. Exportez-le depuis la page Mods du jeu. Vous obtenez <id>-<version>.pvmod, une archive ZIP du dossier (les règles d'un paquet disent ce qu'elle peut contenir).
  3. Restez sous 2 MiB pour le catalogue. Fichiers permis : .ts, .ttf, .otf, .png, .json, .md, .txt ; main.ts (ou index.ts) à la racine ou dans l'unique dossier racine.
  4. Choisissez un id stable (minuscules, chiffres, -, _, .) : il identifie votre mod pour toujours et il est unique parmi les mods. Le libellé de version est libre ; une nouvelle version du même id remplace l'ancienne pour les joueurs.
  5. Ne déclarez que les permissions nécessaires (stage, skinImport, ...). Les joueurs les voient avant d'installer.

2. Ce qui arrive à un envoi

  • L'archive est contrôlée avec les règles de l'importeur du jeu : chemins relatifs sûrs, types de fichiers permis, ni lien symbolique ni chiffrement, limites de taille et de nombre d'entrées. Une archive qui échoue est refusée.
  • Un mod reste ensuite invisible (état pending) jusqu'à ce que l'auteur l'approuve. Rien n'est servi au public avant, même en devinant le nom du fichier.
  • Un skin est public tout de suite, dans la limite de 2 skins par auteur (une nouvelle version d'un skin ne compte pas comme un troisième).
  • Un élément approuvé peut être retiré plus tard, à votre demande ou si un problème apparaît.

Les règles de publication exactes et l'API qui sert le catalogue sont dans le contrat du serveur et le côté client.

3. L'envoyer

Envoyez le .pvmod par la page Contact avec :

  • l'id, le name affiché et la version ;
  • le nom d'auteur à créditer ;
  • une courte description en anglais (et en français si vous voulez), en texte brut ;
  • les permissions que le mod déclare, et pourquoi il en a besoin ;
  • éventuellement des captures d'écran (PNG).

4. Après l'approbation

Le mod apparaît dans le catalogue et dans la page Télécharger du jeu, avec ses permissions affichées avant l'installation. Pour publier une mise à jour, envoyez un nouveau .pvmod avec le même id et une nouvelle version. Les joueurs la voient comme une mise à jour.