fix: prompts for install script

* progress

* progress

* feat: progress

* progress

* done, needs more testing, pr -> change all functions to require -n before specifying name -> v0.4 (reindex db)

* testing done

.editorconfig

@@ -0,0 +1,6 @@
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.gitignore

@@ -3,3 +3,4 @@
 !install.sh
 !README.md
 !version
+!.editorconfig

README.md

@@ -34,24 +34,27 @@ h2mm
 ### Available commands
 
 - `install` - Install a mod by the file provided (directory, zip, patch).
-- `uninstall` - Uninstall a mod by name (or index).
+- `uninstall` - Uninstall a mod.
 - `list` - List all installed mods.
-- `enable` - Enable a mod by name (or index).
+- `enable` - Enable a mod.
-- `disable` - Disable a mod by name (or index).
+- `disable` - Disable a mod.
 - `export` - Export installed mods to a zip file.
 - `import` - Import mods from a zip file.
+- `order` - Change load order for a mod.
 - `modpack-create` - Create a modpack from the currently installed mods.
-- `modpack-switch` - Switch to a modpack by name (or index).
+- `modpack-switch` - Switch to a modpack.
 - `modpack-list` - List all installed modpacks.
-- `modpack-delete` - Delete a modpack by name (or index).
+- `modpack-delete` - Delete a modpack.
-- `modpack-overwrite` - Overwrite a modpack by name (or index).
+- `modpack-overwrite` - Overwrite a modpack.
 - `modpack-reset` - Reset all installed modpacks.
-- `reset` - Reset all installed mods.
 - `update` - Update h2mm to latest version.
+- `reset` - Reset all installed mods.
 - `help` - Display this help message.
 
 ### Basic usage
 
+To find out how to use a command, you can run `h2mm <COMMAND> --help`.
+
 #### Install mod(s)
 
 ```bash
@@ -62,23 +65,20 @@ h2mm install -n "Example mod" mod.patch_0 mod.patch_0.stream # -n is mandatory w
 h2mm install -n "Example mod" mod* # using a wildcard to include all files
 ```
 
-> [!NOTE]  
-> If the mod has more than 1 variant, you need to install the one you want by unarchiving it separately and providing the directory.
-
 #### Uninstall a mod
 
 ```bash
-h2mm uninstall "Example mod"
+h2mm uninstall -n "Example mod"
-h2mm uninstall -i 1 # uninstall mod with index 1
+h2mm uninstall -i 3
 ```
 
 #### Enable/disable mods
 
 ```bash
-h2mm enable "Example mod"
+h2mm enable -n "Example mod"
-h2mm enable -i 1 # enable mod with index 1
+h2mm enable -i 3
-h2mm disable "Example mod"
+h2mm disable -n "Example mod"
-h2mm disable -i 1 # disable mod with index 1
+h2mm disable -i 3
 ```
 
 #### List installed mods
@@ -118,24 +118,25 @@ You can use the short form of commands to save some time. The shortcuts are:
 - `l` for `list`
 - `ex` for `export`
 - `im` for `import`
+- `o` for `order`
 - `mc` for `modpack-create`
 - `ms` for `modpack-switch`
 - `ml` for `modpack-list`
 - `md` for `modpack-delete`
 - `mo` for `modpack-overwrite`
 - `mr` for `modpack-reset`
-- `r` for `reset`
 - `up` for `update`
+- `r` for `reset`
 
 ### Modpacks support
 
 You can set up modpacks by using the `modpack-*` commands. This allows you to quickly change between a set of mods. For more information, check the help message.
 
 ```bash
-h2mm modpack-create "Modpack 1"
+h2mm modpack-create -n "Modpack 1"
 # install, enable, disable other mods...
-h2mm modpack-create "Modpack 2"
+h2mm modpack-create -n "Modpack 2"
-h2mm modpack-switch "Modpack 1"
+h2mm modpack-switch -n "Modpack 1"
 ```
 
 ### Exporting and importing
