Remove instructions screen, go straight to character selection (theta…

…wavegame#189)

crates/thetawave_interface/src/states.rs

@@ -6,7 +6,6 @@ pub enum AppStates {
     #[default]
     LoadingAssets,
     MainMenu,
-    Instructions,
     CharacterSelection,
     InitializeRun,
     Game,
@@ -36,8 +35,5 @@ pub struct VictoryCleanup;
 #[derive(Component)]
 pub struct PauseCleanup;
 
-#[derive(Component)]
-pub struct InstructionsCleanup;
-
 #[derive(Component)]
 pub struct CharacterSelectionCleanup;

crates/thetawave_storage/src/plugin.rs

@@ -171,7 +171,7 @@ mod test {
     }
 
     fn set_dummy_terminal_game_state(mut s: ResMut<NextState<AppStates>>) {
-        (*s).set(AppStates::Instructions);
+        (*s).set(AppStates::CharacterSelection);
     }
 
     fn clear_completed_games_metrics(

src/states/game.rs

@@ -32,23 +32,3 @@ pub(super) fn start_game_system(
         });
     }
 }
-
-pub(super) fn start_character_selection_system(
-    menu_input_query: Query<&ActionState<MenuAction>, With<MenuExplorer>>,
-    mut next_app_state: ResMut<NextState<AppStates>>,
-    mut sound_effect_pub: EventWriter<PlaySoundEffectEvent>,
-) {
-    // read menu input action
-    let action_state = menu_input_query.single();
-
-    // if input read enter the game state
-    if action_state.just_released(&MenuAction::Confirm) {
-        // set the state to game
-        next_app_state.set(AppStates::CharacterSelection);
-
-        // play sound effect
-        sound_effect_pub.send(PlaySoundEffectEvent {
-            sound_effect_type: SoundEffectType::MenuInputSuccess,
-        });
-    }
-}

src/states/mod.rs

@@ -14,7 +14,6 @@ use thetawave_interface::input::MenuExplorer;
 use thetawave_interface::states::CharacterSelectionCleanup;
 use thetawave_interface::states::GameCleanup;
 use thetawave_interface::states::GameOverCleanup;
-use thetawave_interface::states::InstructionsCleanup;
 use thetawave_interface::states::MainMenuCleanup;
 use thetawave_interface::states::PauseCleanup;
 use thetawave_interface::states::VictoryCleanup;
@@ -34,7 +33,7 @@ use crate::assets::UiAssets;
 use crate::GameEnterSet;
 use crate::GameUpdateSet;
 
-use self::game::{start_character_selection_system, start_game_system};
+use self::game::start_game_system;
 use self::pause_menu::{close_pause_menu_system, open_pause_menu_system};
 /// Includes systems that handle state transitions for `AppStates` and `GameStates`. Also includes
 /// an asset loading state.
@@ -115,11 +114,6 @@ impl Plugin for StatesPlugin {
                 .run_if(in_state(GameStates::Playing)),
         );
 
