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

docs: improve (#95)

Browse Source 
* docs: rewrite help commands

* docs: rewrite README.md

* docs: remove you language

* refactor: started parse refactor
This commit is contained in:
v4n
2025-09-29 21:18:54 +03:00
committed by GitHub
parent 687bdf6709
commit 87ec07b10a
4 changed files with 368 additions and 261 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25 -54
View File
@@ -1,15 +1,19 @@
# Helldivers 2 Mod Manager CLI
**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
Pre-requisites:
- You must have the `unzip` package installed for `zip` archives;
- You might want to have the `unarchiver` package installed for `rar` and `7z` archives.
- 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 your terminal:
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)"
@@ -17,13 +21,15 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/v4n00/h2mm-cli/refs/head
## 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 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.
## Available commands
- `install` or `i` - Install a mod by the file provided (directory, zip, patch)
- `uninstall` or `u` - Uninstall a mod
@@ -34,67 +40,32 @@ h2mm
- `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
- `m` or `modpack` - Manage modpacks (collections of mods)
- `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
To find out how to use a command, you can run `h2mm <COMMAND> --help`.
#### Install mod(s)
```bash
h2mm install mod.zip
h2mm install /path/to/mod/directory/
h2mm install /path/to/mod.zip /path/to/mod2.zip /path/to/mod/files # bulk install mods
h2mm install -n "Example mod" mod.patch_0 mod.patch_0.stream # -n to specify name of the mod
```
> It's better to be in the directory where the mod files are located, so you don't have to specify the full path everytime you're installing a mod. Open a terminal and type `cd ~/Downloads` (which will change the directory to your Downloads folder) and then run the install command with just the file names.
>
> 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
## 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 list -v # verbose mode
h2mm uninstall --index 3
h2mm modpack create "Example modpack"
h2mm modpack switch "Example modpack"
```
#### Uninstall a mod
```bash
h2mm uninstall -n "Example mod"
h2mm uninstall -i 3 # by index (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
```
> 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 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.
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