🎉 add help section in editor menu

Author: vanyle

Cargo.lock

@@ -5,10 +5,6 @@
 - [ ] Animation system from multiple PNG files
 - [ ] Rework the resource API to use futures to prevent use of unloaded resources
 - [ ] In loader add a way to load a text resource
-- [ ] Add a help button to the editor menu with the options:
-  - [ ] Open Manual
-  - [ ] Open Github
-  - [ ] About (opens a popup with the version and the commit hash)
 - [ ] Aseprite support
   - [ ] Load Aseprite files as images
   - [ ] Load Aseprite files as tilesets
@@ -72,6 +68,10 @@
 
 # Done
 
+- [x] Add a help button to the editor menu with the options:
+  - [x] Open Manual
+  - [x] Open Github
+  - [x] About (opens a popup with the version and the commit hash)
 - [x] Add search in the resource window
 - [x] Allow opening the game folder in the resource window
 - [x] Lua performance helper:

TODO.md

@@ -23,6 +23,7 @@ name = "vecta"
 path = "src/main.rs"
 
 [build-dependencies]
+chrono = "0.4.42"
 winresource = "0.1.23"
 
 # https://rust-lang.github.io/rust-clippy/master/index.html

editor/Cargo.toml

@@ -1,9 +1,71 @@
-use {std::env, winresource::WindowsResource};
+use {
+    std::{env, fs, io::Write, path::Path},
+    winresource::WindowsResource,
+};
+
+fn get_commit_hash(cargo_manifest_dir: &Path) -> String {
+    let output = std::process::Command::new("git")
+        .args(["rev-parse", "HEAD"])
+        .current_dir(cargo_manifest_dir)
+        .output()
+        .expect("Failed to get current commit hash");
+    String::from_utf8_lossy(&output.stdout).trim().to_string()
+}
+
+fn get_git_branch(cargo_manifest_dir: &Path) -> String {
+    let output = std::process::Command::new("git")
+        .args(["rev-parse", "--abbrev-ref", "HEAD"])
+        .current_dir(cargo_manifest_dir)
+        .output()
+        .expect("Failed to get current branch");
+    String::from_utf8_lossy(&output.stdout).trim().to_string()
+}
+
+fn get_git_tag(cargo_manifest_dir: &Path) -> String {
+    let output = std::process::Command::new("git")
+        .args(["tag", "--points-at", "HEAD"])
+        .current_dir(cargo_manifest_dir)
+        .output()
+        .expect("Failed to get current tag");
+    String::from_utf8_lossy(&output.stdout).trim().to_string()
+}
 
 fn main() {
     if env::var_os("CARGO_CFG_TARGET_OS") == Some("windows".into()) {
         let _ = WindowsResource::new()
             .set_icon("../assets/icon.ico")
             .compile();
     }
+
+    // Generate build infos
+    let dst = Path::new(&env::var("OUT_DIR").expect("OUT_DIR not set")).join("buildinfo.rs");
+    let binding = env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR");
+    let cargo_manifest_dir = Path::new(&binding);
+    let mut built_file = fs::File::create(&dst).expect("Failed to create buildinfo.rs");
+
+    let current_commit_hash = get_commit_hash(cargo_manifest_dir);
+    let current_branch = get_git_branch(cargo_manifest_dir);
+    let current_tag = get_git_tag(cargo_manifest_dir);
+
+    let build_timestamp = chrono::Utc::now().to_rfc2822();
+
+    // We are generating a file that will be imported by run main program.
+    let _ = built_file.write_all(
+        r"//
+// EVERYTHING BELOW THIS POINT WAS AUTO-GENERATED DURING COMPILATION. DO NOT MODIFY.
+//
+
+"
+        .as_ref(),
+    );
+    let _ = built_file
+        .write_all(format!("pub const COMMIT_HASH: &str = \"{current_commit_hash}\";\n").as_ref());
+    let _ = built_file
+        .write_all(format!("pub const BRANCH_NAME: &str = \"{current_branch}\";\n").as_ref());
+    let _ =
+        built_file.write_all(format!("pub const TAG_NAME: &str = \"{current_tag}\";\n").as_ref());
+
+    let _ = built_file
+        .write_all(format!("pub const BUILD_TIMESTAMP: &str = \"{build_timestamp}\";\n").as_ref());
+    println!("cargo::rerun-if-changed=build.rs");
 }

