{"id":17694380,"url":"https://github.com/foldex/r2mod_cli","last_synced_at":"2025-04-01T06:31:56.961Z","repository":{"id":38380934,"uuid":"298893690","full_name":"Foldex/r2mod_cli","owner":"Foldex","description":"A Risk of Rain 2 Mod Manager in Bash","archived":false,"fork":false,"pushed_at":"2023-07-23T20:24:33.000Z","size":141,"stargazers_count":36,"open_issues_count":4,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-25T09:25:54.982Z","etag":null,"topics":["cli","mod-manager","riskofrain","riskofrain2","ror2"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Foldex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-26T20:22:46.000Z","updated_at":"2024-07-26T19:55:17.000Z","dependencies_parsed_at":"2024-10-24T19:34:34.664Z","dependency_job_id":null,"html_url":"https://github.com/Foldex/r2mod_cli","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foldex%2Fr2mod_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foldex%2Fr2mod_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foldex%2Fr2mod_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foldex%2Fr2mod_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Foldex","download_url":"https://codeload.github.com/Foldex/r2mod_cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222703811,"owners_count":17025840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","mod-manager","riskofrain","riskofrain2","ror2"],"created_at":"2024-10-24T13:48:35.390Z","updated_at":"2024-11-02T11:04:18.196Z","avatar_url":"https://github.com/Foldex.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# r2mod_cli\n\n| [Features](#features) | [Installation](#installation) | [Usage](#usage) | [Changelog](#changelog) |\n|---|---|---|---|\n\nA simple mod manager written in Bash for Linux users.\n\n![Screen](https://raw.githubusercontent.com/Foldex/r2mod_cli/master/img/screen.png)\n\n## Features\n\n- Simple No-Nonsense Usage\n- Setup BepInEx and R2API\n- Install and Update Mods\n- Resolve Dependencies\n- Hold Specific Mods Back from Updating\n- Enable/Disable Mods\n- Edit Mod Configs\n- Check for Updates for itself\n- Supports Importing/Exporting r2modman profile codes\n- Supports Flatpak Steam Installs\n- Tab Completion\n\n## Installation\n\n### AUR\n\nr2mod is available in the Arch AUR as `r2mod_cli`\n\n`yay -S r2mod_cli`\n\n### Flatpak\n\nr2mod is available from flathub as `io.github.Foldex.r2mod`\n\n`flatpak install flathub io.github.Foldex.r2mod`\n\n#### Alias\n\nFlatpak bin [exports](https://wiki.archlinux.org/title/Flatpak#Run_applications) should allow you to run r2mod using `io.github.Foldex.r2mod`.\n\nBut you may wish to set up an alias for easier use.\n\n`alias r2mod=\"flatpak run io.github.Foldex.r2mod\"`\n\n#### Completions\n\nFlatpak does not allow shell completions to be installed in the usual root owned locations.\n\nThe flatpak will install them under user owned directories at runtime instead. \n\nFor ZSH, you may need to add `$HOME/.local/share/zsh/site-functions` to your `$fpath`\n\n### Manual\n\nThe prior methods are preferred, but if you wish to manually install:\n\nExtract the zip and run `sudo make install` inside its directory.\n\n#### Dependencies\n\n##### Arch\n\n`sudo pacman -S curl findutils gawk jq p7zip sed`\n\n##### Fedora\n\n`sudo dnf install curl findutils gawk jq p7zip sed`\n\n##### Ubuntu\n\n`sudo apt-get install curl findutils gawk jq p7zip-full sed`\n\n## Usage\n\n### First Setup\n\nMake sure you have run Risk of Rain 2 beforehand to create the needed directories.\n\nIt is heavily recommended to run `r2mod setup` to create a new install.\n\nSome empty folders will be placed in the `BepInEx/plugins` dir, do not remove them.\n\nThey are used to track updates for certain mods.\n\n#### Custom Install Location\n\nThe default install directories for Steam/Flatpak should automatically be handled.\n\nIf you've installed Risk of Rain 2 to a different location, please export the environment variable\n\n`$R2MOD_INSTALL_DIR` in your bash profile and point it to your install directory:\n\n`export R2MOD_INSTALL_DIR=\"$HOME/custom/dir/Risk of Rain 2\"`\n\n`$R2MOD_COMPAT_DIR` also exists for custom locations of Steam's compatdata directory.\n\n`export R2MOD_COMPAT_DIR=\"$HOME/custom/dir/steamapps/compatdata/632360\"`\n\n##### Flatpak\n\nIf you wish to use a custom install location with the flatpak, you may use overrides or [Flatseal](https://github.com/tchx84/Flatseal) to edit the permissions and environment variables.\n\n- The env vars must be an absolute path, they are literal strings and do not have `~` expansion.\n\n- Do NOT include `Risk of Rain 2` in the `R2MOD_INSTALL_DIR` env path, an issue with flatpak does not allow for spaces in environment variables. Just point up to `steamapps/common`.\n\n- Use `flatpak override --user` if it is a user installed flatpak\n\n``` sh\nflatpak override \\\n--env='R2MOD_INSTALL_DIR=/home/foldex/Games/Steam/SteamLibrary/steamapps/common' \\\n--env='R2MOD_COMPAT_DIR=/home/foldex/Games/Steam/SteamLibrary/steamapps/compatdata/632360' \\\n--filesystem='~/Games/Steam/SteamLibrary/steamapps/common/Risk of Rain 2' \\\n--filesystem='~/Games/Steam/SteamLibrary/steamapps/compatdata/632360' \\\nio.github.Foldex.r2mod\n```\n\n### Command List\n\nAccepts shorthand for command names.\n\n```\nr2mod ch(eck): Check for Script Updates\nr2mod del(ete) ProfileName: Delete Local Profile\nr2mod dis(able) (Mod-Dependency-String): Disable Mods\nr2mod ed(it) ConfigName: Edit Mod Configs\nr2mod en(able) (Mod-Dependency-String): Enable Mods\nr2mod exp(ort) ProfileName: Export r2modman mod profile\nr2mod hol(d): Toggle Mod Updates\nr2mod imp(ort) ProfileCode: Install r2modman mod profile\nr2mod ins(tall) Mod-Dependency-String: Install New Mod\nr2mod li(st) (count|all) : List or Count Installed Mods\nr2mod loa(d) ProfileName: Import Local Profile\nr2mod ref(resh): Force Refresh Package Cache\nr2mod run: Launch Risk of Rain\nr2mod sav(e) ProfileName: Export Local Profile\nr2mod sea(rch): Search for Mods\nr2mod set(up): Install a Fresh BepInEx Setup\nr2mod un(install) Mod-Dependency-String: Uninstall Mod\nr2mod upd(ate): Update All Exisiting Mods\nr2mod ver(sion): Print Version\n```\n\n### Installing a Mod\n\n`r2mod install ontrigger-ItemStatsMod-2.0.0` to install a mod.\n\nIf the version number is left out, the most recent version will be installed.\n\n`r2mod install ontrigger-ItemStatsMod`\n\nMultiple mods can also be installed\n\n`r2mod install ontrigger-ItemStatsMod MagnusMagnuson-BiggerBazaar`\n\n### Uninstalling a Mod\n\nUse `r2mod uninstall ontrigger-ItemStatsMod-2.0.0` to install a mod.\n\nIf the version number is left out, any version of that mod will be uninstalled.\n\n`r2mod uninstall ontrigger-ItemStatsMod`\n\nMultiple mods can also be uninstalled\n\n`r2mod uninstall ontrigger-ItemStatsMod MagnusMagnuson-BiggerBazaar`\n\n### Disabling Mods\n\n`r2mod disable` to disable BepInEx entirely.\n\n`r2mod enable` to re-enable.\n\n`r2mod disable ontrigger-ItemStatsMod-2.0.0` to disable a specific mod.\n\n`r2mod enable ontrigger-ItemStatsMod-2.0.0` to re-enable.\n\n### Listing Installed Mods\n\n`r2mod list` to display installed mods.\n\n`r2mod list all` to display installed mods and disabled mods.\n\n`r2mod list count` to display a count of installed mods.\n\n`r2mod list count all` to display a count of installed mods and disabled mods.\n\n### Editing Configs\n\n`$EDITOR` environment variable is used to determine which editor to use.\n\n`r2mod edit` will open all BepInEx config files in your editor\n\n`r2mod edit name` will open all matching configs (case insensitive, incomplete names are fine)\n\n### Holding\n\nMods can be prevented from being auto updated by running `r2mod hold ModName`.\n\nRun again to remove the hold.\n\n### Updating r2mod\n\nUpdates for r2mod will be automatically checked, but not installed.\n\nIf you manually installed r2mod, updates can be done like any other mod:\n\n`r2mod install Foldex-r2mod_cli`\n\n### Files\n\nAll Files, Old Versions, and Backups can be found in `/tmp/r2mod`\n\n## Changelog\n\n### 1.3.4\n\n- Added completion for fish\n\n### 1.3.3\n\n- Updated ModCode Import/Export to new Thunderstore API\n\n### 1.3.2\n\n- Fix flatpak trying to use sandboxed version of `$XDG_DATA_HOME`\n- Disabled `run` command for flatpak version\n\n### 1.3.1\n\n- Fix for flatpak not allowing env vars to contain spaces\n\n### 1.3.0\n\n- Add r2mod flatpak version support\n- Use jq to validate on package cache update\n- Improved filtering of non-mod files in plugins dir\n- Colorize `list` and `import preview`\n\n### 1.2.2\n\n- Support HookGen including configs\n- Support BepInEx including plugins\n- Fix for trying to install missing Hookgen while API cache did not exist\n\n### 1.2.1\n\n- Fix for BepInEx patchers folder no longer being supplied\n- Now checks for steam folders using `$XDG_DATA_HOME`\n- Improved check for proton override file\n\n### 1.2.0\n\n- Basic profile support\n- Support installing from `ror2mm://` links\n- Remove check for R2API patcher files\n- Ignore deprecated mods in completion \u0026 searches\n\n### 1.1.0\n\n- Dependency Support\n- Disable/Enable Individual Mods\n- Install r2mod updates through r2mod\n- Add HookGenPatcher to default installs\n- Add r2mod to AUR\n\n### 1.0.7\n\n- Support R2API v3\n- Allow Custom Steam Compat Dir\n- Add Completion for `import preview`\n- Fix mod installs with patchers\n- Avoid running update check twice\n\n### 1.0.6\n\n- Fix some mods zips extracting without folders\n- Improved setup logic\n- `list` now uses color=auto\n- Added `list count` command\n- Added `ls` alias\n\n### 1.0.5\n\n- Add Search Command\n- Alias `remove` for uninstall\n- Automatically override winhttp on setup (bgkillas)\n\n### 1.0.4\n\n- Allow Custom Install Locations\n- Improved ZSH Tab Completion\n- Added run Command to Launch Game\n\n### 1.0.3\n\n- Added Hold Command\n- Auto Check for R2Mod Updates\n- Added profile_import preview option\n- Fallback to previous cache if package cache update fails\n\n### 1.0.2\n\n- Added Tab Completion\n\n### 1.0.1\n\n- Fixed Update Check\n\n### 1.0.0\n\n- Initial Release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoldex%2Fr2mod_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoldex%2Fr2mod_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoldex%2Fr2mod_cli/lists"}