Rework and modernization of Maxima

.cargo/config.toml

@@ -0,0 +1,2 @@
+[resolver]
+incompatible-rust-versions = "fallback"

.github/workflows/build-ci.yml

@@ -1,9 +1,9 @@
 name: Maxima Build
 
-on: [push]
+on: [push, pull_request]
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request && github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 jobs:
@@ -15,9 +15,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        rust-version: [nightly]
+        rust-version: ["1.96", "stable", "nightly"]
+        experimental: [false, false, true]
         os: [ubuntu-latest, windows-latest]
-        experimental: [false]
 
     env:
       CARGO_TERM_COLOR: always
@@ -26,18 +26,10 @@ jobs:
     - name: Checkout the repo
       uses: actions/checkout@v4
 
-    - name: Cache Rust ${{ matrix.rust-version }}
-      uses: actions/cache@v3
-      with:
-        path: ${{ github.workspace }}\rust\.rustup
-        key: rust-${{ matrix.rust-version }}-${{ hashFiles('**/rust-toolchain') }}
-
     - name: Setup Rust ${{ matrix.rust-version }}
-      uses: actions-rs/toolchain@v1
+      uses: dtolnay/rust-toolchain@master
       with:
-        profile: minimal
         toolchain: ${{ matrix.rust-version }}
-        override: true
         components: rustfmt, clippy
 
     - name: Install Protoc
@@ -56,6 +48,15 @@ jobs:
         cache-on-failure: true
         save-if: ${{ github.ref == 'refs/heads/master' }}
 
+    - name: Clippy
+      run: cargo clippy --workspace -- -D warnings
+
+    - name: Format check
+      run: cargo fmt --all -- --check
+
+    - name: Tests
+      run: cargo test --workspace
+
     - name: Build Maxima
       if: runner.os == 'Windows'
       run: |

.gitignore

@@ -1,5 +1,4 @@
 /target
 /.vscode
 /.idea
