This is a cross platform mod manager for Hollow Knight.
This specific version of Scarab, Scarab+ is a fork of the "normal" Scarab. It is an updated version of Scarab that exists because there were some major features missing from Scarab that we wanted to add. See changelog for the full list of them.
- Download the latest version from the automatic download link or the releases page.
- Search through and download the mods you like.
- Mods appear in the top left corner of the game title screen after installation.
- Enable/Disable mods from affecting the game using the toggle and update outdated mods using the orange update button.
- If you are unable to connect to the internet, Scarab can be launched in offline mode where you can toggle mods/api.
- Automatically downloads the Modding API which is required for mods to load. It also allows switching between modded and vanilla via the Toggle API button.
- Loads its modlist from the official modlinks but that can be changed by providing a custom modlinks URI in the settings tab or via a command.
- Search through the 300+ mods available and narrow down the search by the mod's tags and authors. Also allows searching through mod descriptions and searching by dependency.
- Display mods that were updated or newly released recently (within the last week/month).
- For mods not in official modlinks, scarab provides a manually install button which can correctly install it.
- Pin mods by right clicking on a mod to ensure scarab never deletes it.
- Share links that run commands in scarab see commands for more info.
- Open a mod's global settings file to edit its settings.
Here are a list of explanations of features that require more information.
Scarab+ allows you to use shareable links to open and run commands in scarab. You can use the commands website to view and create the links.
The main shareable commands that anyone can use.
-
Download Mod: Share links to open Scarab and download mods using this command. Sharing a link such as this will open Scarab and download the mod "Satchel".
-
Custom Modlinks - Open Scarab and load its mod list from a custom modlinks.
Commands that can be used to help fix problems with Scarab or Hollow Knight Mods
- Reset - Opens Scarab and reset its persistent settings. Equivalent to downloading and opening Scarab for the first time.
- Force Update All - Opens Scarab and reinstalls all mods. Could help fix issues that happened because mods are not downloaded correctly.
- Redirect link You can use this link to redirect to any scarab command.
Scarab allows you to search for mods that are dependent or integrated with a specific mod. For example if you want to see Randomizer 4 connections you can search by dependency of randomizer 4 and you will see mods like RandoMapMod, RandoPlus, and BenchRando.
There are currently 4 settings that can be changed in Scarab
- Automatically remove unused dependencies (Default: No) - Do you want scarab to remove mods that are listed as dependencies of mods that are now being uninstalled.
- Warn before removing a dependent mod (Default: Yes) - Do you want scarab to warn before disabling or uninstalling a mod that is listed as a required dependency of an installed and enabled mod which could cause it to not function correctly.
- Use custom modlinks (Default: No) - Do you want Scarab to load its mod list from another source other than the official modlinks. Enabling this will give you the prompt for the custom modlinks URI.
- Game Path - Which install of the game do you want Scarab to modify.
- You can mark a mod as a custom build of the mod by right clicking the mod and clicking on "Register as not in modlinks"
- Pinning a not in modlinks mod ensures Scarab will never automatically replace it.
- To test if you mod installs correctly, create a fork of modlinks and in your fork add your mod's manifest in ModLinks.xml. Then open Scarab and in the settings tab give Scarab the link to the ModLinks.xml and reload Scarab.
If you want to suggest a feature or report a bug, report it on the issues page.
If you want to contribute to Scarab, feel free to. You can see what features are currently requested over here
- #29 - Translate Scarab to more languages
- 56: Original creator of Scarab
- Clazex - Chinese translations
- luiz_eldorado - Portuguese translations
- Dastan - French translations