rmm-spoons 0.0.5

A RimWorld Mod Manager

RMM: RimWorld Mod Manager

RMM is an open source RimWorld mod manager designed for Unix systems. RMM uses the SteamCMD binary to download mods.

Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Improvements in this process will follow.

MOD DEVELOPERS PLEASE READ:

When using rmm update, rmm will update all mods in your game path and will overwrite your development folder with the latest version from Steam. To prevent all destructive writes, create a .rmm_ignore file in your Mods directory.

Prerequisites

To use RMM you need:

• SteamCMD installed and in your path.
• [Optional] Set RMM_PATH to game path if game is installed in non default location. Alternative, you can use the -p flag to tell RMM where RimWorld is.

Install SteamCMD

1. A. For Arch Linux, you can install steamcmd using makepkg as stated below:

mkdir -p ~/build ; cd ~/build
git clone https://aur.archlinux.org/steamcmd.git
cd steamcmd
makepkg -si

1. B. Alternatively, you can install it using a 'AUR Helper' such as yay.

yay -S steamcmd

2. Verify steamcmd is correctly installed:

whereis steamcmd

Should return a path such as below. Otherwise check to make sure steamcmd is in your path.

steamcmd: /usr/bin/steamcmd /usr/share/steamcmd

Adding .local/bin to your PATH

RMM can be directly accessed with command rmm. In order for this to work, you need to add ~/.local/bin to your PATH variable, otherwise, your terminal will not find the rmm script. If you notice that you cannot run rmm after installation, try the following:

echo 'export PATH="$PATH:$HOME/.local/bin" >> ~/.bashrc

Alternatively, RMM can always be accessed by

python -m rmm

Set RMM_PATH (Optional)

RMM will first search for the default GOG games installation directory, steamcache folder, before falling back to an error message if this value is not set. This value takes precedence over those defaults. I recommend setting this variable.

1. A. Set RMM_PATH variable to the 'Mods' sub directory in your Rimworld game folder in your .bashrc or .zshrc. For example:

# Note please update this path to your actual game or mod directory
echo 'export RMM_PATH="$HOME/GOG\ Games/RimWorld" >> ~/.bashrc

1. B. Alternatively, you can change this path at runtime. This is useful when managing multiple copies of the games.

export RMM_PATH="~/PATHTOGAME/game/Mods"
rmm list
# or you can use
RMM_PATH="~/PATHTOGAME/game/Mods" rmm list

Set RMM_WORKSHOP_PATH (Optional)

RMM supports managing mods in your Steam Workshop mods directory. If RimWorld is installed into the same library as your workshop mods, RMM will automatically find your workshop mods folder and assign it automatically. If you run rmm list and see, 'workshop path: /workshop/filepath', then you know this is occurring. You typically will not need to set this variable.

echo 'export RMM_WORKSHOP_PATH="$HOME/.local/share/Steam/steamapps/workshop" >> ~/.bashrc

Install from PyPi (Recommended)

python3 -m pip install --user rmm-spoons

Installation for Development

Clone repository and install with setuptools editable mode.

mkdir -p ~/build
git clone https://github.com/Spoons/rmm.git ~/build/rmm
pip install --user ~/build/rmm

Usage

RimWorld Mod Manager

Usage:
  rmm export [options] <file>
  rmm import [options] <file>
  rmm list [options]
  rmm migrate [options]
  rmm query [options] [<term>...]
  rmm remove [options] [<term>...]
  rmm search <term>...
  rmm sync [options] <name>...
  rmm update [options]
  rmm -h | --help
  rmm -v | --version

Operations:
  export            Save mod list to file.
  list              List installed mods.
  migrate           Remove mods from workshop and install locally.
  query             Search installed mods.
  remove            Remove installed mod.
  search            Search Workshop.
  sync              Install mod.

Parameters
  term              Name, author, steamid
  file              File path
  name              Name of mod.

Options:
  -p --path DIR     RimWorld path.
  -w --workshop DIR Workshop Path.

How To

List installed packages:

rmm list

Search workshop packages:

rmm search term

Search locally installed mods

rmm query term

Install package:

rmm sync rimhud

Removing a package:

rmm remove fuzzy

Saving a mod list

rmm export ~/modlist.txt

Install mod list:

rmm import ~/modlist.txt

Update all packages:

rmm update

Backup mod directory:

rmm backup ~/rimworld.tar

Migrate from Steam Workshop to RimWorld 'Mods' folder:

rmm migrate

Tips

Duplicating a mod setup to a new installation:

rmm -p ~/path-to-game export ~/modlist.txt
rmm -p ~/path-to-game import ~/modlist.txt

License

This project is licensed under the GPLv3 License - see the LICENSE file for details