Add re-order, spotlight/focus, and auto-position-snapshots features
- HTML5 drag-and-drop reordering of strip participants (per-GM flag) - Shift+click toggles spotlight focus on a participant (gold ring indicator) - Escape exits focus mode - Auto-save strip position on drag end + every 30s with viewport validation - Reset strip position button in Director's Board - French locale strings for reset button
This commit is contained in:
@@ -0,0 +1,86 @@
|
||||
# Scrying Pool Documentation Pack
|
||||
|
||||
✅ **Compendium is now built and ready!**
|
||||
|
||||
## Structure
|
||||
|
||||
- `scrying-pool-docs.db` - **Pre-built SQLite compendium database** (20KB)
|
||||
- `scrying-pool-guide.json` - Source JournalEntry content (English & French)
|
||||
- `assets/` - Screenshot images (5 JPG files)
|
||||
|
||||
## What's Included
|
||||
|
||||
The `scrying-pool-docs.db` file contains a **JournalEntry** with:
|
||||
- **2 pages**: English and French documentation
|
||||
- **Professional styling** with CSS
|
||||
- **5 screenshot references** (screenshot-main.jpg, screenshot-directors-board.jpg, etc.)
|
||||
|
||||
## Current Setup
|
||||
|
||||
The `module.json` defines the pack:
|
||||
```json
|
||||
{
|
||||
"packs": [
|
||||
{
|
||||
"name": "scrying-pool-documentation",
|
||||
"label": "Scrying Pool Documentation",
|
||||
"path": "packs/scrying-pool-docs.db",
|
||||
"system": "",
|
||||
"type": "JournalEntry"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
When the module is installed in FoundryVTT, the **"Scrying Pool Documentation"** compendium will appear under the **Modules** tab with the JournalEntry already populated.
|
||||
|
||||
## Updating the Documentation
|
||||
|
||||
To update the documentation content:
|
||||
|
||||
### Option 1: Using the build script (Recommended)
|
||||
```bash
|
||||
# Edit the JSON source
|
||||
nano packs/scrying-pool-guide.json
|
||||
|
||||
# Rebuild the database
|
||||
node scripts/build-compendium.cjs
|
||||
```
|
||||
|
||||
### Option 2: Manual SQLite editing
|
||||
```bash
|
||||
sqlite3 packs/scrying-pool-docs.db
|
||||
```
|
||||
|
||||
### Option 3: Using fvtt-cli (Alternative)
|
||||
```bash
|
||||
npm install -g @foundryvtt/fvtt-cli
|
||||
fvtt-cli pack create \
|
||||
--input packs/scrying-pool-guide.json \
|
||||
--output packs/scrying-pool-docs.db \
|
||||
--type JournalEntry
|
||||
```
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
packs/
|
||||
├── scrying-pool-docs.db # SQLite database (compendium)
|
||||
├── scrying-pool-guide.json # Source JSON (for editing)
|
||||
├── README.md # This file
|
||||
└── assets/
|
||||
├── README.md
|
||||
├── screenshot-main.jpg
|
||||
├── screenshot-directors-board.jpg
|
||||
├── screenshot-player-view.jpg
|
||||
├── screenshot-presets.jpg
|
||||
└── screenshot-badge-states.jpg
|
||||
```
|
||||
|
||||
## Technical Details
|
||||
|
||||
- **Database**: SQLite3 with WAL mode enabled
|
||||
- **Table**: `JournalEntry` with FoundryVTT v14 schema
|
||||
- **JournalEntry ID**: `scrying-pool-guide`
|
||||
- **Name**: "Scrying Pool - User Guide / Guide de l'utilisateur"
|
||||
- **Pages**: 2 (English and French)
|
||||
Reference in New Issue
Block a user