-        app.add_systems(
-            Update,
-            start_character_selection_system.run_if(in_state(AppStates::Instructions)),
-        );
-
         app.add_systems(
             Update,
             start_game_system.run_if(in_state(AppStates::CharacterSelection)),
@@ -152,11 +146,6 @@ impl Plugin for StatesPlugin {
             clear_state_system::<PauseCleanup>,
         );
 
-        app.add_systems(
-            OnExit(AppStates::Instructions),
-            clear_state_system::<InstructionsCleanup>,
-        );
-
         app.add_systems(
             Update,
             close_pause_menu_system.run_if(in_state(GameStates::Paused)),

src/ui/main_menu/button.rs

@@ -1,7 +1,7 @@
 //! Provides the layout (trait on `bevy::hierarchy::ChildBUilder`) and behavior (systems) to put 4
 //! vertically layed out on the main menu, and change the state from
 //! `thetawave_interface::states::AppStates::MainMenu` to
-//! `thetawave_interface::states::AppStates::Instructions`
+//! `thetawave_interface::states::AppStates::CharacterSelection`
 use crate::assets::UiAssets;
 use bevy::{
     app::AppExit,
@@ -44,11 +44,11 @@ const BUTTON_TEXTURE_PADDING_HOVERED: UiRect =
     UiRect::new(Val::ZERO, Val::ZERO, Val::Percent(10.5), Val::ZERO);
 
 /// Event and Component for giving and sending menu buttons actions to move the user from
-/// `AppStates::MainMenu` to `AppStates::Instructions`, plus possibly a few digressions and
+/// `AppStates::MainMenu` to `AppStates::CharacterSelection`, plus possibly a few digressions and
 /// sprinkles.
 #[derive(Component, Event, Clone, PartialEq, Eq, Copy, Debug)]
 pub(super) enum MainMenuButtonActionComponent {
-    EnterInstructions,
+    EnterCharacterSelection,
     EnterOptions,
     EnterCompendium,
     QuitGame,
@@ -59,7 +59,7 @@ impl MainMenuButtonActionComponent {
     /// option/action
     fn in_game_text(&self) -> &'static str {
         match self {
-            Self::EnterInstructions => "Start Game",
+            Self::EnterCharacterSelection => "Start Game",
             Self::EnterOptions => "Options",
             Self::EnterCompendium => "Compendium",
             Self::QuitGame => "Exit Game",
@@ -68,7 +68,7 @@ impl MainMenuButtonActionComponent {
 }
 /// This is the order (vertical, going down) of the buttons shown on the main menu UI.
 const MAIN_MENU_BUTTON_ORDER: [MainMenuButtonActionComponent; 4] = [
-    MainMenuButtonActionComponent::EnterInstructions,
+    MainMenuButtonActionComponent::EnterCharacterSelection,
     MainMenuButtonActionComponent::EnterOptions,
     MainMenuButtonActionComponent::EnterCompendium,
     MainMenuButtonActionComponent::QuitGame,
@@ -368,8 +368,8 @@ pub(super) fn main_menu_button_on_click_system(
 ) {
     for event in button_event_reader.read() {
         match event {
-            MainMenuButtonActionComponent::EnterInstructions => {
-                next_app_state.set(AppStates::Instructions);
+            MainMenuButtonActionComponent::EnterCharacterSelection => {
+                next_app_state.set(AppStates::CharacterSelection);
             }
             MainMenuButtonActionComponent::EnterOptions => info!("Enter options menu."),
             MainMenuButtonActionComponent::EnterCompendium => info!("Enter compendium."),

src/ui/main_menu/mod.rs

@@ -1,5 +1,5 @@
 //! Exposes a plugin to handle the layout and behavior of a button-based main menu that mainly
-//! guides the user into the `thetawave_interface::states::AppStates::Instructions` state.
+//! guides the user into the `thetawave_interface::states::AppStates::CharacterSelection` state.
 use crate::{
     animation::{AnimationComponent, AnimationDirection},
     assets::UiAssets,
@@ -30,7 +30,7 @@ use self::button::main_menu_button_selection_and_click_system;
 use self::button::MainMenuButtonActionEvent;
 use self::button::UiChildBuilderExt;
 /// Renders a button-based UI to transition the app from `AppStates::MainMenu` to
-/// `AppStates::Instructions`, possibly with some digressions. Without this plugin, the game will
+/// `AppStates::CharacterSelection`, possibly with some digressions. Without this plugin, the game will
 /// never progress past a blank main menu screen and the user cannot start the run.
 pub(super) struct MainMenuUIPlugin;
 impl Plugin for MainMenuUIPlugin {

src/ui/mod.rs

@@ -12,7 +12,6 @@ use thetawave_interface::states;
 mod character_selection;
 mod game;
 mod game_over;
-mod instructions;
 mod main_menu;
 mod pause_menu;
 mod victory;
@@ -24,7 +23,6 @@ use self::{
     },
     game::GameUiPlugin,
     game_over::setup_game_over_system,
-    instructions::setup_instructions_system,
     main_menu::MainMenuUIPlugin,
     pause_menu::setup_pause_system,
     victory::setup_victory_system,
@@ -41,11 +39,6 @@ impl Plugin for UiPlugin {
         app.add_plugins(MainMenuUIPlugin);
         app.add_systems(Update, bouncing_prompt_system);
 
-        app.add_systems(
-            OnEnter(states::AppStates::Instructions),
-            setup_instructions_system,
-        );
-
         app.add_systems(
             OnEnter(states::AppStates::CharacterSelection),
             setup_character_selection_system,