12 Commits

Author SHA1 Message Date
v4n 09c40aa25f bump: version 2025-02-05 23:32:50 +02:00
Matt Cavanagh 1a01034816 feat: added self update mechanism (#15)
* feat: Added self update mechanism

* fix: Formatting

* fix: Formatting again

* fix: Arghhh INDENTATION

* feat: Updated readme with new command

* feat: Added shortcut command

* feat: Added more detail to the readme

* feat: Removed the check for the last update file. It seems a bit pointless to delay checking for it, it's curling github so it's not like it's a DDOS concern, and it could be the tool is getting updated often, why delay their updates? It's also just a curl, it's very inexpensive.

* feat: Removed REPO_URL, it was unused

* feat: Reverted version testing change (oops)

* feat: checking for updates timed at 1 hour

* fix: info messages formatting

---------

Co-authored-by: v4n <105587619+v4n00@users.noreply.github.com>
2025-02-05 23:29:21 +02:00
v4n 83e2161456 code: removed unnecessary parameter passing 2025-02-05 17:09:15 +02:00
Luca Saalfeld a2b904caa2 feat: prevent the same mod from being installed multiple times (#14)
* prevent the same mod from being installed multiple times

* use flag instead of variable for exit check
2025-02-05 16:59:00 +02:00
v4n 9f622ca130 bump: version 2025-02-05 16:27:04 +02:00
v4n 0ab273977e fix: function return typo, trailing slashes removed from paths (#13) 2025-02-05 16:23:32 +02:00
Luca Saalfeld 388afe69b7 fix: bash date comparison (#12) 2025-02-05 15:22:10 +02:00
v4n 3f0305c741 feat: steam deck install 2025-02-03 02:08:50 +02:00
v4n 1a6a13a621 fix: enable/disable logic 2025-02-03 01:49:41 +02:00
Harsh Shandilya 23cb0646bf Use portable shebangs (#7)
* h2mm: use portable shebang

* install.sh: use portable shebang
2025-01-28 11:49:51 +02:00
v4n 6768cab391 fix: disabling/enabling correctly downgrades/upgrades 2025-01-27 00:10:44 +02:00
v4n 35902f1f8f fix: downgrade logic 2025-01-23 09:29:48 +02:00
4 changed files with 1418 additions and 1322 deletions
+164 -155
View File
@@ -1,155 +1,164 @@
# Helldivers 2 Mod Manager CLI # 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. 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/) This script is complete, the version will always [remain at 0.x.x](https://0ver.org/)
## Installation and updating ## Installation
To install/update Helldivers 2 Mod Manager CLI run the following command in your terminal: To install Helldivers 2 Mod Manager CLI run the following command in your terminal:
```bash ```bash
bash -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)"
``` ```
> [!CAUTION] > [!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. > 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: 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. Go to <https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh>
1. Go to your downloads folders `cd ~/Downloads` 1. Right click -> Save page as...
1. Give the script execution permissions `chmod +x install.sh` 1. Go to your downloads folders `cd ~/Downloads`
1. Run the script `./install.sh` 1. Give the script execution permissions `chmod +x install.sh`
1. Run the script `./install.sh`
## Usage
## 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` and can be used by running `h2mm` in your shell, which will show the help message explaining how to use the script.
```bash
h2mm ```bash
``` h2mm
```
### Available commands
### Available commands
- `install` - Install a mod by the file provided (directory, zip, patch).
- `uninstall` - Uninstall a mod by name (or index). - `install` - Install a mod by the file provided (directory, zip, patch).
- `list` - List all installed mods. - `uninstall` - Uninstall a mod by name (or index).
- `enable` - Enable a mod by name (or index). - `list` - List all installed mods.
- `disable` - Disable a mod by name (or index). - `enable` - Enable a mod by name (or index).
- `export` - Export installed mods to a zip file. - `disable` - Disable a mod by name (or index).
- `import` - Import mods from a zip file. - `export` - Export installed mods to a zip file.
- `modpack-create` - Create a modpack from the currently installed mods. - `import` - Import mods from a zip file.
- `modpack-switch` - Switch to a modpack by name (or index). - `modpack-create` - Create a modpack from the currently installed mods.
- `modpack-list` - List all installed modpacks. - `modpack-switch` - Switch to a modpack by name (or index).
- `modpack-delete` - Delete a modpack by name (or index). - `modpack-list` - List all installed modpacks.
- `modpack-overwrite` - Overwrite a modpack by name (or index). - `modpack-delete` - Delete a modpack by name (or index).
- `modpack-reset` - Reset all installed modpacks. - `modpack-overwrite` - Overwrite a modpack by name (or index).
- `reset` - Reset all installed mods. - `modpack-reset` - Reset all installed modpacks.
- `help` - Display this help message. - `reset` - Reset all installed mods.
- `update` - Update h2mm to latest version.
### Basic usage - `help` - Display this help message.
#### Install mod(s) ### Basic usage
```bash #### Install mod(s)
h2mm install /path/to/mod.zip
h2mm install /path/to/mod/files ```bash
h2mm install /path/to/mod.zip /path/to/mod2.zip /path/to/mod/files h2mm install /path/to/mod.zip
h2mm install -n "Example mod" mod.patch_0 mod.patch_0.stream # -n is mandatory when using files h2mm install /path/to/mod/files
h2mm install -n "Example mod" mod* # using a wildcard to include all files 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
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.
> [!NOTE]
#### Uninstall a mod > If the mod has more than 1 variant, you need to install the one you want by unarchiving it separately and providing the directory.
```bash #### Uninstall a mod
h2mm uninstall "Example mod"
h2mm uninstall -i 1 # uninstall mod with index 1 ```bash
``` h2mm uninstall "Example mod"
h2mm uninstall -i 1 # uninstall mod with index 1
#### Enable/disable mods ```
```bash #### Enable/disable mods
h2mm enable "Example mod"
h2mm enable -i 1 # enable mod with index 1 ```bash
h2mm disable "Example mod" h2mm enable "Example mod"
h2mm disable -i 1 # disable mod with index 1 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 #### List installed mods
h2mm list
``` ```bash
h2mm list
## 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. #### Updating the script
Status of platforms: ```bash
h2mm update
- Linux :white_check_mark: ```
- Steam Deck - untested (should work) :grey_question:
- Windows - WSL :white_check_mark: ## Compatibility
> 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`. 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.
## Advanced usage Status of platforms:
### Shortcuts - Linux :white_check_mark:
- Steam Deck :white_check_mark:
You can use the short form of commands to save some time. The shortcuts are: - Windows - WSL :white_check_mark:
- `i` for `install` > 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`.
- `u` for `uninstall`
- `e` for `enable` ## Advanced usage
- `d` for `disable`
- `l` for `list` ### Shortcuts
- `ex` for `export`
- `im` for `import` You can use the short form of commands to save some time. The shortcuts are:
- `mc` for `modpack-create`
- `ms` for `modpack-switch` - `i` for `install`
- `ml` for `modpack-list` - `u` for `uninstall`
- `md` for `modpack-delete` - `e` for `enable`
- `mo` for `modpack-overwrite` - `d` for `disable`
- `mr` for `modpack-reset` - `l` for `list`
- `r` for `reset` - `ex` for `export`
- `im` for `import`
### Modpacks support - `mc` for `modpack-create`
- `ms` for `modpack-switch`
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. - `ml` for `modpack-list`
- `md` for `modpack-delete`
```bash - `mo` for `modpack-overwrite`
h2mm modpack-create "Modpack 1" - `mr` for `modpack-reset`
# install, enable, disable other mods... - `r` for `reset`
h2mm modpack-create "Modpack 2" - `up` for `update`
h2mm modpack-switch "Modpack 1"
``` ### Modpacks support
### Exporting and importing 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.
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 modpack-create "Modpack 1"
```bash # install, enable, disable other mods...
h2mm export modpack1.zip h2mm modpack-create "Modpack 2"
h2mm import modpack2.zip h2mm modpack-switch "Modpack 1"
``` ```
### Resetting all installed mods ### Exporting and importing
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. 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 ```bash
h2mm reset h2mm export modpack1.zip
``` h2mm import modpack2.zip
```
### Database location and details
### Resetting all installed mods
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.
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.
## Contributing
```bash
Feel free to contribute to this project by creating a pull request or opening an issue. 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.
+1107 -1037
View File
File diff suppressed because it is too large Load Diff
+146 -129
View File
@@ -1,129 +1,146 @@
#!/bin/bash #!/usr/bin/env bash
set -e set -e
RED='\033[0;31m' RED='\033[0;31m'
GREEN='\033[0;32m' GREEN='\033[0;32m'
ORANGE='\033[0;33m' ORANGE='\033[0;33m'
NC='\033[0m' NC='\033[0m'
DESTINATION_PATH="/usr/local/bin" DESTINATION_PATH="/usr/local/bin"
SCRIPT_NAME="h2mm" SCRIPT_NAME="h2mm"
REPO_URL="https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master" REPO_URL="https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master"
if [ "$(id -u)" -eq 0 ]; then if [ "$(id -u)" -eq 0 ]; then
echo "Run me as normal user, not as root." echo "Run me as normal user, not as root."
exit 1 exit 1
fi fi
# --- Main --- # --- Main ---
# Warning # Warning
echo -e "!!! ${RED}WARNING${NC} !!!" 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 "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 "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 "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 "https://github.com/v4n00/h2mm-cli"
echo -e "!!! ${RED}WARNING${NC} !!!" echo -e "!!! ${RED}WARNING${NC} !!!"
echo echo
# Check if update # Check if update
# Breaking changes hash table # Breaking changes hash table
breaking_changes_patches=( breaking_changes_patches=(
["2"]='sed -i "s/^\([0-9]\+\),/\1,ENABLED,/" "$1/mods.csv"' ["2"]='sed -i "s/^\([0-9]\+\),/\1,ENABLED,/" "$1/mods.csv"'
["3"]='sed -i "1 i\\3" "$1/mods.csv"' ["3"]='sed -i "1 i\\3" "$1/mods.csv"'
) )
# Handle breaking changes # Handle breaking changes
if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then
installed_version=$($SCRIPT_NAME --version) 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 # 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"; } [[ ${installed_version:0:1} != "0" ]] && { installed_version="0.1.6"; }
latest_version=$(curl -sS "$REPO_URL"/version) latest_version=$(curl -sS "$REPO_URL"/version)
if [[ "$latest_version" == "$installed_version" ]]; then if [[ "$latest_version" == "$installed_version" ]]; then
echo -e "You are reinstalling version $installed_version." echo -e "You are reinstalling version $installed_version."
else else
echo -e "You are upgrading from ${ORANGE}$installed_version${NC} -> ${GREEN}$latest_version${NC}." echo -e "You are upgrading from ${ORANGE}$installed_version${NC} -> ${GREEN}$latest_version${NC}."
fi fi
# split version numbers # split version numbers
installed_major="" installed_major=""
latest_major="" latest_major=""
IFS='.' read -r _1 installed_major _2 <<< "$installed_version" IFS='.' read -r _1 installed_major _2 <<< "$installed_version"
IFS='.' read -r _1 latest_major _2 <<< "$latest_version" IFS='.' read -r _1 latest_major _2 <<< "$latest_version"
if [[ $latest_major -gt $installed_major ]]; then if [[ $latest_major -gt $installed_major ]]; then
echo -e "${ORANGE}Warning:${NC} Major version upgrade detected." echo -e "${ORANGE}Warning:${NC} Major version upgrade detected."
echo "Check out the changelogs here:" echo "${ORANGE}Info${NC}: Check out the changelogs here -> https://github.com/v4n00/h2mm-cli/releases"
echo "https://github.com/v4n00/h2mm-cli/releases" echo "The script will proceed to upgrade ${SCRIPT_NAME} to avoid breaking changes."
echo "The script will proceed to upgrade ${SCRIPT_NAME} to avoid breaking changes."
# find hd2 path
# find hd2 path search_dir="${HOME}"
search_dir="${HOME}" target_dir="Steam/steamapps/common/Helldivers\ 2/data"
target_dir="Steam/steamapps/common/Helldivers\ 2/data" echo "Searching for the Helldivers 2 data directory... (20 seconds timeout)" >&2
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)
game_dir=$(timeout 20 find "$search_dir" -type d -path "*/$target_dir" 2>/dev/null | head -n 1) if [[ -z "$game_dir" ]]; then
if [[ -z "$game_dir" ]]; then echo "Could not find the Helldivers 2 data directory automatically." >&2
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
IFS= read -ep "Please enter the path to the Helldivers 2 data directory: " game_dir if [[ ! -d "$game_dir" ]]; then
if [[ ! -d "$game_dir" ]]; then echo -e "${RED}Error${NC}: Provided path is not a valid directory." >&2
echo -e "${RED}Error${NC}: Provided path is not a valid directory." >&2 exit 1
exit 1 fi
fi fi
fi
[[ ! -f "$game_dir/mods.csv" ]] && { echo -e "${RED}Error:${NC} mods.csv not found in $game_dir."; exit 1; }
[[ ! -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
# make backup of mods in case something goes wrong echo "${ORANGE}V${NC} It is advised to make a backup before proceeding."
echo "Creating a backup of mods.csv." h2mm export
h2mm export
# iterate from installed major number to latest major number
# iterate from installed major number to latest major number for ((i = installed_major + 1; i <= latest_major; i++)); do
for ((i = installed_major + 1; i <= latest_major; i++)); do if [[ -n "${breaking_changes_patches[$i]}" ]]; then
echo -e "Applying breaking changes patch for version $i." eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:")
else
if [[ -n "${breaking_changes_patches[$i]}" ]]; then echo "No breaking changes for version $i."
eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:") fi
else if [[ $? -ne 0 ]]; then
echo "No breaking changes for version $i." echo -ne "${RED}Error:${NC} Failed to apply breaking changes patch for version $i. Do you want to continue? (Y/n): "
fi read -er response
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): " [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; }
read -er response else
echo -e "Breaking changes patch for version ${ORANGE}$i${NC} applied ${GREEN}successfully${NC}."
[[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; } fi
else done
echo -e "Breaking changes patch for version ${ORANGE}$i${NC} applied ${GREEN}successfully${NC}." fi
fi echo
done fi
fi
echo # Install
fi
# if steam deck, set destination path to ~/.local/bin
# Install IFS= read -ep "Are you installing on a Steam Deck? (y/N): " response_sd
if [[ "$response_sd" == "y" || "$response_sd" == "Y" ]]; then
IFS= read -ep "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): " response # steam deck
DESTINATION_PATH="$HOME/.local/bin"
if [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]]; then mkdir -p "$DESTINATION_PATH"
DESTINATION_PATH="$response"
if [[ ! -d "$DESTINATION_PATH" ]]; then # check if ~/.local/bin is in PATH
echo -e "${RED}Error:${NC} Path $DESTINATION_PATH does not exist." if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
exit 1 # add ~/.local/bin to PATH
fi echo -e "${ORANGE}Warning:${NC} Installing the script on a Steam Deck means adding $DESTINATION_PATH to your \$PATH."
fi echo -e "${ORANGE}Warning:${NC} If you're using a different shell, you may need to add it manually."
echo "Installing $SCRIPT_NAME to $DESTINATION_PATH." IFS= read -ep "Do you want to add $DESTINATION_PATH to your \$PATH in ~/.bashrc? (Y/n): " response
sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME" if [[ "$response" == "y" || "$response" = "Y" || -z "$response" ]]; then
sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME" echo "export PATH=\"\$HOME/.local/bin:\$PATH\"" >> "$HOME/.bashrc"
echo -e "${GREEN}Success:${NC} Added $DESTINATION_PATH to your \$PATH in ~/.bashrc."
if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then fi
echo -e "${RED}Error:${NC} Installation failed." fi
exit 1 else
fi # not steam deck
# set another path if needed
echo "Helldivers 2 Mod Manager CLI installed successfully to $DESTINATION_PATH/$SCRIPT_NAME. Use it by running '$SCRIPT_NAME'." IFS= read -ep "Install the script to $DESTINATION_PATH or specify another path (must be included in \$PATH)? (Y/path): " 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; }
fi
fi
echo "Installing $SCRIPT_NAME to $DESTINATION_PATH."
sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME"
sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME"
if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then
echo -e "${RED}Error:${NC} Installation failed."
exit 1
fi
echo "Helldivers 2 Mod Manager CLI installed successfully to $DESTINATION_PATH/$SCRIPT_NAME. Use it by running '$SCRIPT_NAME'."
+1 -1
View File
@@ -1 +1 @@
0.3.0 0.3.5