▰ Prism
On this page

← All guide pages

Mods

Enable, install and remove mods, what permissions mean, and how to stay safe.

Mods are small TypeScript programs that add things to the game: HUD widgets, judgement sets, scroll-speed systems, game modifiers, extra tabs. A mod is a folder, or one .pvmod file you can share. Most of the game's own HUD and judgement are mods too, and they are ordinary folders in mods\ next to prism.exe.

The Mods tab of the selection screen: rate and chart modifiers
Mods tab: rate and chart modifiers

Enable and disable

Esc menu → Mods lists every mod with its state, the reason if one failed to load, and an on/off switch. Your choice is kept after a restart, and a disabled mod's features disappear. Mods can add their own options under Settings → Mods (this category only exists when some mod needs it) and their own keys under Settings → Controls.

Install and remove

  • Install… on the Mods page, or drop a .pvmod file on the game window.
  • The whole file is checked before anything is written. If the install fails, your mods folder stays as it was.
  • Installing a mod with the same id replaces it: the game tells you whether it was new, an update, a reinstall or a downgrade.
  • Export writes any mod, including the game's own, to a .pvmod file. Uninstall deletes the mod's folder; its stored data is kept in case you reinstall.

Your own mods go in mods\ next to prism.exe, or in the mods folder of your data folder.

Permissions

A mod declares what extra it needs. The Mods page flags it.

Permission What it lets the mod do
stage Draw in the game's native renderer, in sync with the notes. You can take this permission away from a mod, mod by mod.
skinImport Offer to convert an osu! skin that you pick into a Prism skin. The game reads the source and writes the folder; the mod only describes what to produce.

Without a permission, the mod cannot use that feature.

Staying safe

  • Install mods from people you trust. A mod is code that runs in the game's script engine, not a program of its own, and it can only use the functions the game offers.
  • Look at the permissions before enabling a mod.
  • Mods in the Mods catalogue on this site are published only after the author of the game has checked them.
  • If a mod misbehaves, disable or uninstall it on the Mods page.