@@ -143,8 +144,8 @@ h2mm modpack-switch "Modpack 1"
 You can export all installed mods to a zip file and import mods from the same file. This can be useful for sharing mods with others or for backing up your mods. The archive file (`.tar.gz`) will be saved in the current directory.
 
 ```bash
-h2mm export modpack1.zip
+h2mm export
-h2mm import modpack2.zip
+h2mm import /path/to/mods.tar.gz
 ```
 
 ### Resetting all installed mods

install.sh

@@ -10,102 +10,69 @@ DESTINATION_PATH="/usr/local/bin"
 SCRIPT_NAME="h2mm"
 REPO_URL="https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master"
 
-if [ "$(id -u)" -eq 0 ]; then
+function log() {
-    echo "Run me as normal user, not as root."
+	local type="$1"
-    exit 1
+	shift
-fi
+	case "$type" in
+		INFO)
+			echo -e "$*" >&2
+			;;
+		ERROR)
+			echo -e "${RED}[ERROR]${NC} $*" >&2
+			;;
+		PROMPT)
+			echo -ne "$*" >&2
+			;;
+	esac
+}
 
 # --- Main ---
 
-# Warning
+# warning
 
-echo -e "!!! ${RED}WARNING${NC} !!!"
+cat << EOF
-echo -e "This script will install Helldivers 2 Mod Manager CLI for Linux to $DESTINATION_PATH/$SCRIPT_NAME."
+!!! WARNING !!!
-echo -e "Running this script will require sudo permissions. ${RED}DO NOT TRUST${NC} random scripts from the internet."
+This script will install Helldivers 2 Mod Manager CLI for Linux to $DESTINATION_PATH/$SCRIPT_NAME.
-echo -e "If you want to review the script before running it, check out the mod repository for yourself:"
+Running this script will require sudo permissions. DO NOT TRUST random scripts from the internet.
-echo -e "https://github.com/v4n00/h2mm-cli"
+If you want to review the script before running it, check out the mod repository for yourself:
-echo -e "!!! ${RED}WARNING${NC} !!!"
+https://github.com/v4n00/h2mm-cli
-echo
+!!! WARNING !!!
 
-# Check if update
+EOF
-
-# Breaking changes hash table
 
+# breaking changes hash table
 breaking_changes_patches=(
     ["2"]='sed -i "s/^\([0-9]\+\),/\1,ENABLED,/" "$1/mods.csv"'
     ["3"]='sed -i "1 i\\3" "$1/mods.csv"'
+	["4"]='awk '\''BEGIN {FS=OFS=","} NR==1 {print 4; next} {print NR-1, $2, $3, $4, $5}'\'' "$1/mods.csv" | tee "$1/mods.csv" > /dev/null'
 )
 
-# Handle breaking changes
+# notify if update is happening
-
+installed_version=""
+latest_version=""
 if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then
     installed_version=$($SCRIPT_NAME --version)
