module

Compendium Browser — Black Flag / Tales of the Valiant (ToV)

Latest version	1.1.0
Minimum Core
Compatible Core
Last updated	3 months ago
Created	3 months ago
Authors	Jon Michaels Author URL @jonmichaels#9614
Languages	English
Systems	Black-flag
Project source	Project URL

Description
Comments (0)

A compendium browser for Black Flag Roleplaying (Tales of the Valiant). Browse and filter spells, items, monsters, classes, lineages, heritages, talents, and more. Ported from the dnd5e built-in compendium browser.

Features

Feature	Description
10 tabs	Classes, Subclasses, Lineages, Heritages, Talents, Backgrounds, Items, Spells, Monsters, Vehicles
Rich filtering	Tab-specific sidebar filters — class, rarity, spell circle, school, magic source, tags, CR, size, creature type, price
3-state filters	Toggle between off → include (green ✓) → exclude (red −) → off
Type checkboxes	Filter by item subtypes on tabs that support them
Name search	Debounced text search across compendium indexes
Source configuration	GM-configurable compendium source selection per package
Drag-and-drop	Drag entries directly into actor sheets or the sidebar
Lazy loading	Scroll to load more results in large collections
Document preview	Click any entry title to open its full document sheet
Row dividers	Subtle gray lines between result rows for readability
Hover glow	Visual feedback on search and filter inputs
Hotkey toggle	`Shift+Alt+B` opens or closes the browser from anywhere in Foundry

Installation

In Foundry VTT:

Go to Add-on Modules → Install Module
Paste the manifest URL: https://github.com/jonmichaels/compendium-browser-bf/releases/latest/download/module.json
Click Install

Manual: Download the latest release zip and extract to Data/modules/compendium-browser-bf/.

Requirements

Foundry VTT v13+
Black Flag Roleplaying (Tales of the Valiant) system v2.0+

How It Works

Activate the module in your world's Module Management
Open the Compendium Packs sidebar
Click the 📖 Open Compendium Browser button at the top
Select a tab — the sidebar loads filters relevant to that content type
Use the sidebar to filter results or search by name
Click an entry title to open its full document sheet

Filters are tab-specific and resolve from the compendium index for fast filtering. Class filter on the Subclasses screen loads full documents for accurate parent class matching.

Development

npm install
npm run build    # production build (webpack)
npm run watch    # development watch mode

Symlink the project directory into Foundry's Data/modules/compendium-browser-bf/ for live testing.

Credits

This module is a Black Flag / Tales of the Valiant port of the dnd5e built-in compendium browser.

Original dnd5e compendium browser: foundryvtt/dnd5e — built into the dnd5e system
Black Flag port: Jon Michaels, coded by Hephaestus (AI agent via Hermes Agent)

License

MIT

0 Comments