-
-Cargo.lock
+Cargo.lock

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-resolver = "2"
+resolver = "3"
 members = [
     "maxima-bootstrap",
     "maxima-cli",
@@ -10,9 +10,58 @@ members = [
     "maxima-resources",
 ]
 
+[workspace.dependencies]
+# Common Workspace Dependencies for all Maxima libs
+tokio = { version = "1.53.1", features = ["rt-multi-thread", "time", "net", "sync", "macros", "fs", "process"] }
+serde = { version = "1.0.229", features = ["derive"] }
+serde_json = "1.0.151"
+rustls = { version = "0.23.43", features = ["aws-lc-rs"] }
+reqwest = { version = "0.13.4", features = ["stream", "rustls"], default-features = false }
+base64 = "0.23.1"
+thiserror = "2.0.20"
+anyhow = "1.0.104"
+log = "0.4.34"
+regex = "1.13.1"
+futures = "0.3.34"
+clap = { version = "4.6.6", features = ["derive"] }
+inquire = "0.9.4"
+strum = { version = "0.28.0", features = ["derive"] }
+strum_macros = "0.28.0"
+url = "2.5.8"
+directories = "6.0.0"
+hex = "0.4.3"
+
+# Common Target Specific Dependencies
+windows-sys = { version = "0.61.2", features = ["Win32_System", "Win32_System_Threading", "Win32_System_Console", "Win32_System_Console"] }
+winreg = "0.56.0"
+windows-service = "0.8.1"
+is_elevated = "0.1.2"
+
+[patch.crates-io]
+async-compression = { git = "https://github.com/sjp761/async-compression.git", rev = "a226c72f754f942ad187cc65cb1f03df5ae26b7b", version = "0.4.42" }
+flate2 = { git = "https://github.com/sjp761/flate2-rs.git", rev = "45fc9f6a56a97513b285029fee14213a2d0fe2e5", version = "1.1.10" }
+
+[workspace.package]
+version = "0.1.0"
+edition = "2024"
+authors = ["Nick Whelan <cooldood909@gmail.com>", "Sean Kahler <sean@battleda.sh>", "Maxima Contributors"]
+rust-version = "1.96.1"
+
 [profile.release]
 strip = true
+lto = "thin"
+codegen-units = 1
+panic = "abort"
 
-[patch.crates-io]
-flate2 = { git = 'https://github.com/ArmchairDevelopers/flate2-rs.git' }
-async-compression = { git = 'https://github.com/ArmchairDevelopers/async-compression.git' }
+[profile.release-debug]
+inherits = "release"
+strip = false
+debug = 1
+
+[profile.dev]
+opt-level = 0
+debug = true
+split-debuginfo = "unpacked"
+
+[profile.dev.package."*"]
+opt-level = 1

README.md

@@ -11,6 +11,10 @@ Maxima itself is a library (`maxima-lib`), with provided CLI (`maxima-cli`), TUI
 
 ![UI](images/UI.png)
 
+**Current developing stack:**
+
+Rust 1.90.1 | UI : egui / glow | Requests : reqwest | Async support & work : tokio | Windows layer : windows-sys | Linux layer : homemade | macOS layer : homemade and many under the hood plugins that make this program possible.
+
 **Features:**
  - EA Authentication
  - Downloading/Updating games
@@ -24,20 +28,21 @@ Maxima itself is a library (`maxima-lib`), with provided CLI (`maxima-cli`), TUI
  - Locating games (aka. game importing)
  - Running games under [proton](https://github.com/GloriousEggroll/proton-ge-custom) on Linux/SteamDeck
    - `proton-ge` is automatically installed together with [umu](https://github.com/Open-Wine-Components/umu-launcher).
-
-**In-Dev:**
- - macOS support
- - Support for launching Maxima through Epic/Steam
+
+**Developer Roadmap:**
+ - macOS support (sjp761)
+ - Chat system
+ - Friend Adding/Removing/Inviting
+ - Support for launching Maxima through Epic/Steam (Link2EA protocol)
+ - Cleaner/Stabler downloader implementation
 
 **Planned:**
  - Library documentation/examples
  - Support for installing DLCs
  - Full EA Desktop interoperability. Games installed with EA Desktop already appear on Maxima, but to take it a step further we'd like the ability to, for example, start a download on EA Desktop and continue it on Maxima.
- - Cleaner/Stabler downloader implementation
  - Progressive/Selective installs
    - Some games are able to start without being fully installed, and some games contain language-specific files.
  - Support for the store (buying games)
- - Friend Adding/Removing/Inviting
  - Status setting; locked to "online" at the moment
  - Refactoring Maxima to new architecture allowing multiple frontends to co-exist
 

maxima-bootstrap/Cargo.toml

@@ -1,38 +1,19 @@
 [package]
 name = "maxima-bootstrap"
 description = "Maxima handler for custom EA protocols"
-version = "0.1.0"
-authors = ["Sean Kahler <sean@battleda.sh>"]
-edition = "2021"
+version = { workspace = true }
+authors = { workspace = true }
+edition = { workspace = true }
 
 [dependencies]
 maxima-lib = { path = "../maxima-lib" }
-tokio = { version = "1.28.2", features = [
-    "full",
-    "rt",
-    "rt-multi-thread",
-    "time",
-    "net",
-] }
-serde = { version = "1.0.164", features = ["derive"] }
-serde_json = "1.0.97"
-reqwest = { version = "0.11.18", features = ["stream", "rustls-tls"], default-features = false }
-base64 = "0.21.2"
-url = "2.4.0"
-querystring = "1.1.0"
+tokio = { workspace = true }
+serde_json = { workspace = true }
+reqwest = { workspace = true, features = ["query"] }
+base64 = { workspace = true }
+url = { workspace = true }
 urlencoding = "2.1.3"
-thiserror = "2.0.12"
-
-[target.'cfg(windows)'.dependencies]
-winapi = { version = "0.3.9", features = [
-    "memoryapi",
-    "handleapi",
-    "synchapi",
-    "wincon",
-    "consoleapi",
-] }
-winreg = "0.50.0"
-windows-service = "0.6.0"
+thiserror = { workspace = true }
 
 [target.'cfg(target_os = "macos")'.dependencies]
 cacao = "0.3.2"

maxima-bootstrap/src/main.rs

@@ -8,13 +8,13 @@ use std::string::FromUtf8Error;
 use thiserror::Error;
 use tokio::process::Command;
 
-use base64::{engine::general_purpose, Engine};
+use base64::{Engine, engine::general_purpose};
 use maxima::core::launch::BootstrapLaunchArgs;
+use maxima::util::BackgroundServiceControlError;
 use maxima::util::native::NativeError;
 #[cfg(windows)]
 use maxima::util::service::{is_service_valid, register_service};
-use maxima::util::BackgroundServiceControlError;
-use url::Url;
+use url::{Url, form_urlencoded};
 
 #[cfg(target_os = "macos")]
 mod macos;
@@ -70,19 +70,18 @@ async fn handle_launch_args() -> Result<bool, RunError> {
 
     let result = run(&args).await;
     if cfg!(debug_assertions) || std::env::var("MAXIMA_DEBUG").is_ok() {
-        println!("Args: {:?}", &args);
+        println!("Args: {:?}", args);
 
         let str_result = result
             .as_ref()
             .map_err(|e| {
                 let source = e.source();
-                let error_str = if source.is_some() {
+
+                if source.is_some() {
                     source.unwrap().to_string()
                 } else {
                     e.to_string()
-                };
-
-                error_str
+                }
             })
             .err()
             .unwrap_or("Success".to_string());
@@ -116,22 +115,24 @@ async fn platform_launch(args: BootstrapLaunchArgs) -> Result<(), NativeError> {
     let mut binding = Command::new(args.path);
     let child = binding.args(args.args);
 
-    let status = child.spawn()?.wait().await?;
+    let _status = child.spawn()?.wait().await?;
     // bail!("{}", status.code().unwrap());
     Ok(())
 }
 
 #[cfg(unix)]
 async fn platform_launch(args: BootstrapLaunchArgs) -> Result<(), NativeError> {
-    use maxima::unix::wine::run_wine_command;
     use maxima::unix::wine::CommandType;
+    use maxima::unix::wine::run_wine_command;
+    use maxima::unix::wine::wine_prefix_dir;
 
     run_wine_command(
-        args.path,
+        args.path.into(),
         Some(args.args),
         None,
         false,
         CommandType::WaitForExitAndRun,
+        &wine_prefix_dir(&args.slug).unwrap(),
     )
     .await?;
 
@@ -153,20 +154,30 @@ async fn run(args: &[String]) -> Result<bool, RunError> {
 
         if arg.starts_with("origin2") {
             let url = Url::parse(arg)?;
-            let query = querystring::querify(url.query().unwrap());
-            let _offer_id = query.iter().find(|(x, _)| *x == "offerIds").unwrap().1;
-            let cmd_params = query.iter().find(|(x, _)| *x == "cmdParams").unwrap().1;
+            let mut offer_id = None;
+            let mut cmd_params = None;
+
+            for (key, value) in form_urlencoded::parse(url.query().unwrap_or_default().as_bytes()) {
+                match key.as_ref() {
+                    "offerIds" => offer_id = Some(value),
+                    "cmdParams" => cmd_params = Some(value),
+                    _ => {}
+                }
+            }
+
+            let _offer_id = offer_id.unwrap();
+            let cmd_params = cmd_params.unwrap();
 
             let mut child = Command::new(current_exe()?.with_file_name("maxima-cli.exe"));
             child.env(
                 "MAXIMA_LAUNCH_ARGS",
-                urlencoding::decode(cmd_params)?
+                urlencoding::decode(cmd_params.as_ref())?
                     .into_owned()
                     .replace("\\\"", "\""),
             );
             println!(
                 "{}",
-                urlencoding::decode(cmd_params)?
+                urlencoding::decode(cmd_params.as_ref())?
                     .into_owned()
                     .replace("\\\"", "\"")
             );
@@ -178,7 +189,15 @@ async fn run(args: &[String]) -> Result<bool, RunError> {
         }
 
         if arg.starts_with("qrc") {
-            let query = arg.split("login_successful.html?").collect::<Vec<&str>>()[1];
+            let raw_query = arg
+                .split("login_successful.html?")
+                .nth(1)
+                .unwrap_or_default();
+            let mut serializer = form_urlencoded::Serializer::new(String::new());
+            for (key, value) in form_urlencoded::parse(raw_query.as_bytes()) {
+                serializer.append_pair(key.as_ref(), value.as_ref());
+            }
+            let query = serializer.finish();
             reqwest::get(format!("http://127.0.0.1:31033/auth?{}", query)).await?;
 
             return Ok(true);

maxima-cli/Cargo.toml

@@ -1,27 +1,21 @@
 [package]
 name = "maxima-cli"
-version = "0.1.0"
-authors = ["Sean Kahler <sean@battleda.sh>"]
-edition = "2021"
+version = { workspace = true }
+authors = { workspace = true }
+edition = { workspace = true }
 
 [dependencies]
 maxima-lib = { path = "../maxima-lib" }
-clap = { version = "4.3.5", features = [ "derive" ] }
-tokio = { version = "1.28.2", features = [ "full", "rt", "rt-multi-thread", "time", "net" ] }
-serde = { version = "1.0.164", features = [ "derive" ] }
-serde_json = "1.0.97"
-anyhow = "1.0.71"
-lazy_static = "1.4.0"
-base64 = "0.21.2"
-log = "0.4.19"
-regex = "1.8.4"
-inquire = "0.6.2"
-futures = "0.3.30"
+clap = { workspace = true }
+tokio = { workspace = true }
+anyhow = { workspace = true }
+log = { workspace = true }
+regex = { workspace = true }
+inquire = { workspace = true }
+rustls = { workspace = true }
 
 [target.'cfg(windows)'.dependencies]
-winapi = { version = "0.3.9", features = [ "memoryapi", "handleapi", "synchapi", "wincon", "consoleapi" ] }
-winreg = "0.50.0"
-is_elevated = "0.1.2"
+is_elevated = { workspace = true }
 
 [build-dependencies]
 maxima-resources = { path = "../maxima-resources" }