JustAnyone/h2mm-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: whitespace, version bump for earlier commit

Browse Source
This commit is contained in:
v4n
2025-02-06 20:12:27 +02:00
parent 9f592e7ce2
commit c74f4a8a00
5 changed files with 184 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+6 -6
View File
@@ -1,6 +1,6 @@
* *
!h2mm !h2mm
!install.sh !install.sh
!README.md !README.md
!version !version
!.editorconfig !.editorconfig
README.md
+164 -164
View File
@@ -1,164 +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 ## Installation
To install 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. Go to <https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh>
1. Right click -> Save page as... 1. Right click -> Save page as...
1. Go to your downloads folders `cd ~/Downloads` 1. Go to your downloads folders `cd ~/Downloads`
1. Give the script execution permissions `chmod +x install.sh` 1. Give the script execution permissions `chmod +x install.sh`
1. Run the script `./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 ```bash
h2mm h2mm
``` ```
### Available commands ### Available commands
- `install` - Install a mod by the file provided (directory, zip, patch). - `install` - Install a mod by the file provided (directory, zip, patch).
- `uninstall` - Uninstall a mod by name (or index). - `uninstall` - Uninstall a mod by name (or index).
- `list` - List all installed mods. - `list` - List all installed mods.
- `enable` - Enable a mod by name (or index). - `enable` - Enable a mod by name (or index).
- `disable` - Disable a mod by name (or index). - `disable` - Disable a mod by name (or index).
- `export` - Export installed mods to a zip file. - `export` - Export installed mods to a zip file.
- `import` - Import mods from a zip file. - `import` - Import mods from a zip file.
- `modpack-create` - Create a modpack from the currently installed mods. - `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 by name (or index).
- `modpack-list` - List all installed modpacks. - `modpack-list` - List all installed modpacks.
- `modpack-delete` - Delete a modpack by name (or index). - `modpack-delete` - Delete a modpack by name (or index).
- `modpack-overwrite` - Overwrite a modpack by name (or index). - `modpack-overwrite` - Overwrite a modpack by name (or index).
- `modpack-reset` - Reset all installed modpacks. - `modpack-reset` - Reset all installed modpacks.
- `reset` - Reset all installed mods. - `update` - Update h2mm to latest version.
- `update` - Update h2mm to latest version. - `reset` - Reset all installed mods.
- `help` - Display this help message. - `help` - Display this help message.
### Basic usage ### Basic usage
#### Install mod(s) #### Install mod(s)
```bash ```bash
h2mm install /path/to/mod.zip h2mm install /path/to/mod.zip
h2mm install /path/to/mod/files h2mm install /path/to/mod/files
h2mm install /path/to/mod.zip /path/to/mod2.zip /path/to/mod/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.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 h2mm install -n "Example mod" mod* # using a wildcard to include all files
``` ```
> [!NOTE] > [!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. > 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 #### Uninstall a mod
```bash ```bash
h2mm uninstall "Example mod" h2mm uninstall "Example mod"
h2mm uninstall -i 1 # uninstall mod with index 1 h2mm uninstall -i 1 # uninstall mod with index 1
``` ```
#### Enable/disable mods #### Enable/disable mods
```bash ```bash
h2mm enable "Example mod" h2mm enable "Example mod"
h2mm enable -i 1 # enable mod with index 1 h2mm enable -i 1 # enable mod with index 1
h2mm disable "Example mod" h2mm disable "Example mod"
h2mm disable -i 1 # disable mod with index 1 h2mm disable -i 1 # disable mod with index 1
``` ```
#### List installed mods #### List installed mods
```bash ```bash
h2mm list h2mm list
``` ```
#### Updating the script #### Updating the script
```bash ```bash
h2mm update h2mm update
``` ```
## Compatibility ## 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. 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: Status of platforms:
- Linux :white_check_mark: - Linux :white_check_mark:
- Steam Deck :white_check_mark: - Steam Deck :white_check_mark:
- Windows - WSL :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`. > 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`.
## Advanced usage ## Advanced usage
### Shortcuts ### Shortcuts
You can use the short form of commands to save some time. The shortcuts are: You can use the short form of commands to save some time. The shortcuts are:
- `i` for `install` - `i` for `install`
- `u` for `uninstall` - `u` for `uninstall`
- `e` for `enable` - `e` for `enable`
- `d` for `disable` - `d` for `disable`
- `l` for `list` - `l` for `list`
- `ex` for `export` - `ex` for `export`
- `im` for `import` - `im` for `import`
- `mc` for `modpack-create` - `mc` for `modpack-create`
- `ms` for `modpack-switch` - `ms` for `modpack-switch`
- `ml` for `modpack-list` - `ml` for `modpack-list`
- `md` for `modpack-delete` - `md` for `modpack-delete`
- `mo` for `modpack-overwrite` - `mo` for `modpack-overwrite`
- `mr` for `modpack-reset` - `mr` for `modpack-reset`
- `r` for `reset` - `up` for `update`
- `up` for `update` - `r` for `reset`
### Modpacks support ### 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. 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 ```bash
h2mm modpack-create "Modpack 1" h2mm modpack-create "Modpack 1"
# install, enable, disable other mods... # install, enable, disable other mods...
h2mm modpack-create "Modpack 2" h2mm modpack-create "Modpack 2"
h2mm modpack-switch "Modpack 1" h2mm modpack-switch "Modpack 1"
``` ```
### Exporting and importing ### 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 archive file (`.tar.gz`) will be saved in the current directory. 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 export modpack1.zip h2mm export modpack1.zip
h2mm import modpack2.zip h2mm import modpack2.zip
``` ```
### Resetting all installed mods ### 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. 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 ```bash
h2mm reset h2mm reset
``` ```
### Database location and details ### 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. 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 ## Contributing
Feel free to contribute to this project by creating a pull request or opening an issue. Feel free to contribute to this project by creating a pull request or opening an issue.
h2mm
+9 -9
View File
@@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
VERSION="0.3.5" VERSION="0.3.6"
# --- Globals --- # --- Globals ---
@@ -121,7 +121,7 @@ function find_game_directory() {
[[ $? -ne 0 ]] && { echo -e "${RED}Error${NC}: Could not save game directory." >&2; exit 1; } [[ $? -ne 0 ]] && { echo -e "${RED}Error${NC}: Could not save game directory." >&2; exit 1; }
echo -e "Game directory ${GREEN}saved${NC}: $game_dir" >&2 echo -e "Game directory ${GREEN}saved${NC}: $game_dir" >&2
# return the directory # return the directory
echo "$game_dir" echo "$game_dir"
} }
@@ -378,7 +378,7 @@ function downgrade_mods() {
[[ $? -ne 0 ]] && { echo -e "${RED}Error${NC}: Could not downgrade mod file $mod." >&2; exit 1; } [[ $? -ne 0 ]] && { echo -e "${RED}Error${NC}: Could not downgrade mod file $mod." >&2; exit 1; }
echo -e "Downgraded ${ORANGE}$mod${NC} to ${GREEN}\$MODS_DIR/$new_patch${NC}." >&2 echo -e "Downgraded ${ORANGE}$mod${NC} to ${GREEN}\$MODS_DIR/$new_patch${NC}." >&2
# save changes in database as well # save changes in database as well
sed -i "s/\(\b$mod\b\)/$new_patch/" "$DB_FILE" sed -i "s/\(\b$mod\b\)/$new_patch/" "$DB_FILE"
fi fi
@@ -459,7 +459,7 @@ function mod_disable() {
# find mod files # find mod files
get_mod_name_and_index get_mod_name_and_index
if [[ "$status" == "DISABLED" ]]; then if [[ "$status" == "DISABLED" ]]; then
echo -e "${RED}Error${NC}: Mod $mod_name is already disabled." >&2 echo -e "${RED}Error${NC}: Mod $mod_name is already disabled." >&2
exit 1 exit 1
@@ -627,7 +627,7 @@ function mod_install() {
mod_install "${mod_zip[0]}" mod_install "${mod_zip[0]}"
mod_zip=("${mod_zip[@]:1}") mod_zip=("${mod_zip[@]:1}")
done done
# extract the zip file and pass it to mod dirs # extract the zip file and pass it to mod dirs
if [[ -n "$mod_zip" ]]; then if [[ -n "$mod_zip" ]]; then
command -v unzip &> /dev/null || { echo -e "${RED}Error${NC}: unzip package is not installed." >&2; exit 1; } command -v unzip &> /dev/null || { echo -e "${RED}Error${NC}: unzip package is not installed." >&2; exit 1; }
@@ -662,7 +662,7 @@ function mod_install() {
mod_name=$(echo "$mod_dir" | sed 's:/*$::' | awk -F/ '{print $NF}' | sed -E 's/-[0-9]+-.*//') mod_name=$(echo "$mod_dir" | sed 's:/*$::' | awk -F/ '{print $NF}' | sed -E 's/-[0-9]+-.*//')
fi fi
fi fi
# verify minimum information required # verify minimum information required
[[ -z "$mod_name" || ${#mod_files[@]} -eq 0 ]] && { echo -e "${RED}Error${NC}: Mod name and files are required." >&2; exit 1; } [[ -z "$mod_name" || ${#mod_files[@]} -eq 0 ]] && { echo -e "${RED}Error${NC}: Mod name and files are required." >&2; exit 1; }
@@ -690,7 +690,7 @@ function mod_install() {
# set patch count for file name if it doesn't exist yet # set patch count for file name if it doesn't exist yet
if [[ -z "${patch_count[$file]+unset}" ]]; then if [[ -z "${patch_count[$file]+unset}" ]]; then
patch_count["$file"]=$count patch_count["$file"]=$count
fi fi
# if the file has an extension (e.g. .stream, .gpu_resources), set the last patch number for the next step # if the file has an extension (e.g. .stream, .gpu_resources), set the last patch number for the next step
patch_count["$base_name"]=$count patch_count["$base_name"]=$count
@@ -702,7 +702,7 @@ function mod_install() {
else else
target_file="${base_name}.patch_${patch_count[$file]}" target_file="${base_name}.patch_${patch_count[$file]}"
fi fi
target_files+=($target_file) target_files+=($target_file)
cp "$file" "$MODS_DIR/$target_file" cp "$file" "$MODS_DIR/$target_file"
@@ -764,7 +764,7 @@ function mod_uninstall() {
# remove entry from database # remove entry from database
sed -i "/^$mod_index,/d" "$DB_FILE" sed -i "/^$mod_index,/d" "$DB_FILE"
echo -e "Mod $mod_name ${ORANGE}uninstalled${NC} successfully." >&2 echo -e "Mod $mod_name ${ORANGE}uninstalled${NC} successfully." >&2
# disable any modpack # disable any modpack
disable_all_modpacks disable_all_modpacks
} }
install.sh
+4 -4
View File
@@ -77,14 +77,14 @@ if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then
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 "${ORANGE}V${NC} It is advised to make a backup before proceeding."
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 if [[ -n "${breaking_changes_patches[$i]}" ]]; then
eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:") eval $(echo "${breaking_changes_patches[$i]}" | sed "s:\$1:$game_dir:")
else else
echo "No breaking changes for version $i." echo "No breaking changes for version $i."
@@ -92,7 +92,7 @@ if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then
if [[ $? -ne 0 ]]; then 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): " echo -ne "${RED}Error:${NC} Failed to apply breaking changes patch for version $i. Do you want to continue? (Y/n): "
read -er response read -er response
[[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; } [[ "$response" != "y" && "$response" != "Y" && -n "$response" ]] && { echo "Exiting. Uninstall the script first the retry the install script."; exit 1; }
else else
echo -e "Breaking changes patch for version ${ORANGE}$i${NC} applied ${GREEN}successfully${NC}." echo -e "Breaking changes patch for version ${ORANGE}$i${NC} applied ${GREEN}successfully${NC}."
@@ -135,7 +135,7 @@ else
fi fi
echo "Installing $SCRIPT_NAME to $DESTINATION_PATH." echo "Installing $SCRIPT_NAME to $DESTINATION_PATH."
sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME" sudo curl "$REPO_URL"/h2mm --output "$DESTINATION_PATH/$SCRIPT_NAME"
sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME" sudo chmod +x "$DESTINATION_PATH/$SCRIPT_NAME"
if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then if [[ ! -x "$(command -v $SCRIPT_NAME)" ]]; then
version
+1 -1
View File
@@ -1 +1 @@
0.3.5 0.3.6