Skip to content

Commit

Permalink
Add Controls under Help Menu
Browse files Browse the repository at this point in the history
  • Loading branch information
@Froggy618157725
Froggy618157725 committed Feb 27, 2024
1 parent fbd4a07 commit 5e7d685
Show file tree
Hide file tree
Showing 2 changed files with 190 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
- Added the ability to load maps from packages by name (eg. `throneworld` or `dungeon_prophecy`) through the `-p` argument by @cohaereo
- Added draw_crosshair to the config by @Froggy618157725 in [#21](https://github.com/cohaereo/alkahest/pull/21)
- Added 'I' Key shortcut to swap to previous map by @Froggy618157725 in [#21](https://github.com/cohaereo/alkahest/pull/21)
- Added Controls under Help Menu @Froggy618157725 in [#22](https://github.com/cohaereo/alkahest/pull/22)

### Changed

Expand Down
190 changes: 189 additions & 1 deletion src/overlays/menu.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@ use crate::{
tags::{EntityTag, Tags},
transform::{Transform, TransformFlags},
},
icons::{ICON_RULER_SQUARE, ICON_SIGN_POLE, ICON_SPHERE},
icons::{
ICON_ALPHA_A_BOX_OUTLINE, ICON_ALPHA_D_BOX_OUTLINE, ICON_ALPHA_E_BOX_OUTLINE,
ICON_ALPHA_F_BOX_OUTLINE, ICON_ALPHA_G_BOX_OUTLINE, ICON_ALPHA_H_BOX_OUTLINE,
ICON_ALPHA_I_BOX_OUTLINE, ICON_ALPHA_Q_BOX_OUTLINE, ICON_ALPHA_S_BOX_OUTLINE,
ICON_ALPHA_W_BOX_OUTLINE, ICON_APPLE_KEYBOARD_SHIFT, ICON_ARROW_ALL,
ICON_ARROW_DOWN_BOLD_BOX_OUTLINE, ICON_ARROW_UP_BOLD_BOX_OUTLINE, ICON_KEYBOARD_SPACE,
ICON_MOUSE_LEFT_CLICK_OUTLINE, ICON_MOUSE_RIGHT_CLICK_OUTLINE, ICON_RULER_SQUARE,
ICON_SIGN_POLE, ICON_SPHERE,
},
map::MapDataList,
updater::UpdateChannel,
util::consts::{self, CHANGELOG_MD},
Expand All @@ -21,11 +29,32 @@ use crate::{

#[derive(Default)]
pub struct MenuBar {
controls_open: bool,
changelog_open: bool,
about_open: bool,
markdown_cache: CommonMarkCache,
}

macro_rules! control_section_title {
($ui:expr, $title:expr) => {{
$ui.separator();
$ui.label(RichText::new($title).size(20.0).strong());

$ui.end_row();
}};
}

macro_rules! control_description {
($ui:expr, $control:expr, $description:expr) => {{
$ui.with_layout(egui::Layout::right_to_left(egui::Align::TOP), |ui| {
ui.label(RichText::new($control).size(24.0).strong());
});

$ui.label($description);
$ui.end_row();
}};
}

impl Overlay for MenuBar {
fn draw(
&mut self,
Expand Down Expand Up @@ -144,6 +173,11 @@ impl Overlay for MenuBar {
});

ui.menu_button("Help", |ui| {
if ui.button("Controls").clicked() {
self.controls_open = true;
ui.close_menu()
}
ui.separator();
let update_channel = config::with(|c| c.update_channel);
if ui
.add_enabled(
Expand Down Expand Up @@ -191,6 +225,7 @@ impl Overlay for MenuBar {

self.change_log(ctx);
self.about(ctx);
self.controls(ctx);

true
}
Expand Down Expand Up @@ -243,4 +278,157 @@ impl MenuBar {
})
});
}

pub fn controls(&mut self, ctx: &egui::Context) {
egui::Window::new("Controls")
.open(&mut self.controls_open)
.auto_sized()
.show(ctx, |ui| {
egui::ScrollArea::vertical().show(ui, |ui| {
egui::Grid::new("controls")
.min_row_height(30.0)
.min_col_width(200.0)
.show(ui, |ui| {
control_section_title!(ui, "Movement");

control_description!(
ui,
format!("{}+{}", ICON_MOUSE_LEFT_CLICK_OUTLINE, ICON_ARROW_ALL),
"Adjust Camera Direction"
);

control_description!(
ui,
format!(
"{}/{}/{}/{}",
ICON_ALPHA_W_BOX_OUTLINE,
ICON_ALPHA_S_BOX_OUTLINE,
ICON_ALPHA_A_BOX_OUTLINE,
ICON_ALPHA_D_BOX_OUTLINE
),
"Move Camera Forwards/Backwards/Left/Right"
);

control_description!(
ui,
format!(
"{}/{}",
ICON_ALPHA_Q_BOX_OUTLINE, ICON_ALPHA_E_BOX_OUTLINE,
),
"Move Camera Down/Up"
);

control_description!(
ui,
format!(
"Alt + {}/{}/{}/{}",
ICON_ALPHA_W_BOX_OUTLINE,
ICON_ALPHA_S_BOX_OUTLINE,
ICON_ALPHA_A_BOX_OUTLINE,
ICON_ALPHA_D_BOX_OUTLINE
),
"Move Camera in Horizontal Plain"
);

control_description!(
ui,
format!(
"Alt + {}/{}",
ICON_ALPHA_Q_BOX_OUTLINE, ICON_ALPHA_E_BOX_OUTLINE,
),
"Move Camera Down/Up in Absolute Coordinates"
);

control_description!(ui, "Ctrl", "Decrease Movement speed");

control_description!(
ui,
format!("{} Shift", ICON_APPLE_KEYBOARD_SHIFT),
"Increase Movement speed"
);

control_description!(
ui,
ICON_KEYBOARD_SPACE,
"Increase Movement speed a lot"
);

control_description!(
ui,
format!(
"{} Shift + {}",
ICON_APPLE_KEYBOARD_SHIFT, ICON_KEYBOARD_SPACE
),
"We're gonna have to go right to... LUDICROUS SPEED"
);

control_description!(
ui,
ICON_ALPHA_G_BOX_OUTLINE,
"Move Camera to Position of Gaze"
);

control_section_title!(ui, "Object Interactions");

control_description!(
ui,
ICON_MOUSE_RIGHT_CLICK_OUTLINE,
"Select Object"
);

control_description!(
ui,
ICON_ALPHA_F_BOX_OUTLINE,
"Focus on Selected Object"
);

control_description!(
ui,
ICON_ALPHA_H_BOX_OUTLINE,
"Toggle Hide Selected Object"
);

control_description!(
ui,
format!("Alt + {}", ICON_ALPHA_H_BOX_OUTLINE),
"Unhide All Objects"
);

control_description!(
ui,
format!(
"{} Shift + {}",
ICON_APPLE_KEYBOARD_SHIFT, ICON_ALPHA_H_BOX_OUTLINE
),
"Hide All Unselected Objects"
);

control_description!(
ui,
format!("{} Shift + Delete", ICON_APPLE_KEYBOARD_SHIFT),
"Delete Selected Object (if allowed)"
);

control_description!(
ui,
ICON_ARROW_DOWN_BOLD_BOX_OUTLINE,
"Select 'Next' Object"
);

control_description!(
ui,
ICON_ARROW_UP_BOLD_BOX_OUTLINE,
"Select 'Previous' Object"
);
control_section_title!(ui, "Miscellaneous");

control_description!(
ui,
ICON_ALPHA_I_BOX_OUTLINE,
"Swap to Previous Map"
);
});
});
});
}
}

0 comments on commit 5e7d685

Please sign in to comment.