Skip to content

docs(seasons-and-stars): automated documentation update #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(seasons-and-stars): automated documentation update #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions seasons-and-stars/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A calendar and timekeeping module for Foundry VTT v13+ with clean architecture a

## 🌟 Features

### ✅ **Available Now (v0.16.0)**
### ✅ **Available Now (v0.17.1)**
- **Modern UI**: Clean, responsive calendar interface with ApplicationV2 architecture
- **Multiple Calendar Views**: Full calendar widget, compact mini widget, and monthly grid view
- **Configurable Quick Time Buttons**: Customizable time advancement buttons with live preview and dedicated mini widget controls
Expand Down Expand Up @@ -81,17 +81,17 @@ Hooks.on(SimpleCalendar.Hooks.DateTimeChange, (data) => {

## 🎉 Recent Updates

### **Current Release** (v0.16.0)
### **Current Release** (v0.17.1)
- ✅ **Calendar Source Verification**: Automatic verification of calendar source availability
- ✅ **Coriolis Calendars**: Added Third Horizon and The Great Dark calendars in sci-fi pack
- ✅ **Golarion Calendar Improvements**: Aligned leap cycle with official Pathfinder lore
- ✅ **Mini Widget Improvements**: Dynamic width adjustment to match content
- ✅ **Synchronous Initialization**: Improved bridge compatibility with synchronous module initialization
- ✅ **Viewport Bounds Checking**: Mini calendar widget stays within viewport boundaries
- ✅ **Movable Mini Widget**: Drag-and-drop positioning with pinning support
- ✅ **JSON Schema Validation**: Calendar format validation system for reliable calendar data
- ✅ **External Calendar Loading**: Hook system for modules to register calendars programmatically
- ✅ **Calendar Pack Auto-Detection**: Automatic discovery of calendar modules with `seasons-and-stars-*` naming
- ✅ **Dark Sun Calendar Updates**: Canon moon colors and cycles for authentic Dark Sun campaigns
- ✅ **Module URL Protocol**: Support for `module:module-id` URL references in calendar loading
- ✅ **SmallTime Integration Improvements**: Better detection and visual consistency
- ✅ **Enhanced Error Handling**: Better logging and graceful failure recovery
- ✅ **Input Validation**: API protection with helpful error messages
- ✅ **TypeScript Support**: Type definitions for reliable development
- ✅ **Testing**: Comprehensive test suite with reliable widget API coverage

## 🗺️ Development Roadmap

Expand Down
4 changes: 2 additions & 2 deletions seasons-and-stars/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ When using multiple modules:
## Game System Compatibility

### Verified Compatible Systems
- ✅ **D&D 5e**: Complete integration
- ✅ **D&D 5e**: Comprehensive integration
- ✅ **Pathfinder 2e**: Full calendar support
- ✅ **World Building**: Designed for custom settings
- ✅ **Simple Worldbuilding**: Perfect for homebrew
- ✅ **Simple Worldbuilding**: Ideal for homebrew

### Tested Systems
- ✅ **Forbidden Lands**: Calendar integration tested
Expand Down
4 changes: 2 additions & 2 deletions seasons-and-stars/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ Each calendar shows:
- Standard Earth calendar with 12 months
- Leap year support (February 29th every 4 years)
- Familiar month and day names
- Perfect for modern or historical Earth settings
- Ideal for modern or historical Earth settings

### Fantasy Calendars

**Roshar Calendar** (Stormlight Archive)
- Based on Brandon Sanderson's Stormlight Archive series
- 10 months of 50 days each (500-day year)
- Unique Vorin calendar system with cultural context
- Perfect for campaigns in the Stormlight Archive setting
- Ideal for campaigns in the Stormlight Archive setting

**Vale Reckoning** (Example Fantasy Calendar)
- Custom month names reflecting fantasy world
Expand Down