Add support for user added mods

Author: theRookieCoder

.github/workflows/release.yml

@@ -107,7 +107,7 @@ jobs:
           files: ./out/*
           name: Ferium ${{ github.ref_name }}
           body: |
-            Compiled binaries for Ferium version `${{ github.ref_name }}` ([changelog](https://github.com/theRookieCoder/ferium/blob/main/CHANGELOG.md#$MD_HEADER))
+            Compiled binaries for Ferium version `${{ github.ref_name }}` ([changelog](https://github.com/theRookieCoder/ferium/blob/main/CHANGELOG.md#${{ $MD_HEADER }}))
 
             The provided binaries are for:
 

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog for Ferium
 
+## `v3.27.0`
+### 07.05.2022
+
+- Added a `.old` directory in the output directory to store 'deleted' mods
+- Update the output directory checking code so that the backup is only requested when there are files (because directories will not be deleted)
+- Added support for user installed mods
+  - These are read from `<output_dir>/user`
+- There are now download and install messages when upgrading
+
 ## `v3.26.0`
 ### 05.05.2022
 

Cargo.lock

@@ -1,8 +1,8 @@
 [package]
 name = "ferium"
-version = "3.26.0"
+version = "3.27.0"
 edition = "2021"
-authors = ["Ilesh Thiada (theRookieCoder) <[email protected]>", "Daniel Hauck (SolidTux)"]
+authors = ["Ilesh Thiada (theRookieCoder) <[email protected]>", "薛詠謙 (KyleUltimate)", "Daniel Hauck (SolidTux)"]
 description = "Ferium is a CLI program for managing Minecraft mods from Modrinth, CurseForge, and Github Releases"
 exclude = ["tests"] # Don't need tests for installing using crates.io
 repository = "https://github.com/theRookieCoder/ferium"

Cargo.toml

@@ -73,11 +73,12 @@ When you first start up, you will have to create a new profile by running  `feri
     - You can find these at the top left part of the repository's page as a big 'owner / name'
   - So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add-github CaffeineMC sodium-fabric` (again, case-insensitive)
   - Note: The GitHub repository has to release JAR files in their Releases for Ferium to download, or else it will refuse to be added
+- External mods
+  - If you want to add files that are not on Modrinth, CurseForge, or GitHub Release, place them in a `user` folder in the output directory. Files here will be copied to the output directory when upgrading
 
 ### Upgrading Mods
 
-> _Warning: Upgrading will empty the output directory before downloading your mods!_
-> If your output directory is not empty when setting it, Ferium will offer to create a backup
+> If your output directory is not empty when setting it, Ferium will offer to create a backup. Please do so if it contains any files you would like to keep
 
 Now after adding all your mods, run `ferium upgrade` to download all of them to your output directory.
 This defaults to `.minecraft/mods`, where `.minecraft` is the default Minecraft resources directory. You don't need to worry about this if you play with Mojang's launcher (unless you changed the resources directory).
@@ -86,14 +87,16 @@ You can choose to pick a custom output directory during profile creation or [cha
 If Ferium fails to find a compatible version of a mod, it will print it's name in red and give a reason.It will continue downloading the rest of the mods and will exit with an error.
 See the [advanced section](#advanced) for more information.
 
+**WARNING:** _When upgrading, any files not downloaded by Ferium will be moved to the `.old` folder in the output directory_
+
 ### Managing Mods
 
 You can see all the mods in your current profile by running `ferium list`. If you want to see more information about them, you can run `ferium list -v` or `ferium list --verbose`.
 
 You can remove any of your mod by runnning `ferium remove`, selecting the ones you would like to remove by using the space key, and pressing enter once you're done.
 You can also provide the names of the mods to remove as arguments. Mod names with spaces have to be given in quotes (`ferium remove "ok zoomer"`) or the spaces should be escaped (`ferium remove ok\ zoomer`).
 
-#### Advanced
+#### Check Overrides
 
 If some mod is compatible with your profile but Ferium does not download it, [create an issue]((https://github.com/theRookieCoder/ferium/issues/new)) if you think it's a bug. Or else, you can disable the game version or mod loader checks by setting `check_game_version` or `check_mod_loader` to false for the specific mod.
 
@@ -121,7 +124,7 @@ You can create a profile by running `ferium profile create` and configuring the
 - Mod loader
 
 You can also provide these settings as flags to the create command.
-If you want to copy the mods from another profile, provide the `--import` flag. You can also provide the profile name to the `--import` flag, if you don't a profile picker will be shown.
+If you want to copy the mods from another profile, provide the `--import` flag. You can also provide the profile name to the `--import` flag if you don't a profile picker will be shown.
 Finally, Ferium will automatically switch to the newly created profile.
 
 #### Configure
@@ -148,7 +151,7 @@ Firstly, you need the Rust toolchain which includes `cargo`, `rustup`, etc. You
 You'll also need the [Just](https://github.com/casey/just#installation) command runner, its basically a much better version of `make`.
 
 If you want to build Ferium without cloning the repo, set the `CURSEFORGE_API_KEY` environment variable, then run `cargo install ferium`.
-If you don't have a CurseForge API key you can set the variable to an empty value, however anything using the CurseForge API will not work.
+If you don't have a CurseForge API key, you can set the variable to an empty value. However anything using the CurseForge API will not work.
 
 To build the project and install it to your Cargo binary directory, clone the project and run `just install`. If you want to install it for testing a developement version, run `just` (alias for `just install-dev`).
 

README.md

@@ -199,7 +199,7 @@ async fn actual_main() -> Result<()> {
         SubCommands::Upgrade => {
             check_internet().await?;
             check_empty_profile(profile)?;
-            create_dir_all(&profile.output_dir).await?;
+            create_dir_all(&profile.output_dir.join(".old")).await?;
             upgrade(&modrinth, &curseforge, &github, profile).await?;
         },
     };

src/main.rs

@@ -5,19 +5,18 @@ mod list;
 pub use configure::configure;
 pub use create::create;
 pub use delete::delete;
-use fs_extra::dir::{copy, CopyOptions};
 pub use list::list;
 
 use crate::THEME;
 use anyhow::{bail, Result};
 use colored::Colorize;
 use dialoguer::{Confirm, Select};
+use fs_extra::dir::{copy, CopyOptions};
 use libium::{
     config::{self, structs::ModLoader},
     file_picker, misc, HOME,
 };
 use std::path::PathBuf;
-use tokio::fs::read_dir;
 
 fn pick_mod_loader(default: Option<&ModLoader>) -> Result<ModLoader> {
     let mut picker = Select::with_theme(&*THEME);
@@ -66,13 +65,29 @@ async fn check_output_directory(output_dir: &PathBuf) -> Result<()> {
     if output_dir.file_name().unwrap() != "mods" {
         println!("{}", "Warning! The output directory is not called `mods`. Most mod loaders will load a directory called `mods`.".bright_yellow());
     }
-    if output_dir.exists()
-        && read_dir(output_dir).await?.next_entry().await?.is_some()
-        && Confirm::with_theme(&*THEME)
-            .with_prompt("Your output directory is not empty and it will be erased when upgrading. Would like to create a backup of it?")
-            .interact()? {
-        let backup_dir = file_picker::pick_folder(&*HOME, "Where should the backup be made?").await.unwrap();
-        copy(output_dir, backup_dir, &CopyOptions::new())?;
+    let mut backup = false;
+    if output_dir.exists() {
+        for file in std::fs::read_dir(output_dir)? {
+            let file = file?;
+            if file.path().is_file() && file.file_name() != ".DS_Store" {
+                backup = true;
+                break;
+            }
+        }
+    }
+    if backup {
+        println!(
+            "There are files in your output directory, these will be deleted when you upgrade."
+        );
+        if Confirm::with_theme(&*THEME)
+            .with_prompt("Would like to create a backup?")
+            .interact()?
+        {
+            let backup_dir = file_picker::pick_folder(&*HOME, "Where should the backup be made?")
+                .await
+                .unwrap();
+            copy(output_dir, backup_dir, &CopyOptions::new())?;
+        }
     }
     Ok(())
 }

src/subcommands/profile/mod.rs

@@ -2,12 +2,14 @@ use crate::{CROSS, TICK, YELLOW_TICK};
 use anyhow::{bail, Result};
 use colored::Colorize;
 use ferinth::Ferinth;
+use fs_extra::file::{move_file, CopyOptions};
 use furse::Furse;
 use itertools::Itertools;
 use libium::config;
 use libium::upgrade;
 use octocrab::Octocrab;
-use tokio::fs::remove_file;
+use std::fs::read_dir;
+use tokio::fs::copy;
 
 struct Downloadable {
     filename: String,
@@ -183,41 +185,59 @@ pub async fn upgrade(
         );
     }
 
-    eprint!("\n{}", "Downloading Mod Files... ".bold());
-    for file in std::fs::read_dir(&profile.output_dir)? {
+    let mut to_install = Vec::new();
+    if profile.output_dir.join("user").exists() {
+        for file in read_dir(&profile.output_dir.join("user"))? {
+            let file = file?;
+            let path = file.path();
+            if path.is_file() {
+                to_install.push((file.file_name(), path));
+            }
+        }
+    }
+
+    println!("\n{}\n", "Downloading Mod Files".bold());
+
+    for file in read_dir(&profile.output_dir)? {
         let file = file?;
-        let path = file.path();
-        if path.is_file() {
-            let mut index = None;
-            // If a file is already downloaded
-            if let Some(downloadable) = to_download
+        if file.file_type()?.is_file() {
+            let filename = file.file_name();
+            let filename = filename.to_str().unwrap();
+            if let Some((index, _)) = to_download
                 .iter()
-                .find_position(|thing| file.file_name().to_str().unwrap() == thing.filename)
+                .find_position(|thing| filename == thing.filename)
             {
-                index = Some(downloadable.0);
-            }
-            match index {
-                // Then don't download the file
-                Some(index) => {
-                    to_download.swap_remove(index);
-                },
-                // Or else delete the file
-                None => remove_file(path).await?,
+                to_download.swap_remove(index);
+            } else if let Some((index, _)) =
+                to_install.iter().find_position(|thing| filename == thing.0)
+            {
+                to_install.swap_remove(index);
+            } else {
+                let _ = move_file(
+                    file.path(),
+                    profile.output_dir.join(".old").join(filename),
+                    &CopyOptions::new(),
+                );
             }
         }
     }
-    match {
-        for downloadable in to_download {
-            let contents = reqwest::get(downloadable.download_url)
-                .await?
-                .bytes()
-                .await?;
-            upgrade::write_mod_file(profile, contents, &downloadable.filename).await?;
-        }
-        Ok::<(), anyhow::Error>(())
-    } {
-        Ok(_) => println!("{}", *TICK),
-        Err(_) => bail!("{}", CROSS),
+
+    for downloadable in to_download {
+        eprint!("Downloading {}... ", downloadable.filename.dimmed());
+        let contents = reqwest::get(downloadable.download_url)
+            .await?
+            .bytes()
+            .await?;
+        upgrade::write_mod_file(profile, contents, &downloadable.filename).await?;
+        println!("{}", &*TICK);
+    }
+    for installable in to_install {
+        eprint!(
+            "Installing  {}... ",
+            installable.0.to_string_lossy().dimmed()
+        );
+        copy(installable.1, profile.output_dir.join(installable.0)).await?;
+        println!("{}", &*TICK);
     }
 
     if error {