Skip to content

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

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 #10

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
2 changes: 1 addition & 1 deletion seasons-and-stars/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ Hooks.on('seasons-stars:ready', (data) => {
});
```

#### `seasons-stars:registerExternalCalendars` (Added in v0.8.0)
#### `seasons-stars:registerExternalCalendars` (Added in v0.7.0)

Fired during initialization to allow modules to register calendars programmatically. This provides an alternative to calendar packs for dynamic calendar registration.

Expand Down
6 changes: 3 additions & 3 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.7.0)**
- **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 @@ -76,12 +76,12 @@ Hooks.on(SimpleCalendar.Hooks.DateTimeChange, (data) => {
## 📋 Requirements

- **Foundry VTT**: v13 or higher
- **Compatibility**: System-agnostic design compatible with Foundry's game systems
- **Compatibility**: Designed to work with D&D 5e, PF2e, Dragonbane, and other systems. PF2e includes dedicated integration features
- **Permissions**: GM required for time changes

## 🎉 Recent Updates

### **Current Release** (v0.16.0)
### **Current Release** (v0.7.0)
- ✅ **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
Expand Down
2 changes: 1 addition & 1 deletion seasons-and-stars/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ const ssDate = { year: 2024, month: 12, day: 25 }; // December 25th

### Feature Comparison

#### ✅ **Available in Seasons & Stars (v0.16.0)**
#### ✅ **Available in Seasons & Stars (v0.7.0)**
- ✅ 16+ calendar systems including Roshar (Stormlight Archive)
- ✅ Configurable quick time advancement controls
- ✅ Play/pause time advancement with automatic combat pause
Expand Down
2 changes: 1 addition & 1 deletion seasons-and-stars/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ When using multiple modules:
- ✅ **D&D 5e**: Complete integration
- ✅ **Pathfinder 2e**: Full calendar support
- ✅ **World Building**: Designed for custom settings
- ✅ **Simple Worldbuilding**: Perfect for homebrew
- ✅ **Simple Worldbuilding**: Good for homebrew settings

### Tested Systems
- ✅ **Forbidden Lands**: Calendar integration tested
Expand Down
6 changes: 3 additions & 3 deletions seasons-and-stars/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Seasons & Stars aims to be a **reliable and extensible** calendar solution for F
## 📅 Development Phases

## ✅ Phase 1: Foundation (Complete)
*Beta Release - Q4 2024*
*Beta Release - Q1 2025*

### Core Features ✅
- [x] **Modern Calendar System**
Expand Down Expand Up @@ -67,7 +67,7 @@ Seasons & Stars aims to be a **reliable and extensible** calendar solution for F

---

## ✅ Phase 2: Core Integration (Q4 2024 - COMPLETE)
## ✅ Phase 2: Core Integration (Q1 2025 - COMPLETE)
*Enhanced Compatibility Release*

### Notes System (Basic) ✅
Expand Down Expand Up @@ -212,7 +212,7 @@ Seasons & Stars aims to be a **reliable and extensible** calendar solution for F

---

## 🔮 Phase 4: Community & Ecosystem (Q3 2025)
## 🔮 Phase 4: Community & Ecosystem (Q4 2025)
*Ecosystem Expansion*

### Community Features 📋
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
- Suitable 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
- Suitable for campaigns in the Stormlight Archive setting

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