Skip to content
Kat edited this page Sep 29, 2024 · 9 revisions

Welcome to the RimSort Wiki

RimSort is currently under active development. Contributors are welcome! If you are interested in helping develop RimSort, read the Development Guide on to get started. This Wiki contains lots of information on how RimSort works under the hood.

For more information on how to run and generally use RimSort, check out the User Guide.

RimSort provides a number of essential mod-managing features, as well as some additional integrations with external tools.

Tip

Get the pre-built releases for your OS from the releases page! Don't download from from Code > Download ZIP unless you know what you are doing as that only downloads the unbuilt source code.

Core features:

  • Automatically sort mod lists with rules derived from mod data, community-submitted rules, and Steam data
  • Clicking on a mod displays detailed information in the mod info panel
  • Drag and drop mods between an Active and Inactive mods list to enable/disable/rearrange mods
  • Import, export, and save mod lists
  • Live view of warnings/errors for mod lists, such as missing dependencies, incompatibilities, load order violations, etc.
  • Search bar to filter for specific mods in big mod lists

Additional features:

  • Internal & external tool integrations, such as:
    • Git integration using GitPython & PyGithub modules
    • Integration with SteamworksPy
      • This is used to interact with Steam client, as well as provide Steam API game launch
    • Log sharing to 0x0.st
    • Mod list sharing with Rentry.co
    • todds DDS encoder
      • Optimize your textures with 3 available presets
    • Steam Browser that allows you to download mods via SteamCMD, as well as Steam client
    • RimSort DB Builder
      • Generate Steam Workshop Database (SteamDB) on the fly. This is compatible with & synonymous to Paladin's RimPy Community Mod Manager Database db.json schema
      • Tools to compare, merge, and publish databases using this tool
    • Rule Editor for configured Community Rules database, as well as User Rules
      • Fully compatible with Paladin's RimPy Community Mod Manager Database communityRules.json schema
      • Tools to compare, merge, and publish databases using this tool
    • Support for creating additional sorting modes (in code)
      • "Alphabetical" sorting algorithm
      • "Topological" sorting algorithm (Default as of v1.0.10)

Frequently Asked Questions

Here are answers/solutions to common questions/solutions

macOS gatekeeper/Windows Defender tells me that RimSort is damaged/unsafe to run/is malware!
  • RimSort is not malware and is safe to use. You can safely override any AV (Anti-virus) detections.

Unfortunately, because RimSort is compiled Python, it has a tendency to trigger false detections, especially for new releases. There are ways for us to mitigate these detections, but it requires expensive code signing certificates. If you are still unsure, you can scan the executable/files using virus total. Typically, there may be a few false detections, but the vast majority of scans will return negative.

For windows defender (WD) specifically, we tend to try and send samples to Microsoft to whitelist the RimSort release if there are any false detections. This process can still take at least a full day, and needs to be repeated every release. Thus, if WD is false flagging RimSort, we still appreciate a quick report, but it should be safe to override WD.

For macOS, we'd require a similar yet separate yearly fee to sign apps on macOS. Mac users can, for now, use this workaround. There is no solution for us on macOS other than paying Apple.

Where are game paths located?
  • We recently moved the game paths to the application settings.
What is todds?
  • Todds is a tool by joseasoler for encoding RimWorld's texture files to a different format, .dds. .dds files consume less memory when loaded without getting noticeably blurrier. For more details on todds, see the todds wiki.
What is the Steam Workshop Database used for?
  • RimSort uses the Steam Workshop Database (Steam DB) for loading mod dependency data that is only available on Steam (the "required items" section). While modders should strive to specify this data also in their mods about.xml, the Steam DB allows RimSort to use a mods Steam data, in addition to its about.xml. For details, see the user guide.
What is the Community Rules Database used for?
  • The Community Rules Database (Community Rules DB / CR DB) is used for getting RimSort to place mods in the correct load order. These rules are found and submitted by the community and then collected for shared use in the CR DB. You can contribute to the CR DB by submitting pull requests on GitHub. For details about the DB, see the user guide.
How do I enable Steam client integration features like Open mod in Steam if I have Steam installed?
  • Go to Settings > Advanced > Enable Steam client integration and check the checkbox.