feat: nexus mods integration (#44)

* progress

* working download

* save details in db, display them

* progress

* progress

* progress

* progress

* i guess it's shippable

* final commit

.editorconfig

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

.gitignore

@@ -1,5 +1,6 @@
-*
-!h2mm
-!install.sh
-!README.md
-!version
+*
+!h2mm
+!install.sh
+!README.md
+!version
+!.editorconfig

README.md

@@ -1,135 +1,134 @@
-# Helldivers 2 Mod Manager CLI
-
-- [Helldivers 2 Mod Manager CLI](#helldivers-2-mod-manager-cli)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Available commands](#available-commands)
-    - [Basic usage](#basic-usage)
-      - [Install a mod](#install-a-mod)
-      - [Uninstall a mod](#uninstall-a-mod)
-      - [Enable/disable mods](#enabledisable-mods)
-      - [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.
-
-## Installation
-
-To install/update Helldivers 2 Mod Manager CLI run the following command in your terminal:
-
-```bash
-sh -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.
-
-```bash
-h2mm
-```
-
-### Available commands
-
-- `install` - Install a mod with files
-- `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 a mod
-
-```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
-```
-
-> Currently, 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
-```
-
-
-#### Enable/disable mods
-
-```bash
-h2mm enable "Example mod"
-h2mm enable -i 1 # enable mod with index 1
-h2mm disable "Example mod"
-h2mm disable -i 1 # disable mod with index 1
-```
-
-#### List installed mods
-
-```bash
-h2mm list
-```
-
-## Advanced usage
-
-### Shortcuts
-
-You can use the short form of commands to save some time. The shortcuts are:
-
-- `i` for `install`
-- `u` for `uninstall`
-- `e` for `enable`
-- `d` for `disable`
-- `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.
-
-```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
-
-- [x] Check for mod updates
-- [x] Enable/disable mods
-- [ ] Easier way to change mod presets
-- [ ] Find a way to make use of `manifest.json` and simplify installing variants
-- [x] [DEV] Change to `.tar.gz` for exporting and importing
-- [x] [DEV] Provide fixes for breaking updates
-- [ ] [DEV] Optimize code - throw errors in 1 line
-- [ ] [DEV] Rewrite some code to be more readable
+# Helldivers 2 Mod Manager CLI
+
+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.
+
+This script is complete, the version will always [remain at 0.x.x](https://0ver.org/)
+
+## Installation
+
+Pre-requisites:
+
+- You must have the `unzip` package installed for zip archives;
+- You might want to have the `unarchiver` package installed for rar archives.
+
+> The `unzip` package comes pre-installed on most Linux distributions. If you do not know how to install packages, search for your Linux distro and package manager.
+
+To install Helldivers 2 Mod Manager CLI run the following command in your terminal:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh)"
+```
+
+> [!CAUTION]
+> 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.
+
+If for some reason, the installation command doesn't work you can:
+
+1. Go to <https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh>
+1. Right click -> Save page as...
+1. Open your terminal
+1. Go to your downloads folders with `cd ~/Downloads`
+1. Give the script execution permissions `chmod +x install.sh`
+1. Run the script `./install.sh`
+
+## 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.
+
+```bash
+h2mm
+```
+
+### Available commands
+
+- `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;
+- `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-create` or `mc` - Create a modpack from the currently installed mods;
+- `modpack-switch` or `ms` - Switch to a modpack;
+- `modpack-list` or `ml` - List all installed modpacks;
+- `modpack-delete` or `md` - Delete a modpack;
+- `modpack-overwrite` or `mo` - Overwrite a modpack;
+- `modpack-reset` or `mr` - Reset all installed modpacks;
+- `nexus-setup` or `ns` - Setup Nexus Mods integration;
+- `nexus-update` or `nu` - Start Nexus mods upgrade process;
+- `update` or `up` - Update h2mm to latest version;
+- `reset` or `r` - Reset all installed mods;
+- `help` or `h` - Display this help message.
+
+### Usage
+
+To find out how to use a command, you can run `h2mm <COMMAND> --help`.
+
+#### Install mod(s)
+
+```bash
+h2mm install /path/to/mod.zip
+h2mm install /path/to/mod/directory/
+h2mm install /path/to/mod.zip /path/to/mod2.zip /path/to/mod/files
+h2mm install -n "Example mod" mod.patch_0 mod.patch_0.stream # -n is mandatory when using files
+```
+
+> It's better to be in the directory where the mod files are located, so you don't have to specify the full path. For mod downloads, you can do `cd ~/Downloads` and then run the command.
+>
+> Also, use the Tab key to autocomplete the file names, as it will help you escape special characters likes spaces or quotes.
+
+#### List installed mods
+
+```bash
+h2mm list
+h2mm list -v # verbose mode
+```
+
+#### Uninstall a mod
+
+```bash
+h2mm uninstall -n "Example mod"
+h2mm uninstall -i 3 # get the index from the list command
+```
+
+#### Enable/disable mods
+
+```bash
+h2mm enable -n "Example mod"
+h2mm enable -i 3
+h2mm disable -n "Example mod"
+h2mm disable -i 3
+```
+
+#### Updating the script
+
+```bash
+h2mm update
+```
+
+## Nexus Mods integration
+
+Nexus Mods integration allows you to use the 1-click install feature of Nexus Mods (with the "Vortex" or "Mod manager download" buttons). You can set up Nexus Mods integration by running the following command:
+
+```bash
+h2mm nexus-setup
+```
+
+You will be walked through the setup process, which will ask you for your Nexus Mods API key and your preferred terminal.
+
+## Compatibility
+
+The script is developed and tested on Arch Linux, but it should work on other Linux distributions as well. If you encounter any issues, please open an issue on the repository.
+
+Status of platforms:
+
+- Linux :white_check_mark:
+- Steam Deck :white_check_mark:
+- Windows - WSL :white_check_mark:
+
+> The script works on WSL, but you need to specify the path to the Helldivers 2 mods directory manually, to find your Windows partition head to `/mnt/` and from there go to your Helldivers 2 data directory, on a typical install it should be on `/mnt/c/Program\ Files\ \(x86\)/Steam/steamapps/common/Helldivers\ 2/data`. You also need to have `unzip` installed, which can be done by running `sudo apt install unzip`. Nexus Mods integration is not supported on WSL.
+
+## Contributing
+
+Feel free to contribute to this project by creating a pull request or opening an issue.

install.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 
 RED='\033[0;31m'
@@ -8,110 +8,184 @@ 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
-    echo "Run me as normal user, not as root."
-    exit 1
-fi
+function log() {
+	local type="$1"
+	shift
+	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} !!!"
-echo -e "This script will install Helldivers 2 Mod Manager CLI for Linux to $DESTINATION_PATH/$SCRIPT_NAME."
-echo -e "Running this script will require sudo permissions. ${RED}DO NOT TRUST${NC} random scripts from the internet."
-echo -e "If you want to review the script before running it, check out the mod repository for yourself:"
-echo -e "https://github.com/v4n00/h2mm-cli"
-echo -e "!!! ${RED}WARNING${NC} !!!"
-echo
+cat << EOF
+!!! WARNING !!!
+This script will install Helldivers 2 Mod Manager CLI for Linux to $DESTINATION_PATH/$SCRIPT_NAME.
+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:
+https://github.com/v4n00/h2mm-cli
+!!! WARNING !!!
 
-# Check if update
-
-# Breaking changes hash table
+EOF
 
+# 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"'
 )
 
-# Script
-
+# 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"; }
 
-    latest_version=$(curl -sS https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/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."
+		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
+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 steam deck, set destination path to ~/.local/bin
+log PROMPT "Are you installing on a Steam Deck? (y/N): "
+IFS= read -e response_sd
 
-    if [[ $latest_major -gt $installed_major ]]; then
-        echo -e "${ORANGE}Warning:${NC} Major version upgrade detected."
-        echo "The script will proceed to upgrade ${SCRIPT_NAME} to avoid breaking changes."
+if [[ "$response_sd" == "y" || "$response_sd" == "Y" ]]; then
+    # steam deck
+    DESTINATION_PATH="$HOME/.local/bin"
+    mkdir -p "$DESTINATION_PATH"
 
-        # find hd2 path
-        search_dir="${HOME}"
-        target_dir="Steam/steamapps/common/Helldivers\ 2/data"
-        echo "Searching for the Helldivers 2 data directory..." >&2
-        game_dir=$(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
-            read -p "Please enter the path to the Helldivers 2 data directory: " game_dir
-            game_dir=$(eval echo "$game_dir")
+    # check if ~/.local/bin is in PATH
+    if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
+        # add ~/.local/bin to PATH
+        log INFO "Installing the script on a Steam Deck means adding $DESTINATION_PATH to your \$PATH."
+        log INFO "If you're using a different shell than bash (the default), you may need to add it manually."
 
-            if [[ ! -d "$game_dir" ]]; then
-                echo -e "${RED}Error${NC}: Provided path is not a valid directory." >&2
-                exit 1
-            fi
+		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"
+			[[ $? -ne 0 ]] && { log ERROR "Failed to add $DESTINATION_PATH to \$PATH in ~/.bashrc." ; exit 1; }
+
+			source "$HOME/.bashrc"
+			[[ $? -ne 0 ]] && { log ERROR "Failed to source ~/.bashrc." ; exit 1; }
+
+            log INFO "Added $DESTINATION_PATH to your \$PATH in ~/.bashrc."
         fi
+    fi
+else
+    # not steam deck
+    # set another path if needed
+	log PROMPT "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): "
+    IFS= read -e response
 
-        [[ ! -f "$game_dir/mods.csv" ]] && { echo -e "${RED}Error:${NC} 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
-            echo -e "${RED}[ ]${NC} Applying breaking changes patch for version $i."
-
-            [[ -n "${breaking_changes_patches[$i]}" ]] && eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:")
-            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 -r response
-                
-                [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; }
-            else
-                echo -e "${GREEN}[X]${NC} Breaking changes patch for version $i applied successfully."
-            fi
-        done
+    if [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]]; then
+        DESTINATION_PATH="$response"
+        [[ ! -d "$DESTINATION_PATH" ]] && { log ERROR "Path $DESTINATION_PATH does not exist." ; exit 1; }
     fi
 fi
 
-# Install
+# handle breaking changes
+installed_major=$(echo "$installed_version" | awk -F. '{print $2}')
+latest_major=$(echo "$latest_version" | awk -F. '{print $2}')
 
-read -p "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): " response
+if [[ $latest_major -gt $installed_major ]]; then
+	log INFO ""
+	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."
 
-if [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]]; then
-    DESTINATION_PATH=$(eval echo "$response")
-    if [[ ! -d "$DESTINATION_PATH" ]]; then
-        echo -e "${RED}Error:${NC} Path $DESTINATION_PATH does not exist. Exiting..."
-        exit 1
-    fi
+	# find hd2 path
+	search_dir="${HOME}"
+	target_dir="Steam/steamapps/common/Helldivers\ 2/data"
+
+	# make backup
+	log INFO "Creating a backup in case anything goes wrong."
+	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 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... (10 seconds timeout)"
+		game_dir=$(timeout 10 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 "Installing $SCRIPT_NAME to $DESTINATION_PATH."
-sudo curl https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/h2mm --output "$DESTINATION_PATH/$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 ""
 
-if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then
-    echo -e "${RED}Error:${NC} Installation failed."
-    exit 1
-fi
+[[ ! -x "$(command -v $SCRIPT_NAME)" ]] && { log ERROR "Installation failed. Mod manager was not found in \$PATH." ; exit 1; }
 
-echo "Helldivers 2 Mod Manager CLI installed successfully to $DESTINATION_PATH/$SCRIPT_NAME. Use it by running '$SCRIPT_NAME'."
+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 '$SCRIPT_NAME' in your terminal."
+log INFO "Made with love <3 by v4n and contributors."

version

@@ -1 +1 @@
-0.2.0
+0.5.0