editor/build.rs

@@ -0,0 +1,14 @@
+pub mod built_info {
+    //  The file has been placed there by the build script.
+    include!(concat!(env!("OUT_DIR"), "/buildinfo.rs"));
+}
+
+pub fn get_version() -> &'static str {
+    #[allow(clippy::const_is_empty)]
+    // TAG_NAME is generated at compile-time and can be empty or not.
+    if built_info::TAG_NAME.is_empty() {
+        built_info::BRANCH_NAME
+    } else {
+        built_info::TAG_NAME
+    }
+}

editor/src/buildinfo.rs

@@ -1,4 +1,8 @@
-use egui::{Popup, RichText, UiBuilder};
+use std::{cell::Cell, path::PathBuf};
+
+use crate::buildinfo;
+use egui::{Modal, Popup, RichText, UiBuilder};
+use runtime::console;
 
 use crate::editorinterface::{EditorState, emptyscreen::open_file_dialog_and_load_project};
 
@@ -26,6 +30,30 @@ pub fn draw_editor_menu(editor: &mut EditorState, ctx: &egui::Context) {
         editor.reload_project();
     }
 
+    thread_local! {
+        static IS_ABOUT_OPEN: Cell<bool> = const { Cell::new(false) };
+    }
+
+    if IS_ABOUT_OPEN.with(|cell| cell.get()) {
+        let modal = Modal::new(egui::Id::new("about")).show(ctx, |ui| {
+            ui.heading("About Vectarine");
+            ui.label(format!("Version: {}", buildinfo::get_version()));
+            ui.add_space(8.0);
+            ui.label(format!(
+                "Commit Hash: {}",
+                buildinfo::built_info::COMMIT_HASH
+            ));
+            ui.label(format!("Branch: {}", buildinfo::built_info::BRANCH_NAME));
+            ui.label(format!(
+                "Built on {}",
+                buildinfo::built_info::BUILD_TIMESTAMP
+            ));
+        });
+        if modal.should_close() {
+            IS_ABOUT_OPEN.with(|cell| cell.set(false));
+        }
+    }
+
     egui::TopBottomPanel::top("toppanel").show(ctx, |ui| {
         ui.horizontal(|ui| {
             ui.label(RichText::new("Vectarine Editor").size(18.0));
@@ -100,9 +128,48 @@ pub fn draw_editor_menu(editor: &mut EditorState, ctx: &egui::Context) {
                         editor.save_config();
                     }
                 });
+
+                ui.menu_button("Help", |ui| {
+                    if ui.button("Offline Guide").clicked() {
+                        if let Some(manual_path) = get_manual_path() {
+                            let result = open::that(manual_path);
+                            if let Err(result) = result {
+                                console::print_err(result.to_string());
+                            }
+                        } else {
+                            console::print_err(
+                                "PDF Guide not found, maybe it was deleted?".to_string(),
+                            );
+                        }
+                    }
+                    if ui.button("Github").clicked() {
+                        let result = open::that("https://github.com/vanyle/vectarine");
+                        if let Err(result) = result {
+                            console::print_err(result.to_string());
+                        }
+                    }
+                    if ui.button("About").clicked() {
+                        IS_ABOUT_OPEN.with(|cell| cell.set(true));
+                    }
+                });
             });
         });
         // let window_handle = editor.window.borrow().raw();
         // sdl2_sys::SDL_SetWindowHitTest(window_handle, callback, callback_data)
     });
 }
+
+fn get_manual_path() -> Option<PathBuf> {
+    let executable_folder = std::env::current_exe().ok()?;
+    let executable_folder = executable_folder.parent()?;
+    let manual_path = executable_folder.join("vectarine-guide.pdf");
+    if manual_path.exists() {
+        return Some(manual_path);
+    }
+    let cwd = std::env::current_dir().ok()?;
+    let manual_path = cwd.join("docs/user-manual.pdf");
+    if manual_path.exists() {
+        return Some(manual_path);
+    }
+    None
+}

editor/src/editorinterface/editormenu.rs

@@ -16,6 +16,7 @@ use crate::{
     reload::reload_assets_if_needed,
 };
 
+pub mod buildinfo;
 pub mod editorinterface;
 pub mod egui_sdl2_platform;
 pub mod exportinterface;