▰ Prism Developers
On this page

← All documentation

Submit a mod to the verified catalogue

Build a .pvmod, what the review looks at, how to send it, what happens after approval.

The catalogue on the Mods page of the site (and in the game, Download → Mods) lists mods that the author of Prism has looked at and approved. There is no upload form and no account yet: the author adds each item by hand, and accounts come later. Skins follow the same path but are public as soon as their archive passes the checks.

1. Build the package

  1. Write the mod as a folder with a main.ts (getting started) and try it in the mods folder of the game.
  2. Export it from the game's Mods page. You get <id>-<version>.pvmod, a ZIP archive of the folder (the package rules say what it may contain).
  3. Keep it within 2 MiB for the catalogue. Allowed files: .ts, .ttf, .otf, .png, .json, .md, .txt; main.ts (or index.ts) at the root or in the single top folder.
  4. Choose a stable id (lowercase letters, digits, -, _, .): it identifies your mod for ever and is unique among mods. The version label is free text; a new version of the same id replaces the old one for players.
  5. Declare only the permissions you need (stage, skinImport, ...). Players see them before they install.

2. What happens to a submission

  • The archive is checked with the same rules as the game's own importer: safe relative paths, allowed file types, no symbolic links, no encryption, size and entry limits. An archive that fails is refused.
  • A mod then stays invisible (state pending) until the author approves it. Nothing is served to the public before that, not even by guessing the file name.
  • A skin is public at once, within a limit of 2 skins per author (a new version of a skin does not count as a third).
  • An approved item can be withdrawn later, on your request or if a problem appears.

The exact publication rules and the API that serves the catalogue are in the server contract and the client side.

3. Send it

Send the .pvmod through the Contact page with:

  • the id, the display name and the version;
  • the author name to credit;
  • a short description in English (and in French if you wish), as plain text;
  • the permissions the mod declares, and why it needs them;
  • optionally, screenshots (PNG).

4. After approval

The mod appears in the catalogue and in the game's Download page, with its permissions shown before installation. To publish an update, send a new .pvmod with the same id and a new version. Players see it as an update.