Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5430d4c3ab | |||
| fc4ea17789 | |||
| 02bcc8b4af | |||
| d4d0bde0c0 | |||
| cbbab3d09f | |||
| 36605751cd | |||
| 4d9a07727a | |||
| 513dee8fa9 | |||
| 19ddf86c7b | |||
| 28be65f092 | |||
| 65913de2cb | |||
| 25f1fd27d9 |
@@ -6,6 +6,25 @@ project follows [Semantic Versioning](https://semver.org/).
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.47.0] — 2026-07-13
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **"What's new" on update.** The first launch after an update shows a
|
||||||
|
one-time card summarising what changed — like this one, right now.
|
||||||
|
Dismiss it and it never repeats; fresh installs never see it. (#180)
|
||||||
|
- **Situational tips.** Two one-time teaches that fire from play, not a
|
||||||
|
tour: staring at a stuck board for a while points you at Hint, and an
|
||||||
|
engaged game quietly mentions the long-press quick-action menu —
|
||||||
|
unless you've already found it yourself. (#181)
|
||||||
|
- **UI scale.** Settings → Accessibility now has a UI Scale control
|
||||||
|
(90% / 100% / 115% / 130%) that resizes every menu, button, and HUD
|
||||||
|
element live. The table always fits your screen regardless. (#182)
|
||||||
|
- **Hold `/` for shortcuts** (desktop). A reference card of every
|
||||||
|
keyboard binding appears while `/` is held. The onboarding tour and
|
||||||
|
this card now share one binding table, so they can never disagree —
|
||||||
|
the tour's copy had drifted from reality. (#183)
|
||||||
|
|
||||||
## [0.46.0] — 2026-07-13
|
## [0.46.0] — 2026-07-13
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
@@ -257,6 +257,32 @@ pub struct Settings {
|
|||||||
/// deserialize cleanly to `GameMode::Classic` via `#[serde(default)]`.
|
/// deserialize cleanly to `GameMode::Classic` via `#[serde(default)]`.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub last_mode: GameMode,
|
pub last_mode: GameMode,
|
||||||
|
/// The release version whose "What's new" card the player has already
|
||||||
|
/// seen (e.g. `"0.46.0"`). Empty on installs that predate the card,
|
||||||
|
/// which correctly reads as "there is news to show" after an upgrade;
|
||||||
|
/// fresh installs stamp it silently when onboarding completes. Older
|
||||||
|
/// `settings.json` files deserialize cleanly to `""` via
|
||||||
|
/// `#[serde(default)]`.
|
||||||
|
#[serde(default)]
|
||||||
|
pub last_seen_whats_new: String,
|
||||||
|
/// `true` once the one-shot "Stuck? Try a hint" contextual tip has
|
||||||
|
/// fired (or been suppressed as unnecessary). Phase I teach: fired
|
||||||
|
/// by the situation, shown once, like `shown_achievement_onboarding`.
|
||||||
|
#[serde(default)]
|
||||||
|
pub shown_stall_hint_tip: bool,
|
||||||
|
/// `true` once the one-shot radial-menu contextual tip has fired —
|
||||||
|
/// or the player has already opened the radial menu on their own,
|
||||||
|
/// which marks the tip as unnecessary without showing it.
|
||||||
|
#[serde(default)]
|
||||||
|
pub shown_radial_menu_tip: bool,
|
||||||
|
/// Global UI scale multiplier applied to all UI chrome (HUD, modals,
|
||||||
|
/// action bar) — the table itself stays window-fit via
|
||||||
|
/// `compute_layout`. Cycles through 0.9 / 1.0 / 1.15 / 1.3 in
|
||||||
|
/// Settings → Accessibility; clamped to `[UI_SCALE_MIN,
|
||||||
|
/// UI_SCALE_MAX]` by [`Settings::sanitized`]. Older `settings.json`
|
||||||
|
/// files deserialize cleanly to `1.0` via the serde default.
|
||||||
|
#[serde(default = "default_ui_scale")]
|
||||||
|
pub ui_scale: f32,
|
||||||
/// Custom public name displayed on the leaderboard. When `None`, the
|
/// Custom public name displayed on the leaderboard. When `None`, the
|
||||||
/// player's server `username` is used instead. Trimmed to 32 characters
|
/// player's server `username` is used instead. Trimmed to 32 characters
|
||||||
/// before submission. Older `settings.json` files written before this
|
/// before submission. Older `settings.json` files written before this
|
||||||
@@ -365,6 +391,16 @@ fn default_replay_move_interval_secs() -> f32 {
|
|||||||
0.45
|
0.45
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Lowest / highest UI scale the settings row offers; anything outside
|
||||||
|
/// (hand-edited settings.json) clamps here on load.
|
||||||
|
pub const UI_SCALE_MIN: f32 = 0.9;
|
||||||
|
/// See [`UI_SCALE_MIN`].
|
||||||
|
pub const UI_SCALE_MAX: f32 = 1.3;
|
||||||
|
|
||||||
|
fn default_ui_scale() -> f32 {
|
||||||
|
1.0
|
||||||
|
}
|
||||||
|
|
||||||
fn default_matomo_site_id() -> u32 {
|
fn default_matomo_site_id() -> u32 {
|
||||||
1
|
1
|
||||||
}
|
}
|
||||||
@@ -425,6 +461,10 @@ impl Default for Settings {
|
|||||||
replay_move_interval_secs: default_replay_move_interval_secs(),
|
replay_move_interval_secs: default_replay_move_interval_secs(),
|
||||||
last_difficulty: None,
|
last_difficulty: None,
|
||||||
last_mode: GameMode::Classic,
|
last_mode: GameMode::Classic,
|
||||||
|
last_seen_whats_new: String::new(),
|
||||||
|
shown_stall_hint_tip: false,
|
||||||
|
shown_radial_menu_tip: false,
|
||||||
|
ui_scale: default_ui_scale(),
|
||||||
leaderboard_display_name: None,
|
leaderboard_display_name: None,
|
||||||
leaderboard_opted_in: false,
|
leaderboard_opted_in: false,
|
||||||
take_from_foundation: true,
|
take_from_foundation: true,
|
||||||
@@ -460,6 +500,7 @@ impl Settings {
|
|||||||
replay_move_interval_secs: self
|
replay_move_interval_secs: self
|
||||||
.replay_move_interval_secs
|
.replay_move_interval_secs
|
||||||
.clamp(REPLAY_MOVE_INTERVAL_MIN_SECS, REPLAY_MOVE_INTERVAL_MAX_SECS),
|
.clamp(REPLAY_MOVE_INTERVAL_MIN_SECS, REPLAY_MOVE_INTERVAL_MAX_SECS),
|
||||||
|
ui_scale: self.ui_scale.clamp(UI_SCALE_MIN, UI_SCALE_MAX),
|
||||||
selected_theme_id,
|
selected_theme_id,
|
||||||
..self
|
..self
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,194 @@
|
|||||||
|
//! Hold-`/` hotkey cheat sheet (Phase J).
|
||||||
|
//!
|
||||||
|
//! While `/` is held on a keyboard platform, a lightweight overlay
|
||||||
|
//! lists every binding from [`crate::hotkeys::HOTKEYS`] — the same
|
||||||
|
//! table the onboarding slide teaches from, so the two can never
|
||||||
|
//! disagree. Releasing the key hides it instantly; it never captures
|
||||||
|
//! input, never pauses the game, and never spawns while a modal owns
|
||||||
|
//! the screen (which also keeps it out of the seed-entry text field's
|
||||||
|
//! way).
|
||||||
|
//!
|
||||||
|
//! Not a `spawn_modal` modal on purpose: modals are sticky and guarded;
|
||||||
|
//! this is a momentary reference card, closer to a tooltip than a
|
||||||
|
//! dialog.
|
||||||
|
|
||||||
|
use bevy::input::ButtonInput;
|
||||||
|
use bevy::prelude::*;
|
||||||
|
|
||||||
|
use crate::font_plugin::FontResource;
|
||||||
|
use crate::hotkeys::HOTKEYS;
|
||||||
|
use crate::platform::SHOW_KEYBOARD_ACCELERATORS;
|
||||||
|
use crate::ui_modal::ModalScrim;
|
||||||
|
use crate::ui_theme::{
|
||||||
|
ACCENT_PRIMARY, BG_ELEVATED, BORDER_STRONG, HighContrastBorder, RADIUS_MD, TEXT_PRIMARY,
|
||||||
|
TEXT_SECONDARY, TYPE_BODY, TYPE_CAPTION, VAL_SPACE_1, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4,
|
||||||
|
Z_TOOLTIP,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Marker on the cheat-sheet overlay root.
|
||||||
|
#[derive(Component, Debug)]
|
||||||
|
pub struct CheatSheetOverlay;
|
||||||
|
|
||||||
|
/// Registers the hold-`/` driver. Inert on touch-first builds.
|
||||||
|
pub struct CheatSheetPlugin;
|
||||||
|
|
||||||
|
impl Plugin for CheatSheetPlugin {
|
||||||
|
fn build(&self, app: &mut App) {
|
||||||
|
app.init_resource::<ButtonInput<KeyCode>>()
|
||||||
|
.add_systems(Update, drive_cheat_sheet);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shows the overlay while `/` is held (and no modal owns the screen);
|
||||||
|
/// hides it the frame the key releases.
|
||||||
|
fn drive_cheat_sheet(
|
||||||
|
keys: Res<ButtonInput<KeyCode>>,
|
||||||
|
scrims: Query<(), With<ModalScrim>>,
|
||||||
|
existing: Query<Entity, With<CheatSheetOverlay>>,
|
||||||
|
font_res: Option<Res<FontResource>>,
|
||||||
|
mut commands: Commands,
|
||||||
|
) {
|
||||||
|
if !SHOW_KEYBOARD_ACCELERATORS {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let held = keys.pressed(KeyCode::Slash);
|
||||||
|
if held && existing.is_empty() && scrims.is_empty() {
|
||||||
|
spawn_cheat_sheet(&mut commands, font_res.as_deref());
|
||||||
|
} else if !held {
|
||||||
|
for entity in &existing {
|
||||||
|
commands.entity(entity).despawn();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn spawn_cheat_sheet(commands: &mut Commands, font_res: Option<&FontResource>) {
|
||||||
|
let font_handle = font_res.map(|f| f.0.clone()).unwrap_or_default();
|
||||||
|
let font_header = TextFont {
|
||||||
|
font: font_handle.clone(),
|
||||||
|
font_size: TYPE_BODY,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
let font_keys = TextFont {
|
||||||
|
font: font_handle.clone(),
|
||||||
|
font_size: TYPE_CAPTION,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
let font_desc = TextFont {
|
||||||
|
font: font_handle,
|
||||||
|
font_size: TYPE_CAPTION,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
|
||||||
|
commands
|
||||||
|
.spawn((
|
||||||
|
CheatSheetOverlay,
|
||||||
|
Node {
|
||||||
|
position_type: PositionType::Absolute,
|
||||||
|
right: Val::Px(16.0),
|
||||||
|
top: Val::Percent(8.0),
|
||||||
|
flex_direction: FlexDirection::Column,
|
||||||
|
row_gap: VAL_SPACE_1,
|
||||||
|
padding: UiRect::all(VAL_SPACE_4),
|
||||||
|
border: UiRect::all(Val::Px(1.0)),
|
||||||
|
border_radius: BorderRadius::all(Val::Px(RADIUS_MD)),
|
||||||
|
max_height: Val::Percent(84.0),
|
||||||
|
overflow: Overflow::scroll_y(),
|
||||||
|
..default()
|
||||||
|
},
|
||||||
|
BackgroundColor(BG_ELEVATED),
|
||||||
|
BorderColor::all(BORDER_STRONG),
|
||||||
|
HighContrastBorder::with_default(BORDER_STRONG),
|
||||||
|
GlobalZIndex(Z_TOOLTIP),
|
||||||
|
))
|
||||||
|
.with_children(|panel| {
|
||||||
|
panel.spawn((
|
||||||
|
Text::new("Keyboard shortcuts"),
|
||||||
|
font_header.clone(),
|
||||||
|
TextColor(TEXT_PRIMARY),
|
||||||
|
Node {
|
||||||
|
margin: UiRect::bottom(VAL_SPACE_2),
|
||||||
|
..default()
|
||||||
|
},
|
||||||
|
));
|
||||||
|
for row in HOTKEYS {
|
||||||
|
panel
|
||||||
|
.spawn(Node {
|
||||||
|
flex_direction: FlexDirection::Row,
|
||||||
|
column_gap: VAL_SPACE_3,
|
||||||
|
..default()
|
||||||
|
})
|
||||||
|
.with_children(|line| {
|
||||||
|
line.spawn((
|
||||||
|
Text::new(row.keys),
|
||||||
|
font_keys.clone(),
|
||||||
|
TextColor(ACCENT_PRIMARY),
|
||||||
|
Node {
|
||||||
|
min_width: Val::Px(110.0),
|
||||||
|
..default()
|
||||||
|
},
|
||||||
|
));
|
||||||
|
line.spawn((
|
||||||
|
Text::new(row.description),
|
||||||
|
font_desc.clone(),
|
||||||
|
TextColor(TEXT_SECONDARY),
|
||||||
|
));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn app() -> App {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins)
|
||||||
|
.add_plugins(CheatSheetPlugin);
|
||||||
|
app.update();
|
||||||
|
app
|
||||||
|
}
|
||||||
|
|
||||||
|
fn overlay_count(app: &mut App) -> usize {
|
||||||
|
app.world_mut()
|
||||||
|
.query::<&CheatSheetOverlay>()
|
||||||
|
.iter(app.world())
|
||||||
|
.count()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn holding_slash_shows_and_release_hides() {
|
||||||
|
let mut app = app();
|
||||||
|
app.world_mut()
|
||||||
|
.resource_mut::<ButtonInput<KeyCode>>()
|
||||||
|
.press(KeyCode::Slash);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(overlay_count(&mut app), 1, "held / must show the sheet");
|
||||||
|
// Still held on later frames: exactly one overlay, no stacking.
|
||||||
|
app.update();
|
||||||
|
assert_eq!(overlay_count(&mut app), 1);
|
||||||
|
|
||||||
|
app.world_mut()
|
||||||
|
.resource_mut::<ButtonInput<KeyCode>>()
|
||||||
|
.release(KeyCode::Slash);
|
||||||
|
app.update();
|
||||||
|
app.update();
|
||||||
|
assert_eq!(overlay_count(&mut app), 0, "release must hide the sheet");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn suppressed_while_a_modal_is_open() {
|
||||||
|
let mut app = app();
|
||||||
|
app.world_mut().spawn(ModalScrim);
|
||||||
|
app.update();
|
||||||
|
app.world_mut()
|
||||||
|
.resource_mut::<ButtonInput<KeyCode>>()
|
||||||
|
.press(KeyCode::Slash);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
overlay_count(&mut app),
|
||||||
|
0,
|
||||||
|
"the sheet must not spawn over a modal (or into a text field)"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,309 @@
|
|||||||
|
//! Contextual one-time tips (Phase I of the 2026-07 UI redesign).
|
||||||
|
//!
|
||||||
|
//! Everything the first-run onboarding doesn't cover is invisible until
|
||||||
|
//! stumbled upon: hint cycling, the radial quick-action menu. These
|
||||||
|
//! tips fire **from the situation, not a tour** — each exactly once,
|
||||||
|
//! recorded in `Settings` like `shown_achievement_onboarding`:
|
||||||
|
//!
|
||||||
|
//! - **Stall tip** — after [`STALL_TIP_SECS`] with no board change in an
|
||||||
|
//! active game, an info toast points at Hint. A player staring at a
|
||||||
|
//! stuck board is the one moment the tip is welcome.
|
||||||
|
//! - **Radial tip** — once a game reaches [`RADIAL_TIP_MIN_MOVES`] moves
|
||||||
|
//! (an engaged player) and the radial menu has never been opened, an
|
||||||
|
//! info toast teaches the long-press / right-click gesture. Opening
|
||||||
|
//! the radial organically marks the tip as unnecessary — it is never
|
||||||
|
//! shown to someone who already knows.
|
||||||
|
//!
|
||||||
|
//! Tips render through the queued [`InfoToastEvent`] path, so they share
|
||||||
|
//! the unified toast stack and never interrupt play.
|
||||||
|
|
||||||
|
use bevy::prelude::*;
|
||||||
|
|
||||||
|
use solitaire_data::save_settings_to;
|
||||||
|
|
||||||
|
use crate::events::{InfoToastEvent, StateChangedEvent};
|
||||||
|
use crate::game_plugin::GameMutation;
|
||||||
|
use crate::pause_plugin::PausedResource;
|
||||||
|
use crate::platform::SHOW_KEYBOARD_ACCELERATORS;
|
||||||
|
use crate::radial_menu::RightClickRadialState;
|
||||||
|
use crate::resources::GameStateResource;
|
||||||
|
use crate::settings_plugin::{SettingsResource, SettingsStoragePath};
|
||||||
|
use crate::ui_modal::ModalScrim;
|
||||||
|
|
||||||
|
/// Seconds without any board change before the stall tip fires.
|
||||||
|
/// Long enough that normal thinking never triggers it; short enough to
|
||||||
|
/// reach a genuinely stuck player before they quit.
|
||||||
|
const STALL_TIP_SECS: f32 = 45.0;
|
||||||
|
|
||||||
|
/// Move count at which an engaged player earns the radial-menu teach.
|
||||||
|
const RADIAL_TIP_MIN_MOVES: u32 = 15;
|
||||||
|
|
||||||
|
/// Stall-tip copy per platform input vocabulary.
|
||||||
|
const STALL_TIP: &str = if SHOW_KEYBOARD_ACCELERATORS {
|
||||||
|
"Stuck? Press H for a hint."
|
||||||
|
} else {
|
||||||
|
"Stuck? Tap Hint in the bottom bar for a suggested move."
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Radial-tip copy per platform input vocabulary.
|
||||||
|
const RADIAL_TIP: &str = if SHOW_KEYBOARD_ACCELERATORS {
|
||||||
|
"Tip: right-click a card for quick actions."
|
||||||
|
} else {
|
||||||
|
"Tip: long-press a card for quick actions."
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Seconds of board inactivity, frozen while paused / a modal is open,
|
||||||
|
/// reset by every [`StateChangedEvent`].
|
||||||
|
#[derive(Resource, Debug, Default)]
|
||||||
|
pub struct StallClock(pub f32);
|
||||||
|
|
||||||
|
/// Registers the stall clock and the two tip triggers.
|
||||||
|
pub struct ContextualTipsPlugin;
|
||||||
|
|
||||||
|
impl Plugin for ContextualTipsPlugin {
|
||||||
|
fn build(&self, app: &mut App) {
|
||||||
|
app.init_resource::<StallClock>()
|
||||||
|
.add_message::<InfoToastEvent>()
|
||||||
|
.add_message::<StateChangedEvent>()
|
||||||
|
.add_systems(
|
||||||
|
Update,
|
||||||
|
(
|
||||||
|
tick_stall_clock,
|
||||||
|
fire_stall_hint_tip
|
||||||
|
.in_set(crate::game_plugin::InfoToastWriters)
|
||||||
|
.ambiguous_with(crate::game_plugin::InfoToastWriters),
|
||||||
|
observe_radial_menu_use,
|
||||||
|
fire_radial_menu_tip
|
||||||
|
.in_set(crate::game_plugin::InfoToastWriters)
|
||||||
|
.ambiguous_with(crate::game_plugin::InfoToastWriters),
|
||||||
|
)
|
||||||
|
.chain()
|
||||||
|
.after(GameMutation),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Advances the stall clock; resets on any board change; freezes while
|
||||||
|
/// paused, while a modal owns the screen, or when the game is over.
|
||||||
|
fn tick_stall_clock(
|
||||||
|
time: Res<Time>,
|
||||||
|
mut state_events: MessageReader<StateChangedEvent>,
|
||||||
|
paused: Option<Res<PausedResource>>,
|
||||||
|
scrims: Query<(), With<ModalScrim>>,
|
||||||
|
game: Option<Res<GameStateResource>>,
|
||||||
|
mut clock: ResMut<StallClock>,
|
||||||
|
) {
|
||||||
|
if state_events.read().next().is_some() {
|
||||||
|
clock.0 = 0.0;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if paused.is_some_and(|p| p.0)
|
||||||
|
|| !scrims.is_empty()
|
||||||
|
|| game.as_ref().is_none_or(|g| g.0.is_won())
|
||||||
|
{
|
||||||
|
// Frozen, not reset: backgrounding into a menu mid-stall
|
||||||
|
// shouldn't restart the wait.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
clock.0 += time.delta_secs();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Fires the one-shot stall tip once the clock passes the threshold in
|
||||||
|
/// a game the player has actually started (at least one move).
|
||||||
|
fn fire_stall_hint_tip(
|
||||||
|
clock: Res<StallClock>,
|
||||||
|
game: Option<Res<GameStateResource>>,
|
||||||
|
mut settings: Option<ResMut<SettingsResource>>,
|
||||||
|
storage_path: Option<Res<SettingsStoragePath>>,
|
||||||
|
mut toast: MessageWriter<InfoToastEvent>,
|
||||||
|
) {
|
||||||
|
let Some(s) = settings.as_mut() else { return };
|
||||||
|
if s.0.shown_stall_hint_tip || clock.0 < STALL_TIP_SECS {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if game
|
||||||
|
.as_ref()
|
||||||
|
.is_none_or(|g| g.0.move_count() == 0 || g.0.is_won())
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
toast.write(InfoToastEvent(STALL_TIP.to_string()));
|
||||||
|
s.0.shown_stall_hint_tip = true;
|
||||||
|
persist(storage_path.as_deref(), &s.0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A player who opens the radial menu on their own doesn't need the
|
||||||
|
/// teach — mark the tip done silently.
|
||||||
|
fn observe_radial_menu_use(
|
||||||
|
radial: Option<Res<RightClickRadialState>>,
|
||||||
|
mut settings: Option<ResMut<SettingsResource>>,
|
||||||
|
storage_path: Option<Res<SettingsStoragePath>>,
|
||||||
|
) {
|
||||||
|
let Some(radial) = radial else { return };
|
||||||
|
if !radial.is_active() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let Some(s) = settings.as_mut() else { return };
|
||||||
|
if s.0.shown_radial_menu_tip {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
s.0.shown_radial_menu_tip = true;
|
||||||
|
persist(storage_path.as_deref(), &s.0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Fires the one-shot radial teach for an engaged player who has never
|
||||||
|
/// opened the menu themselves.
|
||||||
|
fn fire_radial_menu_tip(
|
||||||
|
game: Option<Res<GameStateResource>>,
|
||||||
|
mut settings: Option<ResMut<SettingsResource>>,
|
||||||
|
storage_path: Option<Res<SettingsStoragePath>>,
|
||||||
|
mut toast: MessageWriter<InfoToastEvent>,
|
||||||
|
) {
|
||||||
|
let Some(s) = settings.as_mut() else { return };
|
||||||
|
if s.0.shown_radial_menu_tip {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if game
|
||||||
|
.as_ref()
|
||||||
|
.is_none_or(|g| g.0.move_count() < RADIAL_TIP_MIN_MOVES || g.0.is_won())
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
toast.write(InfoToastEvent(RADIAL_TIP.to_string()));
|
||||||
|
s.0.shown_radial_menu_tip = true;
|
||||||
|
persist(storage_path.as_deref(), &s.0);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn persist(storage_path: Option<&SettingsStoragePath>, settings: &solitaire_data::Settings) {
|
||||||
|
if let Some(p) = storage_path
|
||||||
|
&& let Some(path) = p.0.as_deref()
|
||||||
|
&& let Err(e) = save_settings_to(path, settings)
|
||||||
|
{
|
||||||
|
warn!("contextual tips: failed to persist tip flag: {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use bevy::ecs::message::Messages;
|
||||||
|
use solitaire_core::{DrawStockConfig, game_state::GameState};
|
||||||
|
use solitaire_data::Settings;
|
||||||
|
|
||||||
|
fn app_with(settings: Settings, game: GameState) -> App {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins)
|
||||||
|
.add_plugins(ContextualTipsPlugin);
|
||||||
|
app.insert_resource(SettingsResource(settings));
|
||||||
|
app.insert_resource(GameStateResource(game));
|
||||||
|
app.update();
|
||||||
|
app
|
||||||
|
}
|
||||||
|
|
||||||
|
fn info_toast_count(app: &App) -> usize {
|
||||||
|
let events = app.world().resource::<Messages<InfoToastEvent>>();
|
||||||
|
let mut cursor = events.get_cursor();
|
||||||
|
cursor.read(events).count()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn started_game() -> GameState {
|
||||||
|
let mut game = GameState::new(7, DrawStockConfig::DrawOne);
|
||||||
|
game.draw().expect("draw from fresh deal");
|
||||||
|
game
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn stall_tip_fires_once_past_threshold() {
|
||||||
|
let mut app = app_with(Settings::default(), started_game());
|
||||||
|
app.world_mut().resource_mut::<StallClock>().0 = STALL_TIP_SECS + 1.0;
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert_eq!(info_toast_count(&app), 1, "stall tip must fire");
|
||||||
|
assert!(
|
||||||
|
app.world()
|
||||||
|
.resource::<SettingsResource>()
|
||||||
|
.0
|
||||||
|
.shown_stall_hint_tip,
|
||||||
|
"the tip flag must set so it never repeats"
|
||||||
|
);
|
||||||
|
|
||||||
|
app.world_mut().resource_mut::<StallClock>().0 = STALL_TIP_SECS + 30.0;
|
||||||
|
app.world_mut()
|
||||||
|
.resource_mut::<Messages<InfoToastEvent>>()
|
||||||
|
.clear();
|
||||||
|
app.update();
|
||||||
|
assert_eq!(info_toast_count(&app), 0, "the tip is one-shot");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn stall_tip_needs_a_started_unwon_game() {
|
||||||
|
// Untouched deal: staring at the launch screen is not a stall.
|
||||||
|
let mut app = app_with(
|
||||||
|
Settings::default(),
|
||||||
|
GameState::new(7, DrawStockConfig::DrawOne),
|
||||||
|
);
|
||||||
|
app.world_mut().resource_mut::<StallClock>().0 = STALL_TIP_SECS + 1.0;
|
||||||
|
app.update();
|
||||||
|
assert_eq!(info_toast_count(&app), 0, "no tip on an untouched deal");
|
||||||
|
|
||||||
|
// Won game: nothing to hint at.
|
||||||
|
let mut won = started_game();
|
||||||
|
won.set_test_won(true);
|
||||||
|
let mut app = app_with(Settings::default(), won);
|
||||||
|
app.world_mut().resource_mut::<StallClock>().0 = STALL_TIP_SECS + 1.0;
|
||||||
|
app.update();
|
||||||
|
assert_eq!(info_toast_count(&app), 0, "no tip on a won game");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn stall_clock_resets_on_state_change() {
|
||||||
|
let mut app = app_with(Settings::default(), started_game());
|
||||||
|
app.world_mut().resource_mut::<StallClock>().0 = 30.0;
|
||||||
|
app.world_mut().write_message(StateChangedEvent);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
app.world().resource::<StallClock>().0,
|
||||||
|
0.0,
|
||||||
|
"any board change must reset the stall clock"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn radial_tip_fires_for_engaged_player() {
|
||||||
|
let mut game = started_game();
|
||||||
|
game.set_test_move_count(RADIAL_TIP_MIN_MOVES);
|
||||||
|
let mut app = app_with(Settings::default(), game);
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
info_toast_count(&app),
|
||||||
|
1,
|
||||||
|
"radial tip must fire at the move threshold"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
app.world()
|
||||||
|
.resource::<SettingsResource>()
|
||||||
|
.0
|
||||||
|
.shown_radial_menu_tip
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn radial_tip_suppressed_after_organic_use() {
|
||||||
|
let mut game = started_game();
|
||||||
|
game.set_test_move_count(RADIAL_TIP_MIN_MOVES);
|
||||||
|
let mut app = app_with(
|
||||||
|
Settings {
|
||||||
|
shown_radial_menu_tip: true,
|
||||||
|
..Settings::default()
|
||||||
|
},
|
||||||
|
game,
|
||||||
|
);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
info_toast_count(&app),
|
||||||
|
0,
|
||||||
|
"a player who used the radial menu never sees the teach"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -14,14 +14,14 @@ use crate::platform::{
|
|||||||
};
|
};
|
||||||
use crate::{
|
use crate::{
|
||||||
AchievementPlugin, AnimationPlugin, AssetSourcesPlugin, AutoCompletePlugin,
|
AchievementPlugin, AnimationPlugin, AssetSourcesPlugin, AutoCompletePlugin,
|
||||||
CardAnimationPlugin, CardPlugin, ChallengePlugin, CursorPlugin, DailyChallengePlugin,
|
CardAnimationPlugin, CardPlugin, ChallengePlugin, CheatSheetPlugin, ContextualTipsPlugin,
|
||||||
DiagnosticsHudPlugin, DifficultyPlugin, FeedbackAnimPlugin, FontPlugin, GamePlugin, HelpPlugin,
|
CursorPlugin, DailyChallengePlugin, DiagnosticsHudPlugin, DifficultyPlugin, FeedbackAnimPlugin,
|
||||||
HomePlugin, HudPlugin, InputPlugin, OnboardingPlugin, PausePlugin, PlayBySeedPlugin,
|
FontPlugin, GamePlugin, HelpPlugin, HomePlugin, HudPlugin, InputPlugin, OnboardingPlugin,
|
||||||
ProfilePlugin, ProgressPlugin, RadialMenuPlugin, ReplayOverlayPlugin, ReplayPlaybackPlugin,
|
PausePlugin, PlayBySeedPlugin, ProfilePlugin, ProgressPlugin, RadialMenuPlugin,
|
||||||
SafeAreaInsetsPlugin, SelectionPlugin, SettingsPlugin, SolutionPlaybackPlugin, SplashPlugin,
|
ReplayOverlayPlugin, ReplayPlaybackPlugin, SafeAreaInsetsPlugin, SelectionPlugin,
|
||||||
StatsPlugin, SyncProvider, TablePlugin, ThemePlugin, ThemeRegistryPlugin, TimeAttackPlugin,
|
SettingsPlugin, SolutionPlaybackPlugin, SplashPlugin, StatsPlugin, SyncProvider, TablePlugin,
|
||||||
TouchSelectionPlugin, UiFocusPlugin, UiModalPlugin, UiTooltipPlugin, WeeklyGoalsPlugin,
|
ThemePlugin, ThemeRegistryPlugin, TimeAttackPlugin, TouchSelectionPlugin, UiFocusPlugin,
|
||||||
WinSummaryPlugin,
|
UiModalPlugin, UiTooltipPlugin, WeeklyGoalsPlugin, WhatsNewPlugin, WinSummaryPlugin,
|
||||||
};
|
};
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
use crate::{
|
use crate::{
|
||||||
@@ -115,6 +115,9 @@ impl Plugin for CoreGamePlugin {
|
|||||||
.add_plugins(PausePlugin)
|
.add_plugins(PausePlugin)
|
||||||
.add_plugins(SettingsPlugin::default())
|
.add_plugins(SettingsPlugin::default())
|
||||||
.add_plugins(OnboardingPlugin)
|
.add_plugins(OnboardingPlugin)
|
||||||
|
.add_plugins(WhatsNewPlugin)
|
||||||
|
.add_plugins(ContextualTipsPlugin)
|
||||||
|
.add_plugins(CheatSheetPlugin)
|
||||||
.add_plugins(WinSummaryPlugin)
|
.add_plugins(WinSummaryPlugin)
|
||||||
.add_plugins(UiModalPlugin)
|
.add_plugins(UiModalPlugin)
|
||||||
.add_plugins(UiFocusPlugin)
|
.add_plugins(UiFocusPlugin)
|
||||||
|
|||||||
@@ -480,6 +480,10 @@ fn persist_last_mode(
|
|||||||
/// owns the launch beat; Home appearing underneath it stacked two
|
/// owns the launch beat; Home appearing underneath it stacked two
|
||||||
/// modals (Phase H fix; spotted in the v0.44.0 emulator smoke). Home
|
/// modals (Phase H fix; spotted in the v0.44.0 emulator smoke). Home
|
||||||
/// spawns on the first frame after the player finishes or skips.
|
/// spawns on the first frame after the player finishes or skips.
|
||||||
|
/// * The What's-new card (Phase I) must have had its beat —
|
||||||
|
/// [`crate::whats_new_plugin::WhatsNewPending`] released — so an
|
||||||
|
/// upgrade's release notes get read before the mode picker lands on
|
||||||
|
/// top of them.
|
||||||
/// * `HomeScreen` must not already exist (defensive — e.g. the player
|
/// * `HomeScreen` must not already exist (defensive — e.g. the player
|
||||||
/// pressed `M` between ticks).
|
/// pressed `M` between ticks).
|
||||||
/// * `LaunchHomeShown` flips to `true` after the first spawn so this
|
/// * `LaunchHomeShown` flips to `true` after the first spawn so this
|
||||||
@@ -494,6 +498,7 @@ fn spawn_home_on_launch(
|
|||||||
restore_prompts: Query<(), With<crate::game_plugin::RestorePromptScreen>>,
|
restore_prompts: Query<(), With<crate::game_plugin::RestorePromptScreen>>,
|
||||||
pending_restore: Option<Res<crate::game_plugin::PendingRestoredGame>>,
|
pending_restore: Option<Res<crate::game_plugin::PendingRestoredGame>>,
|
||||||
onboarding: Query<(), With<crate::onboarding_plugin::OnboardingScreen>>,
|
onboarding: Query<(), With<crate::onboarding_plugin::OnboardingScreen>>,
|
||||||
|
whats_new: Option<Res<crate::whats_new_plugin::WhatsNewPending>>,
|
||||||
existing: Query<(), With<HomeScreen>>,
|
existing: Query<(), With<HomeScreen>>,
|
||||||
sources: HomeSpawnSources,
|
sources: HomeSpawnSources,
|
||||||
mut deal_expanded: ResMut<DealOptionsExpanded>,
|
mut deal_expanded: ResMut<DealOptionsExpanded>,
|
||||||
@@ -503,6 +508,7 @@ fn spawn_home_on_launch(
|
|||||||
|| !restore_prompts.is_empty()
|
|| !restore_prompts.is_empty()
|
||||||
|| pending_restore.as_ref().is_some_and(|p| p.0.is_some())
|
|| pending_restore.as_ref().is_some_and(|p| p.0.is_some())
|
||||||
|| !onboarding.is_empty()
|
|| !onboarding.is_empty()
|
||||||
|
|| whats_new.as_ref().is_some_and(|w| w.0)
|
||||||
|| sources
|
|| sources
|
||||||
.settings
|
.settings
|
||||||
.as_ref()
|
.as_ref()
|
||||||
|
|||||||
@@ -0,0 +1,169 @@
|
|||||||
|
//! Single source of truth for the desktop keyboard bindings (Phase J).
|
||||||
|
//!
|
||||||
|
//! Two static hotkey tables had already diverged (onboarding's slide
|
||||||
|
//! and Help's controls reference); every future drift multiplies. This
|
||||||
|
//! module owns THE table: the onboarding slide renders the
|
||||||
|
//! [`HotkeyRow::essential`] subset, the hold-`/` cheat sheet
|
||||||
|
//! ([`crate::cheat_sheet_plugin`]) renders everything.
|
||||||
|
//!
|
||||||
|
//! The table is hand-maintained but **pinned by test** against the
|
||||||
|
//! handlers that actually consume each key — adding a binding without
|
||||||
|
//! updating this table (or vice versa) is designed to fail review, not
|
||||||
|
//! runtime. A registry generated from the input systems themselves is
|
||||||
|
//! the eventual ideal; this is the honest 90 % at 1 % of the cost.
|
||||||
|
|
||||||
|
/// One row of the hotkey table.
|
||||||
|
#[derive(Debug, Clone, Copy)]
|
||||||
|
pub struct HotkeyRow {
|
||||||
|
/// Display form of the key(s), e.g. `"D / Space"`.
|
||||||
|
pub keys: &'static str,
|
||||||
|
/// One-line action description.
|
||||||
|
pub description: &'static str,
|
||||||
|
/// `true` for the beginner-relevant subset the onboarding slide
|
||||||
|
/// shows; the cheat sheet always shows every row.
|
||||||
|
pub essential: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Every desktop keyboard binding, in teaching order.
|
||||||
|
pub const HOTKEYS: &[HotkeyRow] = &[
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "D / Space",
|
||||||
|
description: "Draw from stock",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "U",
|
||||||
|
description: "Undo last move (hold to repeat)",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "H",
|
||||||
|
description: "Hint (repeat to cycle alternatives)",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "Tab → Enter",
|
||||||
|
description: "Pick a card; arrows pick where; Enter to drop",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "N",
|
||||||
|
description: "New Classic game",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "M",
|
||||||
|
description: "Open Home (then 1–6 to pick a mode)",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "Esc",
|
||||||
|
description: "Pause / resume; close the top dialog",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "F1",
|
||||||
|
description: "Help / controls",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "S",
|
||||||
|
description: "Stats & progression",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "A",
|
||||||
|
description: "Achievements",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "O",
|
||||||
|
description: "Settings",
|
||||||
|
essential: true,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "P",
|
||||||
|
description: "Profile",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "L",
|
||||||
|
description: "Leaderboard",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "C",
|
||||||
|
description: "Daily Challenge",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "Z",
|
||||||
|
description: "Zen mode",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "X",
|
||||||
|
description: "Challenge mode",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "T",
|
||||||
|
description: "Time Attack",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "G",
|
||||||
|
description: "Give up the current deal",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "[ / ]",
|
||||||
|
description: "Volume down / up",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "F11",
|
||||||
|
description: "Toggle fullscreen",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
HotkeyRow {
|
||||||
|
keys: "/ (hold)",
|
||||||
|
description: "This cheat sheet",
|
||||||
|
essential: false,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn table_is_populated_and_well_formed() {
|
||||||
|
assert!(!HOTKEYS.is_empty());
|
||||||
|
for row in HOTKEYS {
|
||||||
|
assert!(!row.keys.trim().is_empty(), "empty keys cell");
|
||||||
|
assert!(
|
||||||
|
!row.description.trim().is_empty(),
|
||||||
|
"empty description for {}",
|
||||||
|
row.keys
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn essential_subset_is_a_teachable_size() {
|
||||||
|
let essentials = HOTKEYS.iter().filter(|r| r.essential).count();
|
||||||
|
assert!(
|
||||||
|
(6..=12).contains(&essentials),
|
||||||
|
"the onboarding slide wants a skimmable essential set, got {essentials}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn keys_cells_are_unique() {
|
||||||
|
let mut seen = std::collections::HashSet::new();
|
||||||
|
for row in HOTKEYS {
|
||||||
|
assert!(seen.insert(row.keys), "duplicate hotkey row: {}", row.keys);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -215,6 +215,7 @@ fn handle_keyboard_core(
|
|||||||
keys: Res<ButtonInput<KeyCode>>,
|
keys: Res<ButtonInput<KeyCode>>,
|
||||||
paused: Option<Res<PausedResource>>,
|
paused: Option<Res<PausedResource>>,
|
||||||
progress: Option<Res<ProgressResource>>,
|
progress: Option<Res<ProgressResource>>,
|
||||||
|
drag: Res<DragState>,
|
||||||
mut ev: CoreKeyboardMessages<'_>,
|
mut ev: CoreKeyboardMessages<'_>,
|
||||||
mut time_attack: Option<ResMut<TimeAttackResource>>,
|
mut time_attack: Option<ResMut<TimeAttackResource>>,
|
||||||
selection: Option<Res<SelectionState>>,
|
selection: Option<Res<SelectionState>>,
|
||||||
@@ -227,6 +228,19 @@ fn handle_keyboard_core(
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Mutual exclusion with pointer drags — mirrors `handle_selection_keys`.
|
||||||
|
// Undo / draw / new-game during an active mouse or touch drag would fire
|
||||||
|
// a StateChangedEvent whose card re-sync inserts a `CardAnim` on the
|
||||||
|
// dragged cards, fighting `follow_drag`'s per-frame Transform writes and
|
||||||
|
// leaving `DragState` origin indices stale against the mutated state.
|
||||||
|
// The keyboard-drag sentinel may proceed: `clear_selection_on_state_change`
|
||||||
|
// already drops that lift cleanly when the state moves.
|
||||||
|
if !drag.is_idle()
|
||||||
|
&& drag.active_touch_id != Some(crate::selection_plugin::KEYBOARD_DRAG_TOUCH_ID)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// During replay playback (Playing or Completed) all game-input shortcuts
|
// During replay playback (Playing or Completed) all game-input shortcuts
|
||||||
// are suppressed. The replay overlay owns Space (pause/resume) and the
|
// are suppressed. The replay overlay owns Space (pause/resume) and the
|
||||||
// arrow keys (step). Letting game input through would mutate
|
// arrow keys (step). Letting game input through would mutate
|
||||||
@@ -473,11 +487,19 @@ pub fn emit_hint_visuals(
|
|||||||
fn handle_keyboard_forfeit(
|
fn handle_keyboard_forfeit(
|
||||||
keys: Res<ButtonInput<KeyCode>>,
|
keys: Res<ButtonInput<KeyCode>>,
|
||||||
paused: Option<Res<PausedResource>>,
|
paused: Option<Res<PausedResource>>,
|
||||||
|
drag: Res<DragState>,
|
||||||
mut requests: MessageWriter<ForfeitRequestEvent>,
|
mut requests: MessageWriter<ForfeitRequestEvent>,
|
||||||
) {
|
) {
|
||||||
if paused.is_some_and(|p| p.0) {
|
if paused.is_some_and(|p| p.0) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
// Same pointer-drag exclusion as `handle_keyboard_core` — forfeiting
|
||||||
|
// mid-drag would mutate the game state under the dragged cards.
|
||||||
|
if !drag.is_idle()
|
||||||
|
&& drag.active_touch_id != Some(crate::selection_plugin::KEYBOARD_DRAG_TOUCH_ID)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
if !keys.just_pressed(KeyCode::KeyG) {
|
if !keys.just_pressed(KeyCode::KeyG) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -817,3 +817,123 @@ fn pressing_h_spawns_pending_hint_task() {
|
|||||||
"pressing H must spawn an async hint task",
|
"pressing H must spawn an async hint task",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
// Pointer-drag / keyboard mutual exclusion.
|
||||||
|
//
|
||||||
|
// A state mutation fired while `follow_drag` is writing the dragged cards'
|
||||||
|
// transforms every frame would make the card re-sync insert a `CardAnim`
|
||||||
|
// on the same entities (two systems fighting over `Transform`) and leave
|
||||||
|
// `DragState`'s origin indices stale. `handle_keyboard_core` and
|
||||||
|
// `handle_keyboard_forfeit` therefore swallow game-mutating shortcuts
|
||||||
|
// while a mouse or touch drag is live, mirroring `handle_selection_keys`.
|
||||||
|
// The keyboard-lift sentinel is exempt: `clear_selection_on_state_change`
|
||||||
|
// drops that lift cleanly when the state moves.
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
fn keyboard_core_app() -> App {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins);
|
||||||
|
app.add_message::<UndoRequestEvent>();
|
||||||
|
app.add_message::<NewGameRequestEvent>();
|
||||||
|
app.add_message::<InfoToastEvent>();
|
||||||
|
app.add_message::<DrawRequestEvent>();
|
||||||
|
app.add_message::<StartZenRequestEvent>();
|
||||||
|
app.init_resource::<ButtonInput<KeyCode>>();
|
||||||
|
app.init_resource::<DragState>();
|
||||||
|
app.add_systems(Update, handle_keyboard_core);
|
||||||
|
app
|
||||||
|
}
|
||||||
|
|
||||||
|
fn press_key(app: &mut App, key: KeyCode) {
|
||||||
|
let mut input = app.world_mut().resource_mut::<ButtonInput<KeyCode>>();
|
||||||
|
input.release(key);
|
||||||
|
input.clear();
|
||||||
|
input.press(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn message_count<M: Message>(app: &App) -> usize {
|
||||||
|
let messages = app.world().resource::<Messages<M>>();
|
||||||
|
let mut cursor = messages.get_cursor();
|
||||||
|
cursor.read(messages).count()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn set_drag(app: &mut App, active_touch_id: Option<u64>) {
|
||||||
|
let mut drag = app.world_mut().resource_mut::<DragState>();
|
||||||
|
drag.cards = vec![Card::new(Deck::Deck1, Suit::Clubs, Rank::Two)];
|
||||||
|
drag.committed = true;
|
||||||
|
drag.active_touch_id = active_touch_id;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn u_key_fires_undo_when_no_drag_active() {
|
||||||
|
let mut app = keyboard_core_app();
|
||||||
|
press_key(&mut app, KeyCode::KeyU);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
message_count::<UndoRequestEvent>(&app),
|
||||||
|
1,
|
||||||
|
"U with an idle DragState must fire UndoRequestEvent",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn u_key_ignored_during_committed_mouse_drag() {
|
||||||
|
let mut app = keyboard_core_app();
|
||||||
|
set_drag(&mut app, None); // mouse drag
|
||||||
|
press_key(&mut app, KeyCode::KeyU);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
message_count::<UndoRequestEvent>(&app),
|
||||||
|
0,
|
||||||
|
"U during a mouse drag must be swallowed",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn draw_key_ignored_during_touch_drag() {
|
||||||
|
let mut app = keyboard_core_app();
|
||||||
|
set_drag(&mut app, Some(7)); // real touch id
|
||||||
|
press_key(&mut app, KeyCode::KeyD);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
message_count::<DrawRequestEvent>(&app),
|
||||||
|
0,
|
||||||
|
"D during a touch drag must be swallowed",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn u_key_allowed_during_keyboard_lift() {
|
||||||
|
let mut app = keyboard_core_app();
|
||||||
|
set_drag(
|
||||||
|
&mut app,
|
||||||
|
Some(crate::selection_plugin::KEYBOARD_DRAG_TOUCH_ID),
|
||||||
|
);
|
||||||
|
press_key(&mut app, KeyCode::KeyU);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
message_count::<UndoRequestEvent>(&app),
|
||||||
|
1,
|
||||||
|
"the keyboard-lift sentinel must not block core shortcuts",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn g_key_forfeit_ignored_during_mouse_drag() {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins);
|
||||||
|
app.add_message::<ForfeitRequestEvent>();
|
||||||
|
app.init_resource::<ButtonInput<KeyCode>>();
|
||||||
|
app.init_resource::<DragState>();
|
||||||
|
app.add_systems(Update, handle_keyboard_forfeit);
|
||||||
|
|
||||||
|
set_drag(&mut app, None);
|
||||||
|
press_key(&mut app, KeyCode::KeyG);
|
||||||
|
app.update();
|
||||||
|
assert_eq!(
|
||||||
|
message_count::<ForfeitRequestEvent>(&app),
|
||||||
|
0,
|
||||||
|
"G during a mouse drag must be swallowed",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -24,13 +24,13 @@ use crate::font_plugin::FontResource;
|
|||||||
use crate::settings_plugin::{SettingsResource, SettingsStoragePath};
|
use crate::settings_plugin::{SettingsResource, SettingsStoragePath};
|
||||||
use crate::sync_plugin::SyncProviderResource;
|
use crate::sync_plugin::SyncProviderResource;
|
||||||
use crate::ui_modal::{
|
use crate::ui_modal::{
|
||||||
ButtonVariant, ModalScrim, ScrimDismissible, spawn_modal, spawn_modal_actions,
|
ButtonVariant, ModalScrim, ScrimDismissible, spawn_empty_state, spawn_modal,
|
||||||
spawn_modal_button, spawn_modal_header,
|
spawn_modal_actions, spawn_modal_button, spawn_modal_header,
|
||||||
};
|
};
|
||||||
use crate::ui_theme::{
|
use crate::ui_theme::{
|
||||||
ACCENT_PRIMARY, BG_ELEVATED, BORDER_SUBTLE, RADIUS_SM, STATE_INFO, TEXT_DISABLED, TEXT_PRIMARY,
|
ACCENT_PRIMARY, BG_ELEVATED, BORDER_SUBTLE, RADIUS_SM, TEXT_DISABLED, TEXT_PRIMARY,
|
||||||
TEXT_SECONDARY, TYPE_BODY, TYPE_BODY_LG, TYPE_CAPTION, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4,
|
TEXT_SECONDARY, TYPE_BODY, TYPE_CAPTION, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4, Z_MODAL_PANEL,
|
||||||
Z_MODAL_PANEL, Z_PAUSE_DIALOG,
|
Z_PAUSE_DIALOG,
|
||||||
};
|
};
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -536,11 +536,6 @@ fn spawn_leaderboard_screen(
|
|||||||
font_size: TYPE_CAPTION,
|
font_size: TYPE_CAPTION,
|
||||||
..default()
|
..default()
|
||||||
};
|
};
|
||||||
let font_status = TextFont {
|
|
||||||
font: font_handle.clone(),
|
|
||||||
font_size: TYPE_BODY_LG,
|
|
||||||
..default()
|
|
||||||
};
|
|
||||||
let font_row = TextFont {
|
let font_row = TextFont {
|
||||||
font: font_handle.clone(),
|
font: font_handle.clone(),
|
||||||
font_size: TYPE_BODY,
|
font_size: TYPE_BODY,
|
||||||
@@ -647,30 +642,31 @@ fn spawn_leaderboard_screen(
|
|||||||
.with_children(|body| {
|
.with_children(|body| {
|
||||||
match data {
|
match data {
|
||||||
LeaderboardResource::Idle => {
|
LeaderboardResource::Idle => {
|
||||||
body.spawn((
|
spawn_empty_state(
|
||||||
Text::new("Fetching\u{2026}"),
|
body,
|
||||||
font_status.clone(),
|
"\u{21BB}",
|
||||||
TextColor(STATE_INFO),
|
"Fetching the leaderboard\u{2026}",
|
||||||
));
|
None,
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
LeaderboardResource::Error(_) => {
|
LeaderboardResource::Error(_) => {
|
||||||
body.spawn((
|
spawn_empty_state(
|
||||||
Text::new("Couldn't reach the leaderboard. Try again later."),
|
body,
|
||||||
font_status.clone(),
|
"!",
|
||||||
TextColor(TEXT_SECONDARY),
|
"Couldn't reach the leaderboard.",
|
||||||
));
|
Some("Try again later."),
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
LeaderboardResource::Loaded(rows) if rows.is_empty() => {
|
LeaderboardResource::Loaded(rows) if rows.is_empty() => {
|
||||||
body.spawn((
|
spawn_empty_state(
|
||||||
Text::new("Be the first on the leaderboard."),
|
body,
|
||||||
font_status.clone(),
|
"\u{2660}",
|
||||||
TextColor(TEXT_PRIMARY),
|
"Be the first on the leaderboard.",
|
||||||
));
|
Some("Win a game and opt in to appear here."),
|
||||||
body.spawn((
|
font_res,
|
||||||
Text::new("Win a game and opt in to appear here."),
|
);
|
||||||
font_row.clone(),
|
|
||||||
TextColor(TEXT_SECONDARY),
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
LeaderboardResource::Loaded(rows) => {
|
LeaderboardResource::Loaded(rows) => {
|
||||||
// Column headers
|
// Column headers
|
||||||
|
|||||||
@@ -15,6 +15,8 @@ pub mod avatar_plugin;
|
|||||||
pub mod card_animation;
|
pub mod card_animation;
|
||||||
pub mod card_plugin;
|
pub mod card_plugin;
|
||||||
pub mod challenge_plugin;
|
pub mod challenge_plugin;
|
||||||
|
pub mod cheat_sheet_plugin;
|
||||||
|
pub mod contextual_tips_plugin;
|
||||||
pub mod core_game_plugin;
|
pub mod core_game_plugin;
|
||||||
pub mod cursor_plugin;
|
pub mod cursor_plugin;
|
||||||
pub mod daily_challenge_plugin;
|
pub mod daily_challenge_plugin;
|
||||||
@@ -26,6 +28,7 @@ pub mod font_plugin;
|
|||||||
pub mod game_plugin;
|
pub mod game_plugin;
|
||||||
pub mod help_plugin;
|
pub mod help_plugin;
|
||||||
pub mod home_plugin;
|
pub mod home_plugin;
|
||||||
|
pub mod hotkeys;
|
||||||
pub mod hud_plugin;
|
pub mod hud_plugin;
|
||||||
pub mod input_plugin;
|
pub mod input_plugin;
|
||||||
pub mod layout;
|
pub mod layout;
|
||||||
@@ -64,6 +67,7 @@ pub mod ui_modal;
|
|||||||
pub mod ui_theme;
|
pub mod ui_theme;
|
||||||
pub mod ui_tooltip;
|
pub mod ui_tooltip;
|
||||||
pub mod weekly_goals_plugin;
|
pub mod weekly_goals_plugin;
|
||||||
|
pub mod whats_new_plugin;
|
||||||
pub mod win_summary_plugin;
|
pub mod win_summary_plugin;
|
||||||
pub mod you_hub_plugin;
|
pub mod you_hub_plugin;
|
||||||
|
|
||||||
@@ -93,6 +97,8 @@ pub use card_plugin::{
|
|||||||
pub use challenge_plugin::{
|
pub use challenge_plugin::{
|
||||||
CHALLENGE_UNLOCK_LEVEL, ChallengeAdvancedEvent, ChallengePlugin, challenge_progress_label,
|
CHALLENGE_UNLOCK_LEVEL, ChallengeAdvancedEvent, ChallengePlugin, challenge_progress_label,
|
||||||
};
|
};
|
||||||
|
pub use cheat_sheet_plugin::{CheatSheetOverlay, CheatSheetPlugin};
|
||||||
|
pub use contextual_tips_plugin::ContextualTipsPlugin;
|
||||||
pub use core_game_plugin::CoreGamePlugin;
|
pub use core_game_plugin::CoreGamePlugin;
|
||||||
pub use cursor_plugin::CursorPlugin;
|
pub use cursor_plugin::CursorPlugin;
|
||||||
pub use daily_challenge_plugin::{
|
pub use daily_challenge_plugin::{
|
||||||
@@ -194,6 +200,7 @@ pub use ui_modal::{
|
|||||||
};
|
};
|
||||||
pub use ui_tooltip::{Tooltip, UiTooltipPlugin};
|
pub use ui_tooltip::{Tooltip, UiTooltipPlugin};
|
||||||
pub use weekly_goals_plugin::{WeeklyGoalCompletedEvent, WeeklyGoalsPlugin};
|
pub use weekly_goals_plugin::{WeeklyGoalCompletedEvent, WeeklyGoalsPlugin};
|
||||||
|
pub use whats_new_plugin::{WhatsNewPending, WhatsNewPlugin, WhatsNewScreen};
|
||||||
pub use win_summary_plugin::{
|
pub use win_summary_plugin::{
|
||||||
ScreenShakeResource, SessionAchievements, WinSummaryPending, WinSummaryPlugin, format_win_time,
|
ScreenShakeResource, SessionAchievements, WinSummaryPending, WinSummaryPlugin, format_win_time,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -84,66 +84,11 @@ struct OnboardingSkipButton;
|
|||||||
pub struct OnboardingSlideIndex(pub u8);
|
pub struct OnboardingSlideIndex(pub u8);
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Slide data — hotkey rows are taken verbatim from `help_plugin.rs` so the
|
// Slide data — the hotkey slide renders the essential subset of the
|
||||||
// two screens stay in sync without a shared abstraction.
|
// shared table in `crate::hotkeys` (Phase J unified the previously
|
||||||
|
// diverging copies here and in help_plugin).
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
/// A single `key — description` pair shown on slide 3.
|
|
||||||
#[cfg(not(target_os = "android"))]
|
|
||||||
struct HotkeyRow {
|
|
||||||
keys: &'static str,
|
|
||||||
description: &'static str,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Most-used shortcuts from the `help_plugin` canonical list.
|
|
||||||
///
|
|
||||||
/// Updating the list in `help_plugin.rs` should be mirrored here. The
|
|
||||||
/// ARCHITECTURE.md decision log calls out that we copy values rather than
|
|
||||||
/// refactor the help plugin.
|
|
||||||
#[cfg(not(target_os = "android"))]
|
|
||||||
const HOTKEYS: &[HotkeyRow] = &[
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "D / Space",
|
|
||||||
description: "Draw from stock",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "U",
|
|
||||||
description: "Undo last move",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "Tab → Enter",
|
|
||||||
description: "Pick a card; arrows pick where; Enter to drop",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "N",
|
|
||||||
description: "New Classic game",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "M",
|
|
||||||
description: "Open Mode Launcher (then 1–5 to pick)",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "S",
|
|
||||||
description: "Stats & progression",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "A",
|
|
||||||
description: "Achievements",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "O",
|
|
||||||
description: "Settings",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "Esc",
|
|
||||||
description: "Pause / resume",
|
|
||||||
},
|
|
||||||
HotkeyRow {
|
|
||||||
keys: "F1",
|
|
||||||
description: "Help / controls",
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Plugin
|
// Plugin
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -313,6 +258,10 @@ fn complete_onboarding(
|
|||||||
despawn_screen(commands, screens);
|
despawn_screen(commands, screens);
|
||||||
if let Some(s) = settings {
|
if let Some(s) = settings {
|
||||||
s.0.first_run_complete = true;
|
s.0.first_run_complete = true;
|
||||||
|
// A fresh install has nothing "new" to announce — stamp the
|
||||||
|
// running release so the What's-new card (Phase I) only ever
|
||||||
|
// fires after an actual upgrade.
|
||||||
|
s.0.last_seen_whats_new = crate::whats_new_plugin::current_release_version();
|
||||||
persist(path.map(|p| &p.0), &s.0);
|
persist(path.map(|p| &p.0), &s.0);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -442,8 +391,10 @@ fn spawn_slide_hotkeys(commands: &mut Commands, font_res: Option<&FontResource>)
|
|||||||
spawn_modal(commands, OnboardingScreen, Z_ONBOARDING, |card| {
|
spawn_modal(commands, OnboardingScreen, Z_ONBOARDING, |card| {
|
||||||
spawn_modal_header(card, "Keyboard shortcuts", font_res);
|
spawn_modal_header(card, "Keyboard shortcuts", font_res);
|
||||||
|
|
||||||
// Vertical list of `key — description` rows, same chip style as HelpScreen.
|
// Vertical list of `key — description` rows, same chip style as
|
||||||
for row in HOTKEYS {
|
// HelpScreen. Essential subset only — the full table lives on
|
||||||
|
// the hold-`/` cheat sheet.
|
||||||
|
for row in crate::hotkeys::HOTKEYS.iter().filter(|r| r.essential) {
|
||||||
card.spawn(Node {
|
card.spawn(Node {
|
||||||
flex_direction: FlexDirection::Row,
|
flex_direction: FlexDirection::Row,
|
||||||
align_items: AlignItems::Center,
|
align_items: AlignItems::Center,
|
||||||
@@ -822,22 +773,15 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
// Hotkey list is non-empty (guards against accidental truncation)
|
// Hotkey slide renders a non-empty essential subset (the table's own
|
||||||
|
// integrity tests live in `crate::hotkeys`)
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn hotkey_list_is_non_empty() {
|
fn hotkey_slide_subset_is_non_empty() {
|
||||||
assert!(!HOTKEYS.is_empty(), "HOTKEYS must not be empty");
|
assert!(
|
||||||
}
|
crate::hotkeys::HOTKEYS.iter().any(|r| r.essential),
|
||||||
|
"the onboarding slide needs at least one essential hotkey"
|
||||||
#[test]
|
);
|
||||||
fn all_hotkey_rows_have_non_empty_fields() {
|
|
||||||
for row in HOTKEYS {
|
|
||||||
assert!(!row.keys.is_empty(), "hotkey key field must not be empty");
|
|
||||||
assert!(
|
|
||||||
!row.description.is_empty(),
|
|
||||||
"hotkey description must not be empty"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -101,9 +101,10 @@ impl Plugin for SafeAreaInsetsPlugin {
|
|||||||
fn apply_safe_area_anchors(
|
fn apply_safe_area_anchors(
|
||||||
insets: Res<SafeAreaInsets>,
|
insets: Res<SafeAreaInsets>,
|
||||||
windows: Query<&Window>,
|
windows: Query<&Window>,
|
||||||
|
ui_scale: Option<Res<UiScale>>,
|
||||||
mut q: Query<(&SafeAreaAnchoredTop, &mut Node)>,
|
mut q: Query<(&SafeAreaAnchoredTop, &mut Node)>,
|
||||||
) {
|
) {
|
||||||
if !insets.is_changed() {
|
if !insets.is_changed() && !ui_scale.as_ref().is_some_and(|s| s.is_changed()) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// Android's WindowInsets API returns physical pixels; Bevy UI's Val::Px
|
// Android's WindowInsets API returns physical pixels; Bevy UI's Val::Px
|
||||||
@@ -119,19 +120,31 @@ fn apply_safe_area_anchors(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
let top_logical = raw_top.min(max_inset);
|
let top_logical = raw_top.min(max_inset);
|
||||||
|
// `bevy::ui::UiScale` (Phase K) multiplies every Val::Px at layout
|
||||||
|
// time. `base_top` is UI chrome and SHOULD scale with the rest of
|
||||||
|
// the interface, but the system-bar inset is physical reality —
|
||||||
|
// pre-divide it so the post-multiplication offset stays exact.
|
||||||
|
let ui = effective_ui_scale(ui_scale.as_deref());
|
||||||
for (anchor, mut node) in &mut q {
|
for (anchor, mut node) in &mut q {
|
||||||
node.top = Val::Px(anchor.base_top + top_logical);
|
node.top = Val::Px(anchor.base_top + top_logical / ui);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The live UI scale, defensively clamped — a zero or negative scale
|
||||||
|
/// would flip or destroy the inset math.
|
||||||
|
fn effective_ui_scale(ui_scale: Option<&UiScale>) -> f32 {
|
||||||
|
ui_scale.map_or(1.0, |s| s.0.max(0.1))
|
||||||
|
}
|
||||||
|
|
||||||
/// Re-applies `base_bottom + insets.bottom / scale` to every entity carrying
|
/// Re-applies `base_bottom + insets.bottom / scale` to every entity carrying
|
||||||
/// [`SafeAreaAnchoredBottom`] whenever [`SafeAreaInsets`] changes.
|
/// [`SafeAreaAnchoredBottom`] whenever [`SafeAreaInsets`] changes.
|
||||||
fn apply_safe_area_bottom_anchors(
|
fn apply_safe_area_bottom_anchors(
|
||||||
insets: Res<SafeAreaInsets>,
|
insets: Res<SafeAreaInsets>,
|
||||||
windows: Query<&Window>,
|
windows: Query<&Window>,
|
||||||
|
ui_scale: Option<Res<UiScale>>,
|
||||||
mut q: Query<(&SafeAreaAnchoredBottom, &mut Node)>,
|
mut q: Query<(&SafeAreaAnchoredBottom, &mut Node)>,
|
||||||
) {
|
) {
|
||||||
if !insets.is_changed() {
|
if !insets.is_changed() && !ui_scale.as_ref().is_some_and(|s| s.is_changed()) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
let scale = windows.iter().next().map_or(1.0, |w| w.scale_factor());
|
let scale = windows.iter().next().map_or(1.0, |w| w.scale_factor());
|
||||||
@@ -144,8 +157,12 @@ fn apply_safe_area_bottom_anchors(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
let bottom_logical = raw_bottom.min(max_inset);
|
let bottom_logical = raw_bottom.min(max_inset);
|
||||||
|
// See `apply_safe_area_anchors`: the physical inset is pre-divided
|
||||||
|
// by the UI scale so a 90% setting can't sink the action bar into
|
||||||
|
// the gesture zone (and 130% doesn't over-inset it).
|
||||||
|
let ui = effective_ui_scale(ui_scale.as_deref());
|
||||||
for (anchor, mut node) in &mut q {
|
for (anchor, mut node) in &mut q {
|
||||||
node.bottom = Val::Px(anchor.base_bottom + bottom_logical);
|
node.bottom = Val::Px(anchor.base_bottom + bottom_logical / ui);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -163,19 +180,23 @@ fn apply_safe_area_bottom_anchors(
|
|||||||
fn apply_safe_area_to_modal_scrims(
|
fn apply_safe_area_to_modal_scrims(
|
||||||
insets: Res<SafeAreaInsets>,
|
insets: Res<SafeAreaInsets>,
|
||||||
windows: Query<&Window>,
|
windows: Query<&Window>,
|
||||||
|
ui_scale: Option<Res<UiScale>>,
|
||||||
mut scrims: Query<&mut Node, With<ModalScrim>>,
|
mut scrims: Query<&mut Node, With<ModalScrim>>,
|
||||||
new_scrims: Query<(), (With<ModalScrim>, Added<ModalScrim>)>,
|
new_scrims: Query<(), (With<ModalScrim>, Added<ModalScrim>)>,
|
||||||
) {
|
) {
|
||||||
let has_new = !new_scrims.is_empty();
|
let has_new = !new_scrims.is_empty();
|
||||||
if !insets.is_changed() && !has_new {
|
if !insets.is_changed() && !has_new && !ui_scale.as_ref().is_some_and(|s| s.is_changed()) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
let scale = windows.iter().next().map_or(1.0, |w| w.scale_factor());
|
let scale = windows.iter().next().map_or(1.0, |w| w.scale_factor());
|
||||||
let window_height = windows.iter().next().map_or(800.0, |w| w.height());
|
let window_height = windows.iter().next().map_or(800.0, |w| w.height());
|
||||||
// Clamp each inset to 25% of screen height so an unexpectedly large OS
|
// Clamp each inset to 25% of screen height so an unexpectedly large OS
|
||||||
// value can't push the modal card off the visible area entirely.
|
// value can't push the modal card off the visible area entirely.
|
||||||
let top_logical = (insets.top / scale).min(window_height * 0.25);
|
// Physical insets are pre-divided by the UI scale — see
|
||||||
let bottom_logical = (insets.bottom / scale).min(window_height * 0.25);
|
// `apply_safe_area_anchors`.
|
||||||
|
let ui = effective_ui_scale(ui_scale.as_deref());
|
||||||
|
let top_logical = (insets.top / scale).min(window_height * 0.25) / ui;
|
||||||
|
let bottom_logical = (insets.bottom / scale).min(window_height * 0.25) / ui;
|
||||||
for mut node in &mut scrims {
|
for mut node in &mut scrims {
|
||||||
// Set both edges so the scrim's content box equals the usable area
|
// Set both edges so the scrim's content box equals the usable area
|
||||||
// between the status bar and the gesture/navigation bar. With
|
// between the status bar and the gesture/navigation bar. With
|
||||||
|
|||||||
@@ -363,6 +363,14 @@ pub(super) fn handle_settings_buttons(
|
|||||||
changed.write(SettingsChangedEvent(settings.0.clone()));
|
changed.write(SettingsChangedEvent(settings.0.clone()));
|
||||||
// Text refreshed by `update_touch_input_mode_text` next frame.
|
// Text refreshed by `update_touch_input_mode_text` next frame.
|
||||||
}
|
}
|
||||||
|
SettingsButton::CycleUiScale => {
|
||||||
|
settings.0.ui_scale = next_ui_scale(settings.0.ui_scale);
|
||||||
|
persist(&path, &settings.0);
|
||||||
|
changed.write(SettingsChangedEvent(settings.0.clone()));
|
||||||
|
// Text refreshed by `update_ui_scale_text`; the live
|
||||||
|
// `bevy::ui::UiScale` resource follows via
|
||||||
|
// `sync_ui_scale_resource` next frame.
|
||||||
|
}
|
||||||
SettingsButton::ToggleWinnableDealsOnly => {
|
SettingsButton::ToggleWinnableDealsOnly => {
|
||||||
settings.0.winnable_deals_only = !settings.0.winnable_deals_only;
|
settings.0.winnable_deals_only = !settings.0.winnable_deals_only;
|
||||||
persist(&path, &settings.0);
|
persist(&path, &settings.0);
|
||||||
|
|||||||
@@ -139,6 +139,10 @@ struct ReduceMotionText;
|
|||||||
#[derive(Component, Debug)]
|
#[derive(Component, Debug)]
|
||||||
struct TouchInputModeText;
|
struct TouchInputModeText;
|
||||||
|
|
||||||
|
/// Marks the `Text` node showing the current UI scale percentage.
|
||||||
|
#[derive(Component, Debug)]
|
||||||
|
struct UiScaleText;
|
||||||
|
|
||||||
/// Marks the `Text` node showing the live tooltip-delay value.
|
/// Marks the `Text` node showing the live tooltip-delay value.
|
||||||
#[derive(Component, Debug)]
|
#[derive(Component, Debug)]
|
||||||
struct TooltipDelayText;
|
struct TooltipDelayText;
|
||||||
@@ -277,6 +281,10 @@ enum SettingsButton {
|
|||||||
/// (auto-move on tap, default) and `TapToSelect` (first tap selects
|
/// (auto-move on tap, default) and `TapToSelect` (first tap selects
|
||||||
/// a card/stack, second tap on a target pile moves it).
|
/// a card/stack, second tap on a target pile moves it).
|
||||||
ToggleTouchInputMode,
|
ToggleTouchInputMode,
|
||||||
|
/// Cycle [`Settings::ui_scale`] through 90 % → 100 % → 115 % →
|
||||||
|
/// 130 % → 90 %. Applied live via `bevy::ui::UiScale`; the table
|
||||||
|
/// stays window-fit (Phase K).
|
||||||
|
CycleUiScale,
|
||||||
/// Toggle the [`Settings::winnable_deals_only`] flag. When on, new
|
/// Toggle the [`Settings::winnable_deals_only`] flag. When on, new
|
||||||
/// random Classic-mode deals are filtered through
|
/// random Classic-mode deals are filtered through
|
||||||
/// [`solitaire_core::game_state::GameState::solve_fresh_deal`] until one is provably
|
/// [`solitaire_core::game_state::GameState::solve_fresh_deal`] until one is provably
|
||||||
@@ -354,6 +362,7 @@ impl SettingsButton {
|
|||||||
SettingsButton::ToggleHighContrast => 61,
|
SettingsButton::ToggleHighContrast => 61,
|
||||||
SettingsButton::ToggleReduceMotion => 62,
|
SettingsButton::ToggleReduceMotion => 62,
|
||||||
SettingsButton::ToggleTouchInputMode => 63,
|
SettingsButton::ToggleTouchInputMode => 63,
|
||||||
|
SettingsButton::CycleUiScale => 64,
|
||||||
// Picker rows — every swatch in a row shares the row's
|
// Picker rows — every swatch in a row shares the row's
|
||||||
// priority so entity-index tiebreaking yields left → right.
|
// priority so entity-index tiebreaking yields left → right.
|
||||||
SettingsButton::SelectCardBack(_) => 70,
|
SettingsButton::SelectCardBack(_) => 70,
|
||||||
@@ -449,6 +458,11 @@ impl Plugin for SettingsPlugin {
|
|||||||
handle_volume_keys,
|
handle_volume_keys,
|
||||||
record_window_geometry_changes,
|
record_window_geometry_changes,
|
||||||
persist_window_geometry_after_debounce,
|
persist_window_geometry_after_debounce,
|
||||||
|
// State sync, not UI — runs even under `headless()`
|
||||||
|
// so the live `bevy::ui::UiScale` always mirrors the
|
||||||
|
// setting; rides the mutator spine so it is ordered
|
||||||
|
// after every settings writer this frame.
|
||||||
|
sync_ui_scale_resource,
|
||||||
)
|
)
|
||||||
.chain()
|
.chain()
|
||||||
.in_set(SettingsMutation),
|
.in_set(SettingsMutation),
|
||||||
@@ -492,6 +506,7 @@ impl Plugin for SettingsPlugin {
|
|||||||
update_high_contrast_backgrounds.run_if(resource_changed::<SettingsResource>),
|
update_high_contrast_backgrounds.run_if(resource_changed::<SettingsResource>),
|
||||||
update_reduce_motion_text,
|
update_reduce_motion_text,
|
||||||
update_touch_input_mode_text,
|
update_touch_input_mode_text,
|
||||||
|
update_ui_scale_text,
|
||||||
update_tooltip_delay_text,
|
update_tooltip_delay_text,
|
||||||
update_time_bonus_multiplier_text,
|
update_time_bonus_multiplier_text,
|
||||||
update_replay_move_interval_text,
|
update_replay_move_interval_text,
|
||||||
|
|||||||
@@ -736,3 +736,60 @@ fn scroll_clamps_offset_to_zero_at_top() {
|
|||||||
"scrolling past top must clamp to 0, got {offset}"
|
"scrolling past top must clamp to 0, got {offset}"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Phase K: UI scale
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ui_scale_steps_cycle_and_wrap() {
|
||||||
|
assert_eq!(next_ui_scale(0.9), 1.0);
|
||||||
|
assert_eq!(next_ui_scale(1.0), 1.15);
|
||||||
|
assert_eq!(next_ui_scale(1.15), 1.3);
|
||||||
|
assert_eq!(next_ui_scale(1.3), 0.9, "the cycle must wrap");
|
||||||
|
// A hand-edited in-between value advances to the next larger step.
|
||||||
|
assert_eq!(next_ui_scale(1.05), 1.15);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ui_scale_label_formats_as_percent() {
|
||||||
|
assert_eq!(ui_scale_label(0.9), "90%");
|
||||||
|
assert_eq!(ui_scale_label(1.0), "100%");
|
||||||
|
assert_eq!(ui_scale_label(1.15), "115%");
|
||||||
|
assert_eq!(ui_scale_label(1.3), "130%");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ui_scale_setting_syncs_the_bevy_resource() {
|
||||||
|
let mut app = headless_app();
|
||||||
|
app.insert_resource(UiScale(1.0));
|
||||||
|
app.world_mut()
|
||||||
|
.resource_mut::<SettingsResource>()
|
||||||
|
.0
|
||||||
|
.ui_scale = 1.3;
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert!(
|
||||||
|
(app.world().resource::<UiScale>().0 - 1.3).abs() < f32::EPSILON,
|
||||||
|
"Settings::ui_scale must drive bevy::ui::UiScale"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ui_scale_out_of_range_sanitizes_on_load() {
|
||||||
|
use solitaire_data::settings::{UI_SCALE_MAX, UI_SCALE_MIN};
|
||||||
|
|
||||||
|
let wild = Settings {
|
||||||
|
ui_scale: 5.0,
|
||||||
|
..Settings::default()
|
||||||
|
}
|
||||||
|
.sanitized();
|
||||||
|
assert_eq!(wild.ui_scale, UI_SCALE_MAX);
|
||||||
|
|
||||||
|
let tiny = Settings {
|
||||||
|
ui_scale: 0.1,
|
||||||
|
..Settings::default()
|
||||||
|
}
|
||||||
|
.sanitized();
|
||||||
|
assert_eq!(tiny.ui_scale, UI_SCALE_MIN);
|
||||||
|
}
|
||||||
|
|||||||
@@ -326,6 +326,15 @@ fn spawn_accessibility_tab(
|
|||||||
"One-tap: tap a card to auto-move it. Tap to select: first tap selects a card, second tap on a pile moves it.",
|
"One-tap: tap a card to auto-move it. Tap to select: first tap selects a card, second tap on a pile moves it.",
|
||||||
font_res,
|
font_res,
|
||||||
);
|
);
|
||||||
|
toggle_row(
|
||||||
|
body,
|
||||||
|
"UI Scale",
|
||||||
|
UiScaleText,
|
||||||
|
ui_scale_label(settings.ui_scale),
|
||||||
|
SettingsButton::CycleUiScale,
|
||||||
|
"Scales all menus, buttons, and HUD text. The table itself always fits the screen.",
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
tooltip_delay_row(body, settings.tooltip_delay_secs, font_res);
|
tooltip_delay_row(body, settings.tooltip_delay_secs, font_res);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -515,6 +515,58 @@ pub(super) fn touch_input_mode_label(mode: &solitaire_data::settings::TouchInput
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The four UI-scale steps the settings row cycles through (Phase K).
|
||||||
|
pub(super) const UI_SCALE_STEPS: [f32; 4] = [0.9, 1.0, 1.15, 1.3];
|
||||||
|
|
||||||
|
/// The next UI-scale step after `current`, wrapping 130 % → 90 %. A
|
||||||
|
/// hand-edited value between steps advances to the first step larger
|
||||||
|
/// than it, so the cycle always makes visible progress.
|
||||||
|
pub(super) fn next_ui_scale(current: f32) -> f32 {
|
||||||
|
for step in UI_SCALE_STEPS {
|
||||||
|
if step > current + 0.001 {
|
||||||
|
return step;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
UI_SCALE_STEPS[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Display string for the UI-scale row, e.g. `"115%"`.
|
||||||
|
pub(super) fn ui_scale_label(scale: f32) -> String {
|
||||||
|
format!("{:.0}%", scale * 100.0)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Refreshes the live UI-scale value text whenever settings change.
|
||||||
|
pub(super) fn update_ui_scale_text(
|
||||||
|
settings: Res<SettingsResource>,
|
||||||
|
mut text_nodes: Query<&mut Text, With<UiScaleText>>,
|
||||||
|
) {
|
||||||
|
if !settings.is_changed() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for mut text in &mut text_nodes {
|
||||||
|
**text = ui_scale_label(settings.0.ui_scale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Applies `Settings::ui_scale` to the live [`bevy::ui::UiScale`]
|
||||||
|
/// resource — at startup (first change tick) and whenever the setting
|
||||||
|
/// changes. Absent under `MinimalPlugins` (no `bevy_ui`), hence the
|
||||||
|
/// `Option`; the table is unaffected either way (`compute_layout`
|
||||||
|
/// owns world-space sizing, not UI scale).
|
||||||
|
pub(super) fn sync_ui_scale_resource(
|
||||||
|
settings: Res<SettingsResource>,
|
||||||
|
ui_scale: Option<ResMut<UiScale>>,
|
||||||
|
) {
|
||||||
|
let Some(mut ui_scale) = ui_scale else { return };
|
||||||
|
if !settings.is_changed() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let target = settings.0.ui_scale;
|
||||||
|
if (ui_scale.0 - target).abs() > f32::EPSILON {
|
||||||
|
ui_scale.0 = target;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Display string for the "Smart window size" toggle. The argument
|
/// Display string for the "Smart window size" toggle. The argument
|
||||||
/// is the *enabled* state (i.e. the inverse of the underlying
|
/// is the *enabled* state (i.e. the inverse of the underlying
|
||||||
/// `disable_smart_default_size` field) so reading the label gives
|
/// `disable_smart_default_size` field) so reading the label gives
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ use crate::ui_modal::{ButtonVariant, ModalButton, spawn_modal_button};
|
|||||||
use crate::ui_theme::{
|
use crate::ui_theme::{
|
||||||
ACCENT_PRIMARY, BG_ELEVATED_HI, BORDER_SUBTLE, HighContrastBorder, RADIUS_SM, STATE_INFO,
|
ACCENT_PRIMARY, BG_ELEVATED_HI, BORDER_SUBTLE, HighContrastBorder, RADIUS_SM, STATE_INFO,
|
||||||
STATE_WARNING, STREAK_MILESTONES, TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_BODY_LG,
|
STATE_WARNING, STREAK_MILESTONES, TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_BODY_LG,
|
||||||
TYPE_CAPTION, TYPE_HEADLINE, VAL_SPACE_1, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4,
|
TYPE_HEADLINE, VAL_SPACE_1, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4,
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Bevy resource wrapping the current stats.
|
/// Bevy resource wrapping the current stats.
|
||||||
@@ -719,25 +719,17 @@ pub(crate) fn spawn_stats_body(
|
|||||||
},
|
},
|
||||||
))
|
))
|
||||||
.with_children(|body| {
|
.with_children(|body| {
|
||||||
// First-launch caption — sits above the grid as gentle nudge so
|
// First-launch empty state (Phase L) — sits above the grid so
|
||||||
// the wall of em-dashes reads as "nothing to track yet" rather
|
// the wall of em-dashes reads as "nothing to track yet" rather
|
||||||
// than as broken state.
|
// than as broken state.
|
||||||
if is_first_launch {
|
if is_first_launch {
|
||||||
body.spawn((
|
crate::ui_modal::spawn_empty_state(
|
||||||
Text::new("Play a game to start tracking stats."),
|
body,
|
||||||
TextFont {
|
"\u{2663}",
|
||||||
font_size: TYPE_CAPTION,
|
"Play a game to start tracking stats.",
|
||||||
..default()
|
None,
|
||||||
},
|
font_res,
|
||||||
TextColor(TEXT_SECONDARY),
|
);
|
||||||
Node {
|
|
||||||
margin: UiRect {
|
|
||||||
bottom: VAL_SPACE_2,
|
|
||||||
..default()
|
|
||||||
},
|
|
||||||
..default()
|
|
||||||
},
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- primary stat cells grid ---
|
// --- primary stat cells grid ---
|
||||||
@@ -893,6 +885,20 @@ pub(crate) fn spawn_replays_body(
|
|||||||
selected_index: usize,
|
selected_index: usize,
|
||||||
font_res: Option<&FontResource>,
|
font_res: Option<&FontResource>,
|
||||||
) {
|
) {
|
||||||
|
// Standard empty state (Phase L) — the selector / Watch / Copy
|
||||||
|
// controls only spawn when there is something to select, so their
|
||||||
|
// handlers all no-op via their existing empty-query paths.
|
||||||
|
if replays.is_empty() {
|
||||||
|
crate::ui_modal::spawn_empty_state(
|
||||||
|
card,
|
||||||
|
"\u{2666}",
|
||||||
|
"No replays yet.",
|
||||||
|
Some("Every win records a replay here automatically."),
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let font_handle = font_res.map(|f| f.0.clone()).unwrap_or_default();
|
let font_handle = font_res.map(|f| f.0.clone()).unwrap_or_default();
|
||||||
let font_row = TextFont {
|
let font_row = TextFont {
|
||||||
font: font_handle,
|
font: font_handle,
|
||||||
|
|||||||
@@ -32,8 +32,8 @@ use crate::resources::TokioRuntimeResource;
|
|||||||
use crate::settings_plugin::{SettingsPanel, SettingsResource};
|
use crate::settings_plugin::{SettingsPanel, SettingsResource};
|
||||||
use crate::theme::{ImportError, ThemeRegistry, import_theme, refresh_registry};
|
use crate::theme::{ImportError, ThemeRegistry, import_theme, refresh_registry};
|
||||||
use crate::ui_modal::{
|
use crate::ui_modal::{
|
||||||
ButtonVariant, ModalScrim, ScrimDismissible, spawn_modal, spawn_modal_actions,
|
ButtonVariant, ModalScrim, ScrimDismissible, spawn_empty_state, spawn_modal,
|
||||||
spawn_modal_button, spawn_modal_header,
|
spawn_modal_actions, spawn_modal_button, spawn_modal_header,
|
||||||
};
|
};
|
||||||
use crate::ui_theme::{
|
use crate::ui_theme::{
|
||||||
BORDER_SUBTLE, TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_CAPTION, VAL_SPACE_2, VAL_SPACE_3,
|
BORDER_SUBTLE, TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_CAPTION, VAL_SPACE_2, VAL_SPACE_3,
|
||||||
@@ -528,25 +528,31 @@ fn spawn_store_modal(
|
|||||||
|
|
||||||
match catalog_state {
|
match catalog_state {
|
||||||
CatalogState::Idle | CatalogState::Loading => {
|
CatalogState::Idle | CatalogState::Loading => {
|
||||||
card.spawn((
|
spawn_empty_state(
|
||||||
Text::new("Loading catalog…"),
|
card,
|
||||||
body_font.clone(),
|
"\u{21BB}",
|
||||||
TextColor(TEXT_SECONDARY),
|
"Loading the catalog\u{2026}",
|
||||||
));
|
None,
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
CatalogState::Error(msg) => {
|
CatalogState::Error(msg) => {
|
||||||
card.spawn((
|
spawn_empty_state(
|
||||||
Text::new(format!("Could not load the catalog: {msg}")),
|
card,
|
||||||
body_font.clone(),
|
"!",
|
||||||
TextColor(TEXT_SECONDARY),
|
"Couldn't load the catalog.",
|
||||||
));
|
Some(msg.as_str()),
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
CatalogState::Loaded(entries) if entries.is_empty() => {
|
CatalogState::Loaded(entries) if entries.is_empty() => {
|
||||||
card.spawn((
|
spawn_empty_state(
|
||||||
Text::new("The server has no themes yet."),
|
card,
|
||||||
body_font.clone(),
|
"#",
|
||||||
TextColor(TEXT_SECONDARY),
|
"The server has no themes yet.",
|
||||||
));
|
Some("Themes dropped into the server's theme_store folder appear here."),
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
CatalogState::Loaded(entries) => {
|
CatalogState::Loaded(entries) => {
|
||||||
for entry in entries {
|
for entry in entries {
|
||||||
|
|||||||
@@ -60,9 +60,9 @@ use crate::settings_plugin::SettingsResource;
|
|||||||
use crate::ui_theme::{
|
use crate::ui_theme::{
|
||||||
ACCENT_PRIMARY, ACCENT_PRIMARY_HOVER, ACCENT_SECONDARY, BG_BASE, BG_ELEVATED, BG_ELEVATED_HI,
|
ACCENT_PRIMARY, ACCENT_PRIMARY_HOVER, ACCENT_SECONDARY, BG_BASE, BG_ELEVATED, BG_ELEVATED_HI,
|
||||||
BG_ELEVATED_PRESSED, BG_ELEVATED_TOP, BORDER_STRONG, BORDER_SUBTLE, HighContrastBorder,
|
BG_ELEVATED_PRESSED, BG_ELEVATED_TOP, BORDER_STRONG, BORDER_SUBTLE, HighContrastBorder,
|
||||||
MOTION_MODAL_SECS, RADIUS_LG, RADIUS_MD, RADIUS_SM, SCRIM, STATE_SUCCESS, TEXT_PRIMARY,
|
MOTION_MODAL_SECS, RADIUS_LG, RADIUS_MD, RADIUS_SM, SCRIM, STATE_SUCCESS, TEXT_DISABLED,
|
||||||
TEXT_SECONDARY, TYPE_BODY_LG, TYPE_CAPTION, TYPE_HEADLINE, VAL_SPACE_2, VAL_SPACE_3,
|
TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_BODY_LG, TYPE_CAPTION, TYPE_DISPLAY,
|
||||||
VAL_SPACE_4, VAL_SPACE_5, scaled_duration,
|
TYPE_HEADLINE, VAL_SPACE_2, VAL_SPACE_3, VAL_SPACE_4, VAL_SPACE_5, scaled_duration,
|
||||||
};
|
};
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -328,6 +328,80 @@ pub fn spawn_modal_body_text(
|
|||||||
parent.spawn((ModalBody, Text::new(text.into()), font, TextColor(color)));
|
parent.spawn((ModalBody, Text::new(text.into()), font, TextColor(color)));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Standard empty / loading / error surface (Phase L): a large glyph,
|
||||||
|
/// a headline, and an optional secondary detail line, centred in the
|
||||||
|
/// available space. Every async or possibly-empty surface (leaderboard,
|
||||||
|
/// replays, theme store, first-launch stats) renders through this so
|
||||||
|
/// "nothing here yet" reads identically everywhere.
|
||||||
|
///
|
||||||
|
/// A next-step action is composition, not configuration: spawn a
|
||||||
|
/// [`spawn_modal_button`] (or any control) in the same parent right
|
||||||
|
/// after this call.
|
||||||
|
///
|
||||||
|
/// `glyph` MUST come from FiraMono-covered ranges — card suits
|
||||||
|
/// (U+2660–2666), Arrows (U+2190–21FF), or ASCII. The Geometric Shapes
|
||||||
|
/// block renders as tofu on Android (§10 / §11).
|
||||||
|
pub fn spawn_empty_state(
|
||||||
|
parent: &mut ChildSpawnerCommands,
|
||||||
|
glyph: &str,
|
||||||
|
headline: &str,
|
||||||
|
detail: Option<&str>,
|
||||||
|
font_res: Option<&FontResource>,
|
||||||
|
) {
|
||||||
|
let font_handle = font_res.map(|f| f.0.clone()).unwrap_or_default();
|
||||||
|
let font_glyph = TextFont {
|
||||||
|
font: font_handle.clone(),
|
||||||
|
font_size: TYPE_DISPLAY,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
let font_headline = TextFont {
|
||||||
|
font: font_handle.clone(),
|
||||||
|
font_size: TYPE_BODY_LG,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
let font_detail = TextFont {
|
||||||
|
font: font_handle,
|
||||||
|
font_size: TYPE_BODY,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
|
||||||
|
parent
|
||||||
|
.spawn((
|
||||||
|
EmptyStateBlock,
|
||||||
|
Node {
|
||||||
|
flex_direction: FlexDirection::Column,
|
||||||
|
align_items: AlignItems::Center,
|
||||||
|
row_gap: VAL_SPACE_2,
|
||||||
|
padding: UiRect::axes(VAL_SPACE_3, VAL_SPACE_5),
|
||||||
|
width: Val::Percent(100.0),
|
||||||
|
..default()
|
||||||
|
},
|
||||||
|
))
|
||||||
|
.with_children(|block| {
|
||||||
|
block.spawn((
|
||||||
|
Text::new(glyph.to_string()),
|
||||||
|
font_glyph,
|
||||||
|
TextColor(TEXT_DISABLED),
|
||||||
|
));
|
||||||
|
block.spawn((
|
||||||
|
Text::new(headline.to_string()),
|
||||||
|
font_headline,
|
||||||
|
TextColor(TEXT_PRIMARY),
|
||||||
|
));
|
||||||
|
if let Some(detail) = detail {
|
||||||
|
block.spawn((
|
||||||
|
Text::new(detail.to_string()),
|
||||||
|
font_detail,
|
||||||
|
TextColor(TEXT_SECONDARY),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Marker on every [`spawn_empty_state`] block, mostly for tests.
|
||||||
|
#[derive(Component, Debug)]
|
||||||
|
pub struct EmptyStateBlock;
|
||||||
|
|
||||||
/// Spawns the bottom actions row — flex-row with primary right-aligned.
|
/// Spawns the bottom actions row — flex-row with primary right-aligned.
|
||||||
/// The closure populates the row's buttons via `spawn_modal_button`.
|
/// The closure populates the row's buttons via `spawn_modal_button`.
|
||||||
///
|
///
|
||||||
@@ -1184,4 +1258,62 @@ mod tests {
|
|||||||
"exactly one of the two stacked dismissible modals should remain"
|
"exactly one of the two stacked dismissible modals should remain"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
// Phase L: standard empty state
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
/// The helper spawns glyph + headline (+ detail when given) under one
|
||||||
|
/// marked block, so every empty surface renders identically.
|
||||||
|
#[test]
|
||||||
|
fn empty_state_spawns_expected_structure() {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins);
|
||||||
|
{
|
||||||
|
let world = app.world_mut();
|
||||||
|
let mut commands = world.commands();
|
||||||
|
commands.spawn(Node::default()).with_children(|parent| {
|
||||||
|
spawn_empty_state(
|
||||||
|
parent,
|
||||||
|
"\u{2660}",
|
||||||
|
"Nothing here.",
|
||||||
|
Some("Do the thing."),
|
||||||
|
None,
|
||||||
|
);
|
||||||
|
spawn_empty_state(parent, "!", "No detail variant.", None, None);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
let blocks = app
|
||||||
|
.world_mut()
|
||||||
|
.query_filtered::<Entity, With<EmptyStateBlock>>()
|
||||||
|
.iter(app.world())
|
||||||
|
.count();
|
||||||
|
assert_eq!(blocks, 2, "each call spawns exactly one marked block");
|
||||||
|
|
||||||
|
let texts: Vec<String> = app
|
||||||
|
.world_mut()
|
||||||
|
.query::<&Text>()
|
||||||
|
.iter(app.world())
|
||||||
|
.map(|t| t.0.clone())
|
||||||
|
.collect();
|
||||||
|
for expected in [
|
||||||
|
"\u{2660}",
|
||||||
|
"Nothing here.",
|
||||||
|
"Do the thing.",
|
||||||
|
"!",
|
||||||
|
"No detail variant.",
|
||||||
|
] {
|
||||||
|
assert!(
|
||||||
|
texts.iter().any(|t| t == expected),
|
||||||
|
"missing text node {expected:?}; got {texts:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
assert_eq!(
|
||||||
|
texts.len(),
|
||||||
|
5,
|
||||||
|
"the detail-less variant must not spawn a detail node"
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,527 @@
|
|||||||
|
//! One-shot "What's new" card on the first launch after an update
|
||||||
|
//! (Phase I of the 2026-07 UI redesign).
|
||||||
|
//!
|
||||||
|
//! ObtainX updates install silently, so shipped features go unnoticed —
|
||||||
|
//! nobody found the theme store on their own. On the first launch where
|
||||||
|
//! the running release differs from `Settings::last_seen_whats_new`,
|
||||||
|
//! this plugin shows a single dismissible card summarising the latest
|
||||||
|
//! changelog section, then records the version so the card never
|
||||||
|
//! repeats. Fresh installs never see it: onboarding completion stamps
|
||||||
|
//! the current version silently, so the card only ever describes an
|
||||||
|
//! *upgrade*.
|
||||||
|
//!
|
||||||
|
//! # Launch beat
|
||||||
|
//!
|
||||||
|
//! Splash → (first run only: onboarding) → **what's new** → Home →
|
||||||
|
//! table. `spawn_home_on_launch` waits on [`WhatsNewPending`] the same
|
||||||
|
//! way it waits for the onboarding modal.
|
||||||
|
//!
|
||||||
|
//! # Version source
|
||||||
|
//!
|
||||||
|
//! The embedded `CHANGELOG.md`'s topmost release section provides both
|
||||||
|
//! the card's content and the "current version" for change detection —
|
||||||
|
//! one source of truth, no build-time version plumbing. (The APK
|
||||||
|
//! `versionName` comes from the release tag at package time and never
|
||||||
|
//! reaches Rust; the workspace `Cargo.toml` version is static.)
|
||||||
|
|
||||||
|
use bevy::input::ButtonInput;
|
||||||
|
use bevy::prelude::*;
|
||||||
|
use solitaire_data::save_settings_to;
|
||||||
|
|
||||||
|
use crate::font_plugin::FontResource;
|
||||||
|
use crate::onboarding_plugin::OnboardingScreen;
|
||||||
|
use crate::settings_plugin::{SettingsResource, SettingsStoragePath};
|
||||||
|
use crate::ui_modal::{
|
||||||
|
ButtonVariant, ModalScrim, spawn_modal, spawn_modal_actions, spawn_modal_button,
|
||||||
|
spawn_modal_header,
|
||||||
|
};
|
||||||
|
use crate::ui_theme::{
|
||||||
|
TEXT_PRIMARY, TEXT_SECONDARY, TYPE_BODY, TYPE_CAPTION, VAL_SPACE_1, VAL_SPACE_2, Z_MODAL_PANEL,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// The changelog ships inside the binary — small, changes only at
|
||||||
|
/// release cadence, and the card must work offline (§4.2).
|
||||||
|
const CHANGELOG: &str = include_str!("../../CHANGELOG.md");
|
||||||
|
|
||||||
|
/// Most bullets shown on the card; a giant release stays skimmable.
|
||||||
|
const MAX_CARD_BULLETS: usize = 8;
|
||||||
|
|
||||||
|
/// Marker on the What's-new modal's scrim root.
|
||||||
|
#[derive(Component, Debug)]
|
||||||
|
pub struct WhatsNewScreen;
|
||||||
|
|
||||||
|
/// Marker on the card's "Got it" button.
|
||||||
|
#[derive(Component, Debug)]
|
||||||
|
struct WhatsNewCloseButton;
|
||||||
|
|
||||||
|
/// `true` until this plugin has made its launch-beat decision — either
|
||||||
|
/// the card was shown and dismissed, or there was nothing to show.
|
||||||
|
/// `spawn_home_on_launch` waits on this so the card gets the beat
|
||||||
|
/// before Home.
|
||||||
|
#[derive(Resource, Debug)]
|
||||||
|
pub struct WhatsNewPending(pub bool);
|
||||||
|
|
||||||
|
impl Default for WhatsNewPending {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self(true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One display line of the card.
|
||||||
|
#[derive(Debug, PartialEq, Eq)]
|
||||||
|
enum NoteLine {
|
||||||
|
/// A `###` section heading ("Added", "Fixed", …).
|
||||||
|
Heading(String),
|
||||||
|
/// The lead sentence of one changelog bullet.
|
||||||
|
Bullet(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The changelog's topmost release section, reduced to card content.
|
||||||
|
#[derive(Debug)]
|
||||||
|
struct ReleaseNotes {
|
||||||
|
/// Version string without the `v` prefix, e.g. `"0.46.0"`.
|
||||||
|
version: String,
|
||||||
|
lines: Vec<NoteLine>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The version of the topmost changelog release — the engine's notion
|
||||||
|
/// of "the running release". Empty only if the changelog is malformed.
|
||||||
|
pub fn current_release_version() -> String {
|
||||||
|
parse_latest_release(CHANGELOG).map_or_else(String::new, |notes| notes.version)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Parses the first `## [x.y.z]` section of `changelog` into card
|
||||||
|
/// content. `## [Unreleased]` is skipped; `### Internal` subsections
|
||||||
|
/// are dropped (players don't care about CI); each bullet is reduced
|
||||||
|
/// to its lead sentence with markdown emphasis stripped.
|
||||||
|
fn parse_latest_release(changelog: &str) -> Option<ReleaseNotes> {
|
||||||
|
let mut lines_iter = changelog.lines();
|
||||||
|
let mut version = None;
|
||||||
|
for line in lines_iter.by_ref() {
|
||||||
|
if let Some(rest) = line.strip_prefix("## [") {
|
||||||
|
let (v, _) = rest.split_once(']')?;
|
||||||
|
if v.eq_ignore_ascii_case("Unreleased") {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
version = Some(v.to_string());
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let version = version?;
|
||||||
|
|
||||||
|
let mut lines = Vec::new();
|
||||||
|
let mut skipping_section = false;
|
||||||
|
let mut current_bullet: Option<String> = None;
|
||||||
|
|
||||||
|
let flush = |bullet: &mut Option<String>, lines: &mut Vec<NoteLine>| {
|
||||||
|
if let Some(text) = bullet.take() {
|
||||||
|
lines.push(NoteLine::Bullet(lead_sentence(&text)));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
for line in lines_iter {
|
||||||
|
if line.starts_with("## [") {
|
||||||
|
break; // next (older) release section
|
||||||
|
}
|
||||||
|
if let Some(heading) = line.strip_prefix("### ") {
|
||||||
|
flush(&mut current_bullet, &mut lines);
|
||||||
|
skipping_section = heading.trim().eq_ignore_ascii_case("internal");
|
||||||
|
if !skipping_section {
|
||||||
|
lines.push(NoteLine::Heading(heading.trim().to_string()));
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if skipping_section {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some(rest) = line.strip_prefix("- ") {
|
||||||
|
flush(&mut current_bullet, &mut lines);
|
||||||
|
current_bullet = Some(rest.trim().to_string());
|
||||||
|
} else if current_bullet.is_some() && !line.trim().is_empty() {
|
||||||
|
// Wrapped continuation of the current bullet.
|
||||||
|
if let Some(bullet) = current_bullet.as_mut() {
|
||||||
|
bullet.push(' ');
|
||||||
|
bullet.push_str(line.trim());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
flush(&mut current_bullet, &mut lines);
|
||||||
|
|
||||||
|
Some(ReleaseNotes { version, lines })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Strips markdown emphasis / code ticks and truncates to the first
|
||||||
|
/// sentence — changelog bullets lead with a bold summary sentence, and
|
||||||
|
/// that is exactly the card-sized version.
|
||||||
|
fn lead_sentence(bullet: &str) -> String {
|
||||||
|
let stripped: String = bullet.replace("**", "").replace('`', "");
|
||||||
|
// Trailing "(#123)" references never survive the sentence cut, but
|
||||||
|
// guard against a bullet that is only a reference.
|
||||||
|
let end = stripped.find(". ").map_or(stripped.len(), |i| i + 1);
|
||||||
|
stripped[..end].trim().trim_end_matches('.').to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Registers the launch-gate spawn system and the dismiss handlers.
|
||||||
|
pub struct WhatsNewPlugin;
|
||||||
|
|
||||||
|
impl Plugin for WhatsNewPlugin {
|
||||||
|
fn build(&self, app: &mut App) {
|
||||||
|
app.init_resource::<WhatsNewPending>()
|
||||||
|
.init_resource::<ButtonInput<KeyCode>>()
|
||||||
|
.add_systems(
|
||||||
|
Update,
|
||||||
|
(maybe_spawn_whats_new, handle_whats_new_close).chain(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shows the card once the launch surface is clear, or stands down when
|
||||||
|
/// there is nothing to show. See the module docs for the exact beat.
|
||||||
|
///
|
||||||
|
/// The seen-version stamp persists on *spawn*, not dismissal — if the
|
||||||
|
/// app dies with the card open the player has still seen it once, and
|
||||||
|
/// the card must never nag.
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
|
fn maybe_spawn_whats_new(
|
||||||
|
mut commands: Commands,
|
||||||
|
mut pending: ResMut<WhatsNewPending>,
|
||||||
|
splash: Query<(), With<crate::splash_plugin::SplashRoot>>,
|
||||||
|
onboarding: Query<(), With<OnboardingScreen>>,
|
||||||
|
restore_prompts: Query<(), With<crate::game_plugin::RestorePromptScreen>>,
|
||||||
|
pending_restore: Option<Res<crate::game_plugin::PendingRestoredGame>>,
|
||||||
|
other_scrims: Query<(), With<ModalScrim>>,
|
||||||
|
mut settings: Option<ResMut<SettingsResource>>,
|
||||||
|
storage_path: Option<Res<SettingsStoragePath>>,
|
||||||
|
font_res: Option<Res<FontResource>>,
|
||||||
|
screens: Query<(), With<WhatsNewScreen>>,
|
||||||
|
) {
|
||||||
|
if !pending.0 {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if !screens.is_empty() {
|
||||||
|
// Card already open — the seen-version stamp landed on spawn,
|
||||||
|
// so without this guard the next frame would read "already
|
||||||
|
// seen" and release the beat under the open card.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if !splash.is_empty()
|
||||||
|
|| !onboarding.is_empty()
|
||||||
|
|| !restore_prompts.is_empty()
|
||||||
|
|| pending_restore.as_ref().is_some_and(|p| p.0.is_some())
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let Some(settings) = settings.as_mut() else {
|
||||||
|
// Headless / no settings wired: nothing to compare against.
|
||||||
|
pending.0 = false;
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
if !settings.0.first_run_complete {
|
||||||
|
// Fresh install mid-onboarding — completion stamps the version
|
||||||
|
// itself (see `complete_onboarding`), which resolves this gate
|
||||||
|
// on a later frame without ever showing the card.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let Some(notes) = parse_latest_release(CHANGELOG) else {
|
||||||
|
pending.0 = false;
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
if settings.0.last_seen_whats_new == notes.version {
|
||||||
|
pending.0 = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if !other_scrims.is_empty() {
|
||||||
|
// Another modal owns the beat right now; try again next frame.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
spawn_whats_new_card(&mut commands, ¬es, font_res.as_deref());
|
||||||
|
|
||||||
|
settings.0.last_seen_whats_new = notes.version.clone();
|
||||||
|
if let Some(p) = storage_path
|
||||||
|
&& let Some(path) = p.0.as_deref()
|
||||||
|
&& let Err(e) = save_settings_to(path, &settings.0)
|
||||||
|
{
|
||||||
|
warn!("whats-new: failed to persist seen version: {e}");
|
||||||
|
}
|
||||||
|
// `pending` stays true until dismissal so Home keeps waiting.
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Dismisses the card on "Got it" or Esc and releases the launch beat.
|
||||||
|
fn handle_whats_new_close(
|
||||||
|
mut commands: Commands,
|
||||||
|
keys: Option<Res<ButtonInput<KeyCode>>>,
|
||||||
|
buttons: Query<&Interaction, (With<WhatsNewCloseButton>, Changed<Interaction>)>,
|
||||||
|
screens: Query<Entity, With<WhatsNewScreen>>,
|
||||||
|
other_scrims: Query<(), (With<ModalScrim>, Without<WhatsNewScreen>)>,
|
||||||
|
mut pending: ResMut<WhatsNewPending>,
|
||||||
|
) {
|
||||||
|
if screens.is_empty() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let click = buttons.iter().any(|i| *i == Interaction::Pressed);
|
||||||
|
let esc = keys.is_some_and(|k| k.just_pressed(KeyCode::Escape)) && other_scrims.is_empty();
|
||||||
|
if !click && !esc {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for entity in &screens {
|
||||||
|
commands.entity(entity).despawn();
|
||||||
|
}
|
||||||
|
pending.0 = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Spawns the card: header with the version, the parsed changelog
|
||||||
|
/// lines, and a "Got it" action.
|
||||||
|
fn spawn_whats_new_card(
|
||||||
|
commands: &mut Commands,
|
||||||
|
notes: &ReleaseNotes,
|
||||||
|
font_res: Option<&FontResource>,
|
||||||
|
) {
|
||||||
|
let font_handle = font_res.map(|f| f.0.clone()).unwrap_or_default();
|
||||||
|
let font_heading = TextFont {
|
||||||
|
font: font_handle.clone(),
|
||||||
|
font_size: TYPE_CAPTION,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
let font_bullet = TextFont {
|
||||||
|
font: font_handle,
|
||||||
|
font_size: TYPE_BODY,
|
||||||
|
..default()
|
||||||
|
};
|
||||||
|
|
||||||
|
// Deliberately NOT ScrimDismissible: scrim-tap despawns without
|
||||||
|
// running the close handler, which would leave the launch beat
|
||||||
|
// held and Home never spawning. Esc and "Got it" both release it.
|
||||||
|
let title = format!("What's new in v{}", notes.version);
|
||||||
|
spawn_modal(commands, WhatsNewScreen, Z_MODAL_PANEL, |card| {
|
||||||
|
spawn_modal_header(card, &title, font_res);
|
||||||
|
|
||||||
|
card.spawn(Node {
|
||||||
|
flex_direction: FlexDirection::Column,
|
||||||
|
row_gap: VAL_SPACE_2,
|
||||||
|
width: Val::Percent(100.0),
|
||||||
|
max_height: Val::Vh(60.0),
|
||||||
|
overflow: Overflow::scroll_y(),
|
||||||
|
..default()
|
||||||
|
})
|
||||||
|
.with_children(|body| {
|
||||||
|
let mut bullets_shown = 0usize;
|
||||||
|
for line in ¬es.lines {
|
||||||
|
match line {
|
||||||
|
NoteLine::Heading(heading) => {
|
||||||
|
body.spawn((
|
||||||
|
Text::new(heading.clone()),
|
||||||
|
font_heading.clone(),
|
||||||
|
TextColor(TEXT_SECONDARY),
|
||||||
|
Node {
|
||||||
|
margin: UiRect::top(VAL_SPACE_1),
|
||||||
|
..default()
|
||||||
|
},
|
||||||
|
));
|
||||||
|
}
|
||||||
|
NoteLine::Bullet(text) => {
|
||||||
|
if bullets_shown >= MAX_CARD_BULLETS {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
bullets_shown += 1;
|
||||||
|
body.spawn((
|
||||||
|
Text::new(format!("\u{2022} {text}")),
|
||||||
|
font_bullet.clone(),
|
||||||
|
TextColor(TEXT_PRIMARY),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
spawn_modal_actions(card, |actions| {
|
||||||
|
spawn_modal_button(
|
||||||
|
actions,
|
||||||
|
WhatsNewCloseButton,
|
||||||
|
"Got it",
|
||||||
|
None,
|
||||||
|
ButtonVariant::Primary,
|
||||||
|
font_res,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use solitaire_data::Settings;
|
||||||
|
|
||||||
|
const SAMPLE: &str = "# Changelog\n\n## [Unreleased]\n\n## [0.46.0] — 2026-07-13\n\n\
|
||||||
|
### Added\n\n- **Theme-store previews.** The store modal now shows each theme's\n \
|
||||||
|
preview image next to its name. (#179)\n- **Hint ghost preview.** You see the move. (#179)\n\n\
|
||||||
|
### Internal\n\n- **CI is faster.** Nobody cares in-game. (#176)\n\n\
|
||||||
|
### Fixed\n\n- **Touch onboarding copy.** No more left-click. (#178)\n\n\
|
||||||
|
## [0.45.0] — 2026-07-13\n\n### Added\n\n- Old stuff.\n";
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parses_top_section_version_and_skips_unreleased() {
|
||||||
|
let notes = parse_latest_release(SAMPLE).expect("sample must parse");
|
||||||
|
assert_eq!(notes.version, "0.46.0");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn drops_internal_sections_and_older_releases() {
|
||||||
|
let notes = parse_latest_release(SAMPLE).expect("sample must parse");
|
||||||
|
let headings: Vec<&str> = notes
|
||||||
|
.lines
|
||||||
|
.iter()
|
||||||
|
.filter_map(|l| match l {
|
||||||
|
NoteLine::Heading(h) => Some(h.as_str()),
|
||||||
|
_ => None,
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
assert_eq!(headings, vec!["Added", "Fixed"]);
|
||||||
|
assert!(
|
||||||
|
!notes
|
||||||
|
.lines
|
||||||
|
.iter()
|
||||||
|
.any(|l| matches!(l, NoteLine::Bullet(b) if b.contains("CI is faster"))),
|
||||||
|
"Internal bullets must not reach the card"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
!notes
|
||||||
|
.lines
|
||||||
|
.iter()
|
||||||
|
.any(|l| matches!(l, NoteLine::Bullet(b) if b.contains("Old stuff"))),
|
||||||
|
"older release sections must not bleed in"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn bullets_reduce_to_their_lead_sentence() {
|
||||||
|
let notes = parse_latest_release(SAMPLE).expect("sample must parse");
|
||||||
|
assert!(
|
||||||
|
notes
|
||||||
|
.lines
|
||||||
|
.contains(&NoteLine::Bullet("Theme-store previews".to_string()))
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
notes
|
||||||
|
.lines
|
||||||
|
.contains(&NoteLine::Bullet("Hint ghost preview".to_string()))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn embedded_changelog_parses_to_a_nonempty_version() {
|
||||||
|
let version = current_release_version();
|
||||||
|
assert!(
|
||||||
|
!version.is_empty(),
|
||||||
|
"the real CHANGELOG.md must yield a version"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
version.chars().next().is_some_and(|c| c.is_ascii_digit()),
|
||||||
|
"version must be bare (no v prefix): {version}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn app_with(settings: Settings) -> App {
|
||||||
|
let mut app = App::new();
|
||||||
|
app.add_plugins(MinimalPlugins).add_plugins(WhatsNewPlugin);
|
||||||
|
app.insert_resource(SettingsResource(settings));
|
||||||
|
app.update();
|
||||||
|
app
|
||||||
|
}
|
||||||
|
|
||||||
|
fn card_count(app: &mut App) -> usize {
|
||||||
|
app.world_mut()
|
||||||
|
.query::<&WhatsNewScreen>()
|
||||||
|
.iter(app.world())
|
||||||
|
.count()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn upgrade_shows_card_and_stamps_version() {
|
||||||
|
let mut app = app_with(Settings {
|
||||||
|
first_run_complete: true,
|
||||||
|
last_seen_whats_new: "0.1.0".into(),
|
||||||
|
..Settings::default()
|
||||||
|
});
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert_eq!(card_count(&mut app), 1, "an upgrade must show the card");
|
||||||
|
assert_eq!(
|
||||||
|
app.world()
|
||||||
|
.resource::<SettingsResource>()
|
||||||
|
.0
|
||||||
|
.last_seen_whats_new,
|
||||||
|
current_release_version(),
|
||||||
|
"the seen version must stamp on spawn"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
app.world().resource::<WhatsNewPending>().0,
|
||||||
|
"the launch beat stays held until dismissal"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn seen_version_shows_nothing_and_releases_the_beat() {
|
||||||
|
let mut app = app_with(Settings {
|
||||||
|
first_run_complete: true,
|
||||||
|
last_seen_whats_new: current_release_version(),
|
||||||
|
..Settings::default()
|
||||||
|
});
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert_eq!(card_count(&mut app), 0);
|
||||||
|
assert!(
|
||||||
|
!app.world().resource::<WhatsNewPending>().0,
|
||||||
|
"nothing to show must release the launch beat"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn fresh_install_waits_for_onboarding_and_never_shows() {
|
||||||
|
let mut app = app_with(Settings {
|
||||||
|
first_run_complete: false,
|
||||||
|
..Settings::default()
|
||||||
|
});
|
||||||
|
app.update();
|
||||||
|
assert_eq!(card_count(&mut app), 0);
|
||||||
|
assert!(
|
||||||
|
app.world().resource::<WhatsNewPending>().0,
|
||||||
|
"mid-onboarding the beat stays held"
|
||||||
|
);
|
||||||
|
|
||||||
|
// Onboarding completion stamps the version (mirrored from
|
||||||
|
// complete_onboarding) — afterwards the card must stand down.
|
||||||
|
{
|
||||||
|
let mut settings = app.world_mut().resource_mut::<SettingsResource>();
|
||||||
|
settings.0.first_run_complete = true;
|
||||||
|
settings.0.last_seen_whats_new = current_release_version();
|
||||||
|
}
|
||||||
|
app.update();
|
||||||
|
assert_eq!(card_count(&mut app), 0, "fresh installs never see the card");
|
||||||
|
assert!(!app.world().resource::<WhatsNewPending>().0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn got_it_dismisses_and_releases_the_beat() {
|
||||||
|
let mut app = app_with(Settings {
|
||||||
|
first_run_complete: true,
|
||||||
|
..Settings::default()
|
||||||
|
});
|
||||||
|
app.update();
|
||||||
|
assert_eq!(card_count(&mut app), 1);
|
||||||
|
|
||||||
|
let button = app
|
||||||
|
.world_mut()
|
||||||
|
.query_filtered::<Entity, With<WhatsNewCloseButton>>()
|
||||||
|
.single(app.world())
|
||||||
|
.expect("Got it button must exist");
|
||||||
|
app.world_mut()
|
||||||
|
.entity_mut(button)
|
||||||
|
.insert(Interaction::Pressed);
|
||||||
|
app.update();
|
||||||
|
app.update();
|
||||||
|
|
||||||
|
assert_eq!(card_count(&mut app), 0, "Got it must dismiss the card");
|
||||||
|
assert!(!app.world().resource::<WhatsNewPending>().0);
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user