This guide will aid you in the installation of UMF and it's Mods.
If you still struggle with something after reading this guide;


Table of Contents


Installing UMF for Windows

1. Download UMF

2. Extract the zip file anywhere and start the UMF.Installer.exe by double clicking it.

3. Click Next and Select the drive your game is installed on, then click “Scan for Game Folders”.

4. Select your game from the drop down list and click “Install”.

5. Click “Next” and then click “Exit”.

6. (OPTIONAL) Install the latest Mono for Windows: Mono for Windows




Installing Mods for Windows

If the mod you want has a UMF Install link or button you can click that and the mod is automatically downloaded and installed for you.

1. Find a mod that you want.

Automatic Install:
2. Click the Install link or button for the mod.

Manual Install:
2. Download the mod to your computer.

3. Drag and drop the mod into the Mods folder of UMF. (You can find a shortcut to the Mods folder on your desktop.)





Uninstalling UMF for Windows

Windows 10:

  1. Open Apps & Features
  2. Select “UMF (Game Name)”
  3. Click Uninstall

Other Windows Versions:

  1. Open Control Panel
  2. Open Programs & Features
  3. Select “UMF (Game Name)”
  4. Click Uninstall

Alternative:

  1. Open the \Game Folder\uModFramework\ folder in the Game Folder where UMF was installed.
  2. Double click Uninstall.exe



Installing UMF for Linux

1. Download UMF

2. Extract the zip file anywhere and start the UMF.Installer(.desktop) by double clicking it.

3. Click Next and Select the drive your game is installed on, then click “Scan for Game Folders”.

4. Select your game from the drop down list and click “Install”.

5. Click “Next” and then click “Exit”.




Command line Linux

If you have issues with the GUI Installer you can also install UMF using a Terminal.

  1. Download the latest version of Mono and install it.
  2. Extract the zip file and place the UMF.Installer folder on your desktop.
  3. Open a Terminal.
  4. Use the -install “/PATH/TO/GAME/FOLDER/“ parameter to install.
    • Path Example:
      cd ~ && cd ”/Desktop/UMF.Installer/” && mono UMF.Installer.exe -install “/PATH/TO/GAME/FOLDER/“
  5. Some users may need to also use chmod -R +rwx ”/PATH/TO/GAME/FOLDER/“ in order to give full permissions.





Installing Mods for Linux

If the mod you want has a UMF Install link or button you can click that and the mod is automatically downloaded and installed for you.

1. Find a mod that you want.

Automatic Install: (Not yet available for Linux)
2. Click the Install link or button for the mod.

Manual Install:
2. Download the mod to your computer.

3. Drag and drop the mod into the Mods folder of UMF. (You can find a shortcut to the Mods folder on your desktop.)

—-



Uninstalling UMF for Linux

Main:

  1. Open the /Game Folder/uModFramework/ folder in the Game Folder where UMF was installed.
  2. Double click Uninstall(.desktop)

Alternative:

  1. Open a Terminal type cd /Game Folder/uModFramework/ then press enter. (Full path to where UMF is installed.)
  2. Type mono Uninstall.exe and press enter/return.



Installing UMF for MacOS

Warning: The graphical installer is currently not working for MacOS.
Please install using the Command Line instead.

1. Download UMF

2. Extract the zip file to your Desktop and start the UMF.Installer(.app) by double clicking it.

3. Click Next and Select the drive your game is installed on, then click “Scan for Game Folders”.

4. Select your game from the drop down list and click “Install”.

5. Click “Next” and then click “Exit”.


Command line MacOS

If you have issues with the GUI Installer you can also install UMF using a Terminal.

  1. Download the latest version of Mono and install it.
  2. Extract the zip file and place the UMF.Installer(.app) on your desktop.
  3. Open a Terminal.
  4. Use the -install /PATH/TO/GAME/FOLDER/ parameter to install.
    • Path Example:
      cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install /PATH/TO/GAME/FOLDER/
    • Default Slime Rancher Steam Example:
      cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install ~/Library/Application\ Support/Steam/steamapps/common/Slime\ Rancher/
    • Default Slime Rancher Epic Example:
      cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install /Users/Shared/Epic\ Games/SlimeRancher/
  5. Some users may need to also use chmod -R +rwx /PATH/TO/GAME/FOLDER/ in order to give full permissions.





Installing Mods for MacOS

If the mod you want has a UMF Install link or button you can click that and the mod is automatically downloaded and installed for you.

1. Find a mod that you want.

Automatic Install: (Not yet available for MacOS)
2. Click the Install link or button for the mod.

Manual Install:
2. Download the mod to your computer.

3. Drag and drop the mod into the Mods folder of UMF. (You can find a shortcut to the Mods folder on your desktop.)




Uninstalling UMF for MacOS

Main:

  1. Open the /Game Folder/uModFramework/ folder in the Game Folder where UMF was installed.
  2. Double click Uninstall(.app)
  3. In your Security & Privacy panel choose Open Anyway for the Uninstall.app.

Alternative:

  1. Open a Terminal and type cd /Game Folder/uModFramework/ then press enter. (Full path to where UMF is installed.)
  2. Type ''mono Uninstall.exe' and press enter.



Default Controls

These default controls can be changed in the UMF Menu.

Shift + F10	= Open the UMF Menu (Change settings for mods here.)
Shift + ~	= Open the Console (Type help in console for a list of console commands.)
 
Note: ~ (Tilde) is the key above Tab on all keyboards regardless of language.