-    # version 1 show the help message, if the first character is not a 0, store installed version as 0.1.6
+
-    [[ ${installed_version:0:1} != "0" ]] && { installed_version="0.1.6"; }
+	# if installed version isn't x.x.x crash
+	if [[ ! "$installed_version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+		log ERROR "Installed version is not in the correct format."
+		log ERROR "h2mm is installed here -> $(which h2mm)"
+		log ERROR "Delete the script file and retry the install script, any mods installed will not be lost."
+		exit 1
+	fi
 
     latest_version=$(curl -sS "$REPO_URL"/version)
     if [[ "$latest_version" == "$installed_version" ]]; then
-        echo -e "You are reinstalling version $installed_version."
+        log INFO "You are reinstalling version ${GREEN}$installed_version${NC}."
     else
-        echo -e "You are upgrading from ${ORANGE}$installed_version${NC} -> ${GREEN}$latest_version${NC}."
+        log INFO "You are upgrading from ${ORANGE}$installed_version${NC} -> ${GREEN}$latest_version${NC}."
     fi
-
-    # split version numbers
-    installed_major=""
-    latest_major=""
-    IFS='.' read -r _1 installed_major _2 <<< "$installed_version"
-    IFS='.' read -r _1 latest_major _2 <<< "$latest_version"
-
-    if [[ $latest_major -gt $installed_major ]]; then
-        echo -e "${ORANGE}Warning:${NC} Major version upgrade detected."
-        echo "${ORANGE}Info${NC}: Check out the changelogs here -> https://github.com/v4n00/h2mm-cli/releases"
-        echo "The script will proceed to upgrade ${SCRIPT_NAME} to avoid breaking changes."
-
-        # find hd2 path
-        search_dir="${HOME}"
-        target_dir="Steam/steamapps/common/Helldivers\ 2/data"
-        echo "Searching for the Helldivers 2 data directory... (20 seconds timeout)" >&2
-
-        game_dir=$(timeout 20 find "$search_dir" -type d -path "*/$target_dir" 2>/dev/null | head -n 1)
-        if [[ -z "$game_dir" ]]; then
-			echo "Could not find the Helldivers 2 data directory automatically." >&2
-			IFS= read -ep "Please enter the path to the Helldivers 2 data directory: " game_dir
-			if [[ ! -d "$game_dir" ]]; then
-				echo -e "${RED}Error${NC}: Provided path is not a valid directory." >&2
-				exit 1
-			fi
-		fi
-
-        [[ ! -f "$game_dir/mods.csv" ]] && { echo -e "${RED}Error:${NC} mods.csv not found in $game_dir."; exit 1; }
-        
-        # make backup of mods in case something goes wrong
-        echo "${ORANGE}V${NC} It is advised to make a backup before proceeding."
-        h2mm export
-
-        # iterate from installed major number to latest major number
-        for ((i = installed_major + 1; i <= latest_major; i++)); do
-            if [[ -n "${breaking_changes_patches[$i]}" ]]; then 
-                eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:")
-            else
-                echo "No breaking changes for version $i."
-            fi
-            if [[ $? -ne 0 ]]; then
-                echo -ne "${RED}Error:${NC} Failed to apply breaking changes patch for version $i. Do you want to continue? (Y/n): "
-                read -er response
-                
-                [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; }
-            else
-                echo -e "Breaking changes patch for version ${ORANGE}$i${NC} applied ${GREEN}successfully${NC}."
-            fi
-        done
-    fi
-    echo
 fi
 
-# Install
-
 # if steam deck, set destination path to ~/.local/bin
-IFS= read -ep "Are you installing on a Steam Deck? (y/N): " response_sd
+log PROMPT "Are you installing on a Steam Deck? (y/N): "
+IFS= read -e response_sd
+
 if [[ "$response_sd" == "y" || "$response_sd" == "Y" ]]; then
     # steam deck
     DESTINATION_PATH="$HOME/.local/bin"
@@ -114,33 +81,96 @@ if [[ "$response_sd" == "y" || "$response_sd" == "Y" ]]; then
     # check if ~/.local/bin is in PATH
     if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
         # add ~/.local/bin to PATH
-        echo -e "${ORANGE}Warning:${NC} Installing the script on a Steam Deck means adding $DESTINATION_PATH to your \$PATH."
+        log INFO "Installing the script on a Steam Deck means adding $DESTINATION_PATH to your \$PATH."
-        echo -e "${ORANGE}Warning:${NC} If you're using a different shell, you may need to add it manually."
+        log INFO "If you're using a different shell than bash, you may need to add it manually."
 
-        IFS= read -ep "Do you want to add $DESTINATION_PATH to your \$PATH in ~/.bashrc? (Y/n): " response
+		log PROMPT "Do you want to add $DESTINATION_PATH to your \$PATH in ~/.bashrc? (Y/n): "
+        IFS= read -e response
         if [[ "$response" == "y" || "$response" = "Y" || -z "$response" ]]; then
             echo "export PATH=\"\$HOME/.local/bin:\$PATH\"" >> "$HOME/.bashrc"
-            echo -e "${GREEN}Success:${NC} Added $DESTINATION_PATH to your \$PATH in ~/.bashrc."
+
+			[[ $? -ne 0 ]] && { log ERROR "Failed to add $DESTINATION_PATH to \$PATH in ~/.bashrc." ; exit 1; }
+            log INFO "Added $DESTINATION_PATH to your \$PATH in ~/.bashrc."
         fi
     fi
 else
     # not steam deck
     # set another path if needed
-    IFS= read -ep "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): " response
+	log PROMPT "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): "
+    IFS= read -e response
 
     if [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]]; then
         DESTINATION_PATH="$response"
-        [[ ! -d "$DESTINATION_PATH" ]] && { echo -e "${RED}Error:${NC} Path $DESTINATION_PATH does not exist."; exit 1; }
+        [[ ! -d "$DESTINATION_PATH" ]] && { log ERROR "Path $DESTINATION_PATH does not exist." ; exit 1; }
     fi
 fi
 
-echo "Installing $SCRIPT_NAME to $DESTINATION_PATH."
+# handle breaking changes
-sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME" 
+installed_major=$(echo "$installed_version" | awk -F. '{print $2}')
-sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME"
+latest_major=$(echo "$latest_version" | awk -F. '{print $2}')
 
-if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then
+if [[ $latest_major -gt $installed_major ]]; then
-    echo -e "${RED}Error:${NC} Installation failed."
+	log INFO ""
-    exit 1
+	log INFO "Major version upgrade detected."
+	log INFO "Check out the changelogs here -> https://github.com/v4n00/h2mm-cli/releases"
+	log INFO "The script will proceed to upgrade the database file to avoid breaking changes."
+
+	# find hd2 path
+	search_dir="${HOME}"
+	target_dir="Steam/steamapps/common/Helldivers\ 2/data"
+
+	# check if game directory is in ~/.config/h2mm/h2path
+	if [[ -f "$HOME/.config/h2mm/h2path" ]]; then
+		game_dir=$(cat "$HOME/.config/h2mm/h2path")
+		[[ ! -d "$game_dir" ]] && { log ERROR "Helldivers 2 data directory in ~/.config/h2mm/h2path is not a valid directory." ; exit 1; }
+
+		log INFO "Helldivers 2 data directory found: $game_dir."
+	else
+		log INFO "Searching for the Helldivers 2 data directory... (20 seconds timeout)"
+		game_dir=$(timeout 20 find "$search_dir" -type d -path "*/$target_dir" 2>/dev/null | head -n 1)
+	fi
+
+	# if not found, prompt user
+	if [[ -z "$game_dir" ]]; then
+		log INFO "Could not find the Helldivers 2 data directory automatically."
+		log PROMPT "Please enter the path to the Helldivers 2 data directory: "
+		IFS= read -e game_dir
+		if [[ ! -d "$game_dir" ]]; then
+			log ERROR "Provided path is not a valid directory."
+			exit 1
+		fi
+	fi
+
+	[[ ! -f "$game_dir/mods.csv" ]] && { log ERROR "mods.csv not found in $game_dir." ; exit 1; }
+
+	# iterate from installed major number to latest major number
+	for ((i = installed_major + 1; i <= latest_major; i++)); do
+		if [[ -n "${breaking_changes_patches[$i]}" ]]; then
+			# apply breaking changes patch
+			eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:g")
+		else
+			log INFO "No breaking changes for version $i."
+			continue
+		fi
+
+		if [[ $? -ne 0 ]]; then
+			log ERROR "Failed to apply breaking changes patch for version $i. Do you want to continue? (Y/n): "
+			read -er response
+
+			[[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { log INFO "Exiting." ; exit 1; }
+		else
+			log INFO "Version upgrade fix ${GREEN}successfully${NC} applied for version $i."
+		fi
+	done
+	log INFO ""
 fi
 
-echo "Helldivers 2 Mod Manager CLI installed successfully to $DESTINATION_PATH/$SCRIPT_NAME. Use it by running '$SCRIPT_NAME'."
+# install
+log INFO "Installing $SCRIPT_NAME to $DESTINATION_PATH."
+sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME"
+sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME"
+log INFO ""
+
+[[ ! -x "$(command -v $SCRIPT_NAME)" ]] && { log ERROR "Installation failed. Mod manager was not found in \$PATH." ; exit 1; }
+log INFO "Helldivers 2 Mod Manager CLI ${GREEN}successfully${NC} installed: $DESTINATION_PATH/$SCRIPT_NAME."
+log INFO "Use it by running '$SCRIPT_NAME'. Made with love <3 by v4n and contributors."

version

@@ -1 +1 @@
-0.3.5
+0.4.0