v4n
71 lines
2.8 KiB
Markdown
71 lines
2.8 KiB
Markdown
# Helldivers 2 Mod Manager CLI
|
|
|
|
## 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
|
|
|
|
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
|
|
bash -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/heads/master/install.sh)"
|
|
```
|
|
|
|
## Usage
|
|
|
|
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 --help
|
|
```
|
|
|
|
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.
|
|
|
|
## 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
|
|
- `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
|
|
|
|
## Examples
|
|
|
|
```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"
|
|
```
|
|
|
|
> 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`.
|
|
|
|
## Nexus Mods integration
|
|
|
|
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.
|
|
|
|
## Contributing
|
|
|
|
Feel free to contribute to this project by creating a pull request or opening an issue.
|