6 Setup Respite

Setup: Respite

Installation and configuration for Ionrift Respite.

Requirements

• Foundry VTT v12+
• DnD 5e system, PF2e, SFRPG, OSE, or DnD 3.5e
• Ionrift Library (required kernel)
• Simple Calendar (optional, date tracking and rest cooldown checks)

Installation

1. In Foundry, go to Add-on Modules > Install Module.
2. Paste the manifest URL: https://github.com/ionrift-gm/ionrift-respite/releases/latest/download/module.json
3. Click Install. Enable the module in your world under Game Settings > Manage Modules.

Starting a rest

Two ways to open the rest flow:

• Chat command: Type /respite in the chat bar.
• Scene control: Click the campground icon in the token controls toolbar (left side of the canvas).

By default, the module intercepts player rest triggers. When a player clicks Long Rest or Short Rest on their sheet, Respite opens instead of the default dialog. Toggle this off in settings for chat or scene-control triggers only.

Module settings

Settings live under Game Settings > Module Settings > Ionrift Respite.

Quick Setup Profiles

• Simple: Skips the event phase and comfort tracking.
• Standard: Activities, events, and campfire management.
• Survival: Comfort tiers, terrain penalties, exhaustion saves, and meal tracking.
• Gritty Realism: Automatically active when the DnD 5e Gritty Realism variant rule is selected. Long rests scale to the 7-day Downtime Ledger, and short rests use the overnight Bivouac HUD.

Rest Interface Mode

• Camp stations (place on scene): Places a camp directly onto your scene with interactive station tokens. See Camp and Stations for details.
• One window: Panel-only; no map tokens. Campfire, workbench, and cooking stay in one panel. (7-day downtime always uses One Window).

Gameplay Settings

Setting	What it does	Default
Intercept Player Rests	Redirects Long Rest and Short Rest sheet buttons to Respite	On
Armor Sleep Penalties	Characters sleeping in medium or heavy armor recover fewer Hit Dice and cannot reduce exhaustion (Xanathar's). Sentry on watch is exempt.	On
Campfire Warmth	Overnight rests display a campfire stance ribbon. Warm Camp expends 1 firewood and grants warmth healing (+1 or +1d4 HP) per spent Hit Die.	Disabled
Identify and Potion Tasting	Enables Identify spell access, Focus examination, and Potion tasting during rest.	On
Spell Recovery Max Level	Highest slot level recoverable via Arcane Recovery or Natural Recovery.	5
Song of Rest Timing	When the Bard's bonus die applies: end of short rest or with first Hit Die spent.	End of rest
Short Rest: Max Hit Dice	Homebrew rule: Hit Dice heal for maximum value plus CON modifier instead of rolling.	Off
Track Food & Water	Enables meal phases. Characters consume food and water, tracking starvation and dehydration.	Off
Partial Sustenance	Partial food and water fulfillment grants partial benefits instead of hard failure.	Off
Max Food Needs Cap	Ceiling on required food units per character per day across conditions and terrain.	3
Max Water Needs Cap	Ceiling on required water units per character per day across conditions and terrain.	4
Lock Player Quantity Controls	Prevents players from manually adjusting item quantities on sheets.	Off
Lock Attunement to Rest	Restricts attunement changes to active rests.	On

Configuration Menus

Menu	What it does
Food & Diet	Per-character dietary rules, house rules, and physiological presets (e.g. Warforged, Herbivore).
Item Provisions	Centralized auditor to search, filter, and override food, water, shelf life, and dietary flags across world items.
Travel & Activities	Toggles for travel phase and camp activities, including Training XP tiers and Fletching yield tiers.
Custom Recipes	Homebrew recipe editor for cooking and brewing with ingredient alternates and ambitious outputs.
Recovery Rules	Armor sleep rules, spell recovery limits, Song of Rest timing, and Hit Die rules.
Player Restrictions	Rest interception toggles, quantity locks, and attunement restrictions.
Reset Rest State	Clears rest locks, stuck sessions, same-day cooldowns, and orphaned camp tokens, then reloads clients.

Display & Themes

Setting	What it does	Default
UI Theme	Select between Ionrift Glass (translucent frosted glass) and Gilded Slate (opaque panel).	Ionrift Glass
Hide Terrain Banners	Omits the 120px terrain artwork banner at the top of rest windows for a compact layout.	Off
Ambient AFK HUD	Keeps party AFK indicators visible outside of rest.	Off
Debug Mode	Enables console diagnostics for troubleshooting.	Off

Scene Token Integration

Setting	What it does	Default
Campfire Token Name	Canvas token name linked to campfire lighting state.	Campfire
Perimeter Torch Token Name	Canvas token name for perimeter torches. All matches toggle with the campfire.	Perimeter Torch
Auto-Link Torches	Perimeter torches ignite and extinguish with the campfire token.	On

System Support

System	Status	What works
DnD 5e	Full	Activities, recovery, events, campfire, cooking, gritty realism downtime, short rest.
Pathfinder 2e	Core	Core rest flow, campfire, events, activity grid, HP/Focus recovery.
SFRPG	Core	Core rest flow, campfire, and Stamina-aware Hit Die recovery.
DnD 3.5e	Core	Core rest flow, campfire, and HP recovery.
OSE	Core	Core rest flow, campfire, HP/scores recovery, and spell slot refresh.

Related

• Respite: Rest Flow: Walkthrough of standard rests, Gritty Realism 7-day downtime, and the Bivouac HUD.
• Camp and Stations: Canvas station deployment, campfire management, and logistics.
• Cooking and Meals: Provisions auditor, recipe crafting, and cold storage.