User guide for uMod Framework v0.45 (umodframework.com)

If you obtained this copy from anywhere other than umodframework.com,
then it has been distributed illegally and may contain viruses.
You may only use copies you have downloaded from umodframework.com after agreeing to the license.


--- Install Instructions ---
1. Pick a Unity Engine game to install the uMod Framework to.

2. Extract/copy the contents of this zip file to the folder where the game exe/bin is located.
   Examples:
      Windows: C:\Program Files (x86)\Steam\steamapps\common\<your game name>\
      Linux: /home/<user>/Steam/steamapps/common/<your game name>/
      Mac: /Users/<user>/Library/Application Support/Steam/SteamApps/common/<your game name>/
   You should now have a folder called uModFramework inside that folder.
   Inside that folder should be the uModFramework.Setup.exe required for the next step.

3. Run uModFramework.Setup.exe.
   Linux and Mac requires mono to run the setup:
      Mono for Linux: http://www.mono-project.com/download/stable/#download-lin
      Mono for Mac: https://www.mono-project.com/download/stable/#download-mac
      Once mono is installed;
	  3a. Open a terminal and type the following, then press Enter:
	      cd "/path/to/uModFramework/" && chmod +x uModFramework.Setup.mono
		  --- Examples ---
		     (NOTE: Replace 'Slime Rancher' with your game name if it's a different Steam game.)
		     Linux:
			    cd ~ && cd "Steam/steamapps/common/Slime Rancher/uModFramework/" && chmod +x uModFramework.Setup.mono
	         Mac:
                cd ~ && cd "Library/Application Support/Steam/SteamApps/common/Slime Rancher/uModFramework/" && chmod +x uModFramework.Setup.mono

      3b. Double click uModFramework.Setup.mono
	      If that works you can use this method to start the setup from now on.
	      If that does not work, proceed to step 3c.

	  3c. Right click "uModFramework.Setup.mono" and choose Open With > Terminal
	      If that works you can use this method to start the setup from now on.
	      If that does not work, proceed to step 3d.

      3d. Open a terminal and type the following, then press Enter:
          cd "/path/to/uModFramework/" && mono uModFramework.Setup.exe
          mono uModFramework.Setup.exe
          --- Examples ---
		     (NOTE: Replace 'Slime Rancher' with your game name if it's a different Steam game.)
             Linux:
                cd ~ && "Steam/steamapps/common/Slime Rancher/uModFramework/" && mono uModFramework.Setup.exe
             Mac:
                cd ~ && cd "Library/Application Support/Steam/SteamApps/common/Slime Rancher/uModFramework/" && mono uModFramework.Setup.exe

   If you are unable to run uModFramework.Setup.exe:
      1. Check your anti-virus scanner and configure it properly.
	  2. Ensure that you have installed .NET 3.5 and 4.5 (If on Windows) or mono (If on Linux or Mac).
	  3. Check that your user have sufficient admin permissions to run the setup.
	  4. Make sure you actually extracted all the files from the zip file correctly.
	  5. Close the game if you have it open. Close any programs that may be using the game files.
	  6. Restart your computer and try again.
	  7. Read the Troubleshooting Guide here: https://umodframework.com/forums/viewtopic.php?f=4&t=3
	  8. Get professional help from a computer technician.

4. Press 1 and press enter to install the uMod Framework into the game, exit the setup when done.

5. Download a mod for the game. (umodframework.com, Steam Forums, nexusmods.com)

6. Drag and drop the mod into the newly created \<your game name>\uModFramework\Mods\ folder.
   If the mod is in a zip file you do not need to extract it, UMF will do this for you.

7. Start the game and have fun!

Note: If the game the uMod Framework is installed into is updated by you or Steam, you may need to re-install the uMod Framework.


--- Additional Linux & Mac Info for Version 0.45 ---
The following features have not been tested on Linux & Mac and may not work correctly:
- Opening uModFramework.Setup.mono with double click or right click context.
- Automatic UMF updates.
- Automatic MOD updates.

There may be more things that do not work correctly on Linux or Mac.
If you would like to see continued compatability and support for Linux and Mac, please volunteer your self as a tester.


--- Default Controls ---
Shift + F10	= Open the Settings GUI (Change settings for mods here.)
Shift + ~	= Open the Console (Type help in console for a list of console commands.)


--- Uninstall Instructions ---
1. Run uModFramework.Setup with the same method as you used to install it in step 3 of the Install Instructions.
2. Press 2 and press enter to uninstall the uMod Framework from the game, exit the setup when done.
3. Delete the uModFramework folder that you extracted in step 2 of the Install Instructions.


By having downloaded a copy of this software you have agreed to the license found at: https://umodframework.com/download.html
© 2018 umodframework.com. All rights reserved.