Skip to content

StuartJAtkinson/foundryvtt-session-scheduler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

Session Availability Planner

A When2Meet-style availability polling system for Foundry VTT. Coordinate real-world session times by having players mark when they're available, then see the overlap to find the best time to play.

Features

  • Visual Availability Grid: A weekly calendar grid where players click to mark available time slots
  • Heatmap Visualization: See at a glance where availability overlaps (green = more people available)
  • Real-time Updates: Changes sync instantly across all connected clients via WebSocket
  • Best Times Finder: Automatically highlights slots where everyone is available
  • Drag Selection: Click and drag to quickly select multiple time slots
  • GM Controls: Start/stop polls, navigate weeks, reset responses
  • Player Tooltips: Hover to see exactly who is available for each slot

Installation

Manual Installation

  1. Download or clone this repository
  2. Copy the session-availability folder to your Foundry VTT Data/modules/ directory
  3. Restart Foundry VTT
  4. Enable the module in your world's Module Management settings

Manifest URL

https://raw.githubusercontent.com/StuartJAtkinson/session-availability/main/module.json

Usage

Opening the Planner

  • Click the "Availability" button above the player list in the sidebar
  • Or type /availability in the chat

For Players

  1. Wait for your GM to start a poll
  2. Click on time slots when you're available (they'll turn blue with a checkmark)
  3. Click again to deselect
  4. Drag across multiple slots for quick selection
  5. Use "Clear Mine" to start over

For Game Masters

  1. Click "Start Poll" to begin a new availability poll
  2. Use the arrow buttons to navigate to different weeks
  3. View the heatmap to see where availability overlaps
  4. Green cells with higher numbers = more people available
  5. Check "Best Times" in the footer for slots where everyone can make it
  6. Click "Close Poll" when you've found your time

How It Works

Color Meaning
Dark (empty) No one available
Light green Some players available
Bright green Everyone available
Blue border + ✓ Your selection

Numbers in each cell show how many players are available for that slot.

Configuration

In Module Settings, GMs can toggle:

  • Show Player Names: Whether to show player names in tooltips

Technical Details

  • Compatibility: Foundry VTT v11 - v13
  • Socket: Uses Foundry's socket system for real-time sync
  • Storage: Availability data stored in world settings (persists across sessions)
  • Default Time Range: 5 PM - 11 PM (configurable in future versions)

API

Other modules or macros can access:

// Open the planner window
game.modules.get("session-availability").api.openPlanner();

// Get current availability data
game.modules.get("session-availability").api.getAvailabilityData();

// Calculate overlap from responses
game.modules.get("session-availability").api.calculateOverlap(responses);

Roadmap

  • Configurable time ranges via settings menu
  • Export best times to chat/journal
  • Discord webhook integration
  • Recurring weekly patterns
  • Time zone support
  • Integration with Simple Calendar for in-game dates

License

MIT License - feel free to use, modify, and distribute.

Credits

Created by StuartJAtkinson for the Foundry VTT community.

Inspired by When2Meet and the gap identified in existing Foundry modules for real-world session scheduling.

About

Foundry Module to allow users to define work patterns then determine next free periods

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors