Shattered Codex

Wiki

Modules/SC - Item Rarity Colors

SC - Item Rarity Colors

Foundry v13-v14System D&D 5eFree

SC - Item Rarity Colors

Overview

SC - Item Rarity Colors adds configurable colors and effects to D&D 5e item rarities and spell schools in Foundry VTT.

Use it when you want rarity and spell information to stand out without changing how you already browse or edit items. The module can style supported item sheets, actor inventory rows, the world item directory, and item compendium listings.

Validated module scope:

  • configurable item rarity colors from one editor
  • configurable spell school colors from a separate editor
  • built-in theme presets for rarity tiers and spell schools
  • optional gradients and glow effects where those fields are enabled
  • a rarity list manager for custom keys, labels, order, and visibility
  • optional sync with custom-dnd5e
  • optional color sync to tidy5e-sheet

The item rarity editor uses one window with a rarity selector, theme selector, and a live preview for item sheets, inventory rows, and sidebar entries.

Installation

This module is free.

  1. In Foundry VTT, open Add-on Modules and install the module with this manifest:
code
https://github.com/Shattered-Codex/sc-item-rarity-colors/releases/latest/download/module.json
  1. Enable SC - Item Rarity Colors in your world.
  2. Open Configure Settings > Module Settings > SC - Item Rarity Colors.

Compatibility:

  • Foundry VTT v13 to v14
  • system: dnd5e
  • recommended module: lib-wrapper
  • optional integrations: tidy5e-sheet, custom-dnd5e

Module Settings

The module settings page is the entry point for every major workflow.

From Configure Settings > Module Settings > SC - Item Rarity Colors, you can open:

  • Open documentation
  • Patreon support
  • Configure Rarity Colors
  • Configure Rarity List
  • Sync Colors to Tidy
  • Configure Spell School Colors
  • Enable Debug Logs

Sync Colors to Tidy is only shown when tidy5e-sheet is active.

Configure Item Rarity Colors

Open Configure Rarity Colors to edit item rarity styling.

What you can configure for each rarity:

  • item sheet background color
  • item sheet text color
  • optional secondary color for gradients
  • optional glow effect
  • inventory row gradients, borders, and text colors
  • sidebar gradient and text colors

The editor is built around two selectors:

  • Theme applies a preset baseline to the built-in rarity tiers
  • Rarity switches the form to a specific rarity entry

The footer shows Unsaved changes until you save.

The preview updates while you edit, so you can check item sheet, inventory, and sidebar results before saving.

Manage the Rarity List

Open Configure Rarity List when your world needs custom rarity keys, renamed labels, or a different rarity order.

The rarity list manager lets you:

  • enable or disable the module-managed list
  • rename rarity labels
  • add new custom rarities
  • delete custom rarities
  • drag and drop entries to reorder them
  • hide entries without deleting them

How it behaves:

  • system entries cannot be deleted
  • when saved, the module merges its list with available dnd5e rarity data
  • if custom-dnd5e is active, saved entries are also synced to that module's rarity setting
  • the merged visible list is applied back to CONFIG.DND5E.itemRarity

Use this manager only when you want to change the active rarity list itself. If you only want different colors, stay in Configure Rarity Colors.

Configure Spell School Colors

Open Configure Spell School Colors to style spells by magic school.

This editor has the same overall workflow as the rarity editor, but it works with spell schools instead of item rarities.

What you can configure:

  • spell sheet background and text colors
  • optional gradients and glow
  • inventory row styling for spells
  • sidebar styling for spell entries
  • built-in spell theme presets

Key controls:

  • Magic School selects the school profile
  • Enable Level Variants adds separate profiles for each spell level
  • Spell Level appears only when level variants are enabled

Level variants are optional. Leave them off if you only want one profile per school.

Where Colors Appear

The module applies visuals to active play surfaces, not only to the settings preview.

Item Sheets

Supported item-sheet styling is validated for:

  • the default dnd5e item sheet
  • tidy5e-sheet

Actor Inventories

Inventory rows can use title colors, detail colors, borders, and optional gradients so important items are easier to spot while playing.

World Item Directory

The world item directory can reflect rarity or spell styling directly in the sidebar.

Item Compendium Listings

The module also processes item compendium listings when item rarity or spell data is available in the compendium index.

Spell Entries

Spell entries can use school-based styling, with optional per-level variants for more granular visual separation.

Integrations

Tidy 5e Sheet

The module supports tidy5e-sheet in two separate ways:

  • supported item sheets can use this module's rarity and spell styling
  • Sync Colors to Tidy copies this module's primary item-sheet rarity colors into Tidy's rarity color setting

Important limit:

  • the Tidy sync only copies primary rarity colors
  • it does not sync gradients, glow, text colors, or the rest of your SC Item Rarity Colors configuration

Custom DND5E

When custom-dnd5e is active and its rarity setting exists, the rarity list manager syncs saved entries into custom-dnd5e.item-rarity.

That keeps custom rarity labels and keys aligned across the visual layer and the custom rarity source.

Import, Export, and Debug

Both main editors include Import and Export in the footer.

Supported exports:

  • item rarity settings
  • spell school settings

These exports use Foundry's file picker and save JSON configuration files, which is useful when you want to:

  • move a setup between worlds
  • keep a backup before major visual changes
  • share a configuration with another GM

The module settings page also includes Enable Debug Logs, a client setting that logs rarity-color flow details to the browser console for troubleshooting.

Notes and Troubleshooting

Keep these constraints in mind:

  • item rarity configuration and spell school configuration are separate editors
  • world-facing configuration is stored in world settings
  • debug logs and the automatic support-card visibility setting are client-side
  • lib-wrapper is recommended, not required

If your colors do not appear where you expect:

  1. Confirm the module is enabled in the world.
  2. Confirm the item or spell has a recognized rarity or spell school value.
  3. Save the editor after making changes and reopen the target sheet or listing.
  4. If you use Tidy, remember that Sync Colors to Tidy only updates Tidy rarity colors, not the rest of this module's visual settings.
  5. Turn on Enable Debug Logs if you need console output for diagnosis.