chore: deprecate

* docs: rewrite help commands

* docs: rewrite README.md

* docs: remove you language

* refactor: started parse refactor

.editorconfig

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

.gitignore

@@ -2,3 +2,5 @@
 !h2mm
 !install.sh
 !README.md
+!version
+!.editorconfig

README.md

@@ -1,120 +1,77 @@
 # Helldivers 2 Mod Manager CLI
 
-- [Helldivers 2 Mod Manager CLI](#helldivers-2-mod-manager-cli)
+## Deprecation notice
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Available commands](#available-commands)
-    - [Basic usage](#basic-usage)
-      - [Install a mod](#install-a-mod)
-      - [Uninstall a mod](#uninstall-a-mod)
-      - [List installed mods](#list-installed-mods)
-  - [Advanced usage](#advanced-usage)
-    - [Shortcuts](#shortcuts)
-    - [Exporting and importing](#exporting-and-importing)
-    - [Resetting all installed mods](#resetting-all-installed-mods)
-    - [Database location and details](#database-location-and-details)
-  - [Contributing](#contributing)
-  - [Planned features](#planned-features)
 
-Helldivers 2 Mod Manager CLI is a command line interface for managing Helldivers 2 mods. Since there is no mod manager GUI for Helldivers 2 on Linux yet, this small script aims to provide a simple way to manage mods on Linux.
+> [!Caution]
+> This project is deprecated as of 30/09/2025 in favor of [Arsenal](https://www.nexusmods.com/helldivers2/mods/4664)'s 0.30.0 release, a GUI mod manager that supports every feature of Helldivers 2 Mod Manager CLI and more, on Linux.
+
+**Thank you for the support up until now and make sure to check out Arsenal!**
+
+## Overview
+
+Helldivers 2 Mod Manager CLI is a command line interface for managing Helldivers 2 mods. Since there is no Linux mod manager available and I like being a nerd by using CLI tools instead of GUIs, this project was born.
 
 ## Installation
 
-To install/update Helldivers 2 Mod Manager CLI run the following command in your terminal:
+Pre-requisites:
+
+- The `unzip` package must be installed for ZIP archives.
+- The `unarchiver` package is recommended for RAR and 7Z archives.
+
+To install Helldivers 2 Mod Manager CLI run the following command in the terminal:
 
 ```bash
-sh -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh)"
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh)"
 ```
 
-Running this script will require sudo permissions. **DO NOT TRUST** random scripts from the internet. If you want to review the script before running it, check out the mod repository for yourself.
-
 ## Usage
 
-The script gets added to `/usr/local/bin/h2mm` and can be used by running `h2mm` in your shell, which will show the help message explaining how to use the script.
+The script gets added to `/usr/local/bin/h2mm` (or `$HOME/.local/bin` on Steam Deck) and can be used by running `h2mm` in the shell, which will print the help message along with all available commands.
 
 ```bash
-h2mm
+h2mm --help
 ```
 
-### Available commands
+To find out how to use a command, run `h2mm COMMAND --help`. This is the most up-to-date source of information about the commands.
 
-- `install` - Install a mod with files
+## Available commands
-- `uninstall` - Uninstall a mod by name
-- `list` - List all installed mods
-- `export <zip_name>` - Export installed mods to a zip file
-- `import <zip_name>` - Import mods from a zip file
-- `reset` - Reset all installed mods
-- `help` - Display the help message
 
-### Basic usage
+- `install` or `i` - Install a mod by the file provided (directory, zip, patch)
+- `uninstall` or `u` - Uninstall a mod
+- `list` or `l` - List all installed mods
+- `enable` or `e` - Enable a mod
+- `disable` or `d` - Disable a mod
+- `rename` or `r` - Rename a mod
+- `order` or `o` - Change load order for a mod
+- `export` or `ex` - Export installed mods to a zip file
+- `import` or `im` - Import mods from a zip file
+- `modpack` or `m` - Manage modpacks (collections of mods)
+- `nexus-setup` or `ns` - Setup Nexus Mods integration
+- `update` or `up` - Update h2mm to latest version
+- `reset` or `rs` - Reset all installed mods
+- `help` or `h` - Display this help message
 
-#### Install a mod
+## Examples
-
-```bash
-h2mm install /path/to/mod.zip
-h2mm install /path/to/mod/files
-h2mm install -n "Example mod" mod.patch_0 mod.patch_0.stream # -n is mandatory when using files
-h2mm install -n "Example mod" mod* # using a wildcard to include all files
-```
-
-Important: If the mod has more than 1 variant, you need to install the one you want by unarchiving it separately.
-
-#### Uninstall a mod
-
-```bash
-h2mm uninstall "Example mod"
-h2mm uninstall -i 1 # uninstall mod with index 1
-```
-
-#### List installed mods
 
 ```bash
+h2mm install --help
+h2mm install ~/Downloads/mod.zip
+h2mm install ~/Downloads/mod\ files/
+h2mm install a0b1c2d3.patch_0 a0b1c2d3.patch_0.stream -n "Example mod"
 h2mm list
+h2mm uninstall --index 3
+h2mm modpack create "Example modpack"
+h2mm modpack switch "Example modpack"
 ```
 
-## Advanced usage
+> When installing, it is recommended to be in the directory where mod archives are, or to use absolute paths. Use `cd ~/Downloads` to go to the Downloads folder, and run `ls -la` to find the archives to install. Use the Tab key to auto-complete file and folder names, this helps escape spaces and special characters.
+>
+> Use the `--index` flag with commands that normally require a mod name to specify a mod by its index. The index can be obtained with `h2mm list`.
 
-### Shortcuts
+## Nexus Mods integration
 
-You can use the short form of the commands to save some time. The shortcuts are:
+Nexus Mods integration allows the use the 1-click install feature of Nexus Mods (with the "Vortex" or "Mod manager download" buttons). Set up Nexus Mods integration by running `h2mm nexus-setup`. Setup includes providing the Nexus Mods API key and selecting the preferred terminal.
-
-- `i` for `install`
-- `u` for `uninstall`
-- `l` for `list`
-- `ex` for `export`
-- `im` for `import`
-- `r` for `reset`
-
-### Exporting and importing
-
-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 zip file will be saved in the current directory.
-
-This will serve as either a backup or a way to have multiple mod setups.
-
-```bash
-h2mm export modpack1.zip
-h2mm import modpack2.zip
-```
-
-### Resetting all installed mods
-
-You can reset all installed mods by running the following command. This will remove all installed mods and the database, in case things go wild.
-
-```bash
-h2mm reset
-```
-
-### Database location and details
-
-The database is stored in the `Helldivers 2` install directory, under the `data` folder with the name `mods.csv`, where the mods are also installed. The database is a simple CSV file which you can use to manually manage mods if needed, you can mostly use it to rename or reorder mods.
 
 ## Contributing
 
 Feel free to contribute to this project by creating a pull request or opening an issue.
-
-## Planned features
-
-- [ ] ! Enable/disable mods
-- [ ] !! Easier way to change mod presets
-- [ ] !! Change to `.tar.xz` for exporting and importing
-- [ ] !!! Find a way to make use of `manifest.json` and simplify installing variants

install.sh

@@ -1,41 +1,211 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 
 RED='\033[0;31m'
+GREEN='\033[0;32m'
+ORANGE='\033[0;33m'
 NC='\033[0m'
 
 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"
+	shift
+	case "$type" in
+		INFO)
+			echo -e "$*" >&2
+			;;
+		ERROR)
+			echo -e "${RED}[ERROR]${NC} $*" >&2
+			;;
+		PROMPT)
+			echo -ne "$*" >&2
+			;;
+	esac
+}
+
+# --- Main ---
+
+log INFO "Running h2mm CLI Installer (https://github.com/v4n00/h2mm-cli)"
+
+# 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"]='tmp_file=$(mktemp) && awk '\''BEGIN {FS=OFS=","} NR==1 {print 4; next} {print NR-1, $2, $3, $4, $5}'\'' "$1/mods.csv" > "$tmp_file" && tee "$1/mods.csv" < "$tmp_file" > /dev/null && rm "$tmp_file"'
+	["5"]='sed -i "s/^\([0-9]\+\),\(.*\),\(.*\),\(.*\)/\1,\2,\3,,,,\4/" "$1/mods.csv"; sed -i "1 s/4/5/" "$1/mods.csv"'
+	["6"]='sed -i "s/^\([0-9]\+\),\(.*\),\(.*\),\(.*\),\(.*\),\(.*\),\(.*\)/\1,\2,\3,\4,\6,\7/" "$1/mods.csv"; sed -i "1 s/5/6/" "$1/mods.csv"'
+)
+
+# notify if update is happening
+installed_version=""
+latest_version=""
+if [[ -x "$(command -v h2mm)" ]]; then
+    installed_version=$(h2mm --version)
+
+	# 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."
+		log INFO 'Download using the command: bash -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh)"'
 		exit 1
 	fi
 
-echo -e "!!! ${RED}WARNING${NC} !!!"
+    latest_version=$(curl -sS "$REPO_URL"/version)
-echo -e "This script will install Helldivers 2 Mod Manager CLI for Linux to $DESTINATION_PATH/$SCRIPT_NAME."
+    if [[ "$latest_version" == "$installed_version" ]]; then
-echo -e "Running this script will require sudo permissions. ${RED}DO NOT TRUST${NC} random scripts from the internet."
+        log INFO "You are reinstalling version ${GREEN}$installed_version${NC}."
-echo -e "If you want to review the script before running it, check out the mod repository for yourself:"
+    else
-echo -e "https://github.com/v4n00/h2mm-cli"
+        log INFO "You are upgrading from ${ORANGE}$installed_version${NC} -> ${GREEN}$latest_version${NC}."
-echo
+    fi
+fi
 
-read -p "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): " response
+# if steam os, set destination path to ~/.local/bin
+steamos=false
+
+if [[ -f "/etc/os-release" ]]; then
+	if grep -q "ID=steamos" /etc/os-release; then
+		steamos=true
+	fi
+fi
+
+if [[ $steamos == true ]]; then
+    # steam os
+    DESTINATION_PATH="$HOME/.local/bin"
+    log INFO "Detected SteamOS, setting installation path to ${ORANGE}$DESTINATION_PATH${NC}."
+
+    mkdir -p "$DESTINATION_PATH"
+
+    # check if ~/.local/bin is in PATH
+    if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
+        # add ~/.local/bin to PATH
+        log INFO "Installing the script on SteamOS means adding ${ORANGE}$DESTINATION_PATH${NC} to your \$PATH."
+        log INFO "If you're using a different shell than bash (the default), you may need to add it manually."
+
+		log PROMPT "Do you want to automatically add ${ORANGE}$DESTINATION_PATH${NC} 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"
+			[[ $? -ne 0 ]] && { log ERROR "Failed to add $DESTINATION_PATH to \$PATH in ~/.bashrc." ; exit 1; }
+
+			source "$HOME/.bashrc"
+			export PATH="$HOME/.local/bin:$PATH" # fallback kinda in case sourcing fails
+
+            log INFO "Added ${ORANGE}$DESTINATION_PATH${NC} to your \$PATH in ~/.bashrc."
+        fi
+    fi
+else
+    # not steam os
+    # set another path if needed
+	log PROMPT "Install the script to ${ORANGE}$DESTINATION_PATH${NC} 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=$(eval echo "$response")
+        DESTINATION_PATH="$response"
-    if [[ ! -d "$DESTINATION_PATH" ]]; then
+        [[ ! -d "$DESTINATION_PATH" ]] && { log ERROR "Path $DESTINATION_PATH does not exist." ; exit 1; }
-        echo -e "${RED}Error:${NC} Path $DESTINATION_PATH does not exist. Exiting..."
-        exit 1
     fi
 fi
 
-echo "Installing $SCRIPT_NAME to $DESTINATION_PATH."
+# handle breaking changes
-sudo curl https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/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 "${GREEN}IMPORTANT${NC}: Major version upgrade detected. Check out the changelogs here -> https://github.com/v4n00/h2mm-cli/releases"
+	log INFO "The script will proceed to upgrade the database file. Creating a backup in case anything goes wrong."
+
+	# make backup
+	h2mm export
+
+	# 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 is not valid: $game_dir." ; exit 1; }
+	else
+		log INFO "Searching for the Helldivers 2 data directory... (10 seconds timeout)"
+		game_dir=$(timeout 10 find "$HOME" -type d -path "*/Steam/steamapps/common/Helldivers\ 2/data" 2>/dev/null | head -n 1)
 	fi
 
-echo "Helldivers 2 Mod Manager CLI installed successfully to $DESTINATION_PATH/$SCRIPT_NAME. Use it by running '$SCRIPT_NAME'."
+	# if not found, prompt user
+	if [[ -z "$game_dir" ]]; then
+		# if not found, ask user for the directory
+		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; unset IFS
+		game_dir="$(substitute_home "$game_dir")"
+
+		[[ ! -d "$game_dir" ]] && { log ERROR "Provided path is not a valid directory."; exit 1; }
+	else
+		# confirm with the user that the directory is ok
+		log INFO "Found Helldivers 2 data directory: $game_dir"
+		log PROMPT "Is this the correct directory? (Y/n): "
+		read confirm
+
+		if [[ "$confirm" != "y" && "$confirm" != "Y" && "$confirm" != "" ]]; then
+			log PROMPT "Please enter the path to the Helldivers 2 data directory: "
+			IFS= read -e game_dir; unset IFS
+			game_dir="$(substitute_home "$game_dir")"
+
+			[[ ! -d "$game_dir" ]] && { 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
+
+# install
+log INFO "Installing h2mm to ${ORANGE}$DESTINATION_PATH${NC}."
+
+# check if we need sudo based on destination path
+SUDO_CMD=""
+if [[ ! -w "$DESTINATION_PATH" || ( -f "$DESTINATION_PATH/h2mm" && ! -w "$DESTINATION_PATH/h2mm" ) ]]; then
+    SUDO_CMD="sudo"
+    log INFO "Destination path ${RED}requires${NC} elevated permissions, using sudo."
+fi
+
+$SUDO_CMD curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/h2mm"
+$SUDO_CMD chmod +x "$DESTINATION_PATH/h2mm"
+log INFO ""
+
+[[ ! -x "$(command -v h2mm)" ]] && { log ERROR "Installation failed. Mod manager was not found in \$PATH." ; exit 1; }
+
+log INFO "Helldivers 2 Mod Manager CLI ${GREEN}successfully${NC} installed."
+log INFO "${GREEN}IMPORTANT${NC}: To install mods, you need to have installed:"
+log INFO " -> \"unzip\" package for .zip archives"
+log INFO " -> \"unarchiver\" package for .rar archives"
+log INFO "If you do not know how to install these packages, please search for your linux distro on how to install packages."
+log INFO ""
+log INFO "Use the mod manager by running 'h2mm' in your terminal."
+log INFO "View the changelogs: https://github.com/v4n00/h2mm-cli/releases/latest"
+log INFO "Check out the ${ORANGE}Nexus Mods integration${NC} by running 'h2mm nexus-setup'."
+log INFO "Made with <3 by v4n and contributors."
+log INFO ""
+log INFO "${RED}Special announcement:${NC}"
+log INFO "The Helldivers 2 Mod Manager CLI is now deprecated in favor of the Arsenal Mod Manager."
+log INFO "Check it out here: https://www.nexusmods.com/helldivers2/mods/4664"
+log INFO "The Arsenal Mod Manager has a GUI and is more user friendly,"
+log INFO "making it the preferred choice for most users, especially since it now works on Linux!"
+log INFO "Thank you for using the Helldivers 2 Mod Manager CLI, and we hope to see you on the Arsenal Mod Manager!"

version

@@ -0,0 +1 @@
+0.7.0