Ludeon Forums

Ludeon Forums

  • July 04, 2022, 05:01:57 PM
  • Welcome, Guest
Please login or register.

Login with username, password and session length
Advanced search  

Author Topic: [TOOL] RMM: Spoon's Open Source Mod Manager for Linux  (Read 2198 times)

spoons

  • Muffalo
  • *
  • Posts: 3
  • Refugee
    • View Profile
[TOOL] RMM: Spoon's Open Source Mod Manager for Linux
« on: October 11, 2021, 11:27:15 PM »

RMM is an open source RimWorld mod manager designed primarily for Linux. It is effectively APT or Pacman for RimWorld. However, it is not affiliated with those projects.

RMM allows you to easily download, update, and synchronize your mods with the Steam Workshop while maintaining anonymous login. The intention behind its creation was to provide an easy modding experience for the GOG version of the game.

RMM has no internal database, minimal dependencies, and will happily work along side other mod managing tools such as Steam Workshop subscriptions and Rimpy.

I highly suggest using this tool in conjunction with Fluffy's Mod Manager. RMM should work on MacOS and WSL, although it has not been tested for that. It does work with the Windows version in Wine. However, you need to point RMM_PATH to the 'Mods' folder specifically for this use case.

I am open to feedback on this program and will take any input into consideration. As I continue development of this tool, I intend to expand its capabilities. All features mentioned below are implemented and tested. When you encounter an issue, create a ticket on the github repo describing the issue or leave a comment here and I'll take a look. There is additional documentation in the Github repo which I recommend reading it. Ideally, you will find the tool intuitive to use.


Demo
https://asciinema.org/a/s0mgvwuwE9pi1bP2AXyLas52F

Requirements
  • Steamcmd is installed on your system and available via the PATH shell variable.
  • Unix like platform with Python 3.8 or greater.

Installation
Code: [Select]
# install from pypi
python3 -m pip install --user rmm-spoons
# set path to game directory
echo 'export RMM_PATH="$HOME/GOG\ Games/RimWorld"' >> ~/.bashrc
# optional: add "~/.local/bin" to your PATH
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc

If the 'rmm' command is not available after installation, you probably do not have the pip bin directory on your PATH variable. You can follow the third step above to add it, if you use bash.

Additionally, you can always access RMM through 'python -m rmm'

Notice
This is alpha software. It comes with no warranty and should be used with discretion.

License
GPLv3

Useage
Code: [Select]
The available commands are:
    backup      Creates an archive of the package library
    export      Saves package library state to a file
    list        List installed packages
    remove      Removes a package or modlist
    search      Searches the workshop for mod
    sync        Installs a package or modlist
    update      Update all packages
    query       Search for a locally installed mod

List installed packages
rmm list

Search workshop packages
rmm search modname

Search locally installed mods
rmm query modname

Install package
rmm sync rimhud

Removing a package
rmm remove fuzzy

Saving a mod list
rmm export ~/modlist.txt

Install mod list
rmm sync -f ~/modlist.txt

Update all packages
rmm update

Backup mod directory
rmm backup ~/rimworld.tar

Source
https://github.com/spoons/rmm

License
GPLv3
« Last Edit: October 18, 2021, 06:02:38 PM by spoons »
Logged

spoons

  • Muffalo
  • *
  • Posts: 3
  • Refugee
    • View Profile
Re: [TOOL] RMM: Spoon's Open Source Mod Manager for Linux
« Reply #1 on: October 14, 2021, 07:56:32 PM »

Road Map
Roughly in order of priority.
  • Complete integration tests
  • CLI code refactor
  • Web UI for workshop browsing
  • Git repo support
  • steamworkshopdownloader.io api backend support

Version History
  • Release of v0.0.3 - Oct 16, 2021
    Adds support for RimWorld installed by Steam
    Adds support for mods installed by Workshop
  • Release of v0.0.2 - Oct 16, 2021
    Fixes issue with mod cache and improves installation logic
  • Published v0.0.1 - Oct 5, 2021
    Released minimum viable product
« Last Edit: October 16, 2021, 11:03:43 PM by spoons »
Logged