install
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
install [2019/06/25 22:24] umfdev [Installing UMF for MacOS] |
install [2021/08/06 23:46] (current) umfdev [Installing UMF for MacOS] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ~~NOTOC~~ | ~~NOTOC~~ | ||
| + | ~~Title: Install Guide ~~ | ||
| + | {{tag>Help}} | ||
| <WRAP center round info 100%> | <WRAP center round info 100%> | ||
| **This guide will aid you in the installation of UMF and it's Mods.** | **This guide will aid you in the installation of UMF and it's Mods.** | ||
| \\ | \\ | ||
| If you still struggle with something **after reading** this guide; | If you still struggle with something **after reading** this guide; | ||
| - | * Read [[Troubleshooting]] which covers common issues. | + | * Read **[[Troubleshooting]]** which covers common issues. |
| - | * Read [[antivirus|Anti-Virus Issues]] if your anti-virus software is giving you trouble. | + | * Read **[[antivirus|Anti-Virus Issues]]** if your anti-virus software is giving you trouble. |
| - | * Ask the **<color #22b14c>@Helper</color>** group for help on our [[https://discord.gg/FMrhTnH|Discord]]. | + | * Ask the **<color #22b14c>@Helper</color>** group for help on our **[[https://discord.gg/FMrhTnH|Discord]]**. |
| </WRAP> | </WRAP> | ||
| ---- | ---- | ||
| Line 19: | Line 21: | ||
| **2.** Extract the zip file anywhere and start the **UMF.Installer.exe** by double clicking it. | **2.** Extract the zip file anywhere and start the **UMF.Installer.exe** by double clicking it. | ||
| * If the installer gives you an error, then you are missing .NET 4.7.2. [[https://dotnet.microsoft.com/download/dotnet-framework/net472|Download .NET 4.7.2]] | * If the installer gives you an error, then you are missing .NET 4.7.2. [[https://dotnet.microsoft.com/download/dotnet-framework/net472|Download .NET 4.7.2]] | ||
| - | \\ | + | * {{:installguide_extract.gif?nolink|}} |
| - | {{:installguide_extract.gif?nolink|}} | + | * {{:installguide_uac.png?nolink|}} |
| - | {{:installguide_uac.png?nolink|}} | + | |
| **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | ||
| + | * {{:installguide_started.png?nolink|}} | ||
| + | * {{:installguide_selectdrive.png?nolink|}} | ||
| * Note: If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | * Note: If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | ||
| - | \\ | ||
| - | {{:installguide_started.png?nolink|}} | ||
| - | {{:installguide_selectdrive.png?nolink|}} | ||
| **4.** Select your game from the drop down list and click "Install". | **4.** Select your game from the drop down list and click "Install". | ||
| - | \\ | + | * {{:installguide_selectgame.png?nolink|}} |
| - | {{:installguide_selectgame.png?nolink|}} | + | |
| **5.** Click "Next" and then click "Exit". | **5.** Click "Next" and then click "Exit". | ||
| * You have now installed UMF can can start **[[#Installing Mods for Windows|Installing Mods]]**. | * You have now installed UMF can can start **[[#Installing Mods for Windows|Installing Mods]]**. | ||
| - | \\ | + | * {{:installguide_installed.png?nolink|}} |
| - | {{:installguide_installed.png?nolink|}} | + | * {{:installguide_exit.png?nolink|}} |
| - | {{:installguide_exit.png?nolink|}} | + | |
| **6.** **(OPTIONAL)** Install the latest Mono for Windows: **[[https://www.mono-project.com/download/stable/#download-win|Mono for Windows]]** | **6.** **(OPTIONAL)** Install the latest Mono for Windows: **[[https://www.mono-project.com/download/stable/#download-win|Mono for Windows]]** | ||
| Line 54: | Line 51: | ||
| **1.** Find a mod that you want. | **1.** Find a mod that you want. | ||
| - | \\ | + | * [[https://umodframework.com/mods|Official Mod List]] |
| - | [[https://umodframework.com/mods|Official Mod List]] | + | |
| **<color #22b14c>Automatic Install:</color>** | **<color #22b14c>Automatic Install:</color>** | ||
| Line 62: | Line 58: | ||
| * The first time you will need to set your browser to always open those Install links with UMF. | * The first time you will need to set your browser to always open those Install links with UMF. | ||
| * If there is no Install link then follow the Manual Install steps. | * If there is no Install link then follow the Manual Install steps. | ||
| - | \\ | + | * {{:installguide_uribrowsers.gif?nolink|}} |
| - | {{:installguide_uribrowsers.gif?nolink|}} | + | * {{:installguide_modinstall.png?nolink|}} |
| - | {{:installguide_modinstall.png?nolink|}} | + | |
| Line 73: | Line 68: | ||
| **3.** Drag and drop the mod into the Mods folder of UMF. (You can find a shortcut to the Mods folder on your desktop.) | **3.** Drag and drop the mod into the Mods folder of UMF. (You can find a shortcut to the Mods folder on your desktop.) | ||
| * If the mod is in a zip file you **should __not__ extract** it, UMF will do this for you. | * If the mod is in a zip file you **should __not__ extract** it, UMF will do this for you. | ||
| + | \\ | ||
| ---- | ---- | ||
| Line 106: | Line 101: | ||
| **2.** Extract the zip file anywhere and start the **UMF.Installer(.desktop)** by double clicking it. | **2.** Extract the zip file anywhere and start the **UMF.Installer(.desktop)** by double clicking it. | ||
| * If you do not have mono you will be taken to a download page for mono. | * If you do not have mono you will be taken to a download page for mono. | ||
| - | * You can alternatively install the ''mono-complete'' package through a repository. | + | * You can alternatively install the ''mono-complete'' package through a repository, but note that most distros use a very outdated package of mono which may not work. |
| - | \\ | + | /* * {{:installguide_linux_extract.gif?nolink|}} |
| - | {{:installguide_linux_extract.gif?nolink|}} | + | * {{:installguide_linux_chmod.png?nolink|}}*/ |
| - | {{:installguide_linux_chmod.png?nolink|}} | + | |
| **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | ||
| * Note: If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | * Note: If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | ||
| - | \\ | + | /* * {{:installguide_linux_started.png?nolink|}} |
| - | {{:installguide_linux_started.png?nolink|}} | + | * {{:installguide_linux_selectdrive.png?nolink|}}*/ |
| - | {{:installguide_linux_selectdrive.png?nolink|}} | + | |
| **4.** Select your game from the drop down list and click "Install". | **4.** Select your game from the drop down list and click "Install". | ||
| - | \\ | + | /* * {{:installguide_linux_selectgame.png?nolink|}}*/ |
| - | {{:installguide_linux_selectgame.png?nolink|}} | + | |
| **5.** Click "Next" and then click "Exit". | **5.** Click "Next" and then click "Exit". | ||
| * You have now installed UMF can can start **[[#Installing Mods for Linux|Installing Mods]]**. | * You have now installed UMF can can start **[[#Installing Mods for Linux|Installing Mods]]**. | ||
| - | \\ | + | /* * {{:installguide_linux_installed.png?nolink|}} |
| - | {{:installguide_linux_installed.png?nolink|}} | + | * {{:installguide_linux_exit.png?nolink|}}*/ |
| - | {{:installguide_linux_exit.png?nolink|}} | + | |
| ---- | ---- | ||
| + | \\ | ||
| + | \\ | ||
| + | |||
| + | |||
| + | ===== Command line Linux ===== | ||
| + | If you have issues with the GUI Installer you can also install UMF using a Terminal. | ||
| + | - Download the latest version of [[https://www.mono-project.com/download/stable/#download-lin|Mono]] and install it. | ||
| + | - [[https://umodframework.com/download|Download UMF]] | ||
| + | - Extract the zip file and place the UMF.Installer folder on your desktop. | ||
| + | - Open a **Terminal**. | ||
| + | - Use the ''**-install "/PATH/TO/GAME/FOLDER/"**'' parameter to install. | ||
| + | * **<color #00a2e8>Path Example:</color>**\\ ''cd ~ && cd "/Desktop/UMF.Installer/" && mono UMF.Installer.exe -install **"/PATH/TO/GAME/FOLDER/"**'' | ||
| + | - Some users may need to also use ''chmod -R +rwx **"/PATH/TO/GAME/FOLDER/"**'' in order to give full permissions. | ||
| + | \\ | ||
| + | ---- | ||
| \\ | \\ | ||
| \\ | \\ | ||
| Line 137: | Line 143: | ||
| **1.** Find a mod that you want. | **1.** Find a mod that you want. | ||
| - | \\ | + | * [[https://umodframework.com/mods|Official Mod List]] |
| - | [[https://umodframework.com/mods|Official Mod List]] | + | |
| <del>**<color #22b14c>Automatic Install:</color>**</del> **<color #ed1c24>(Not yet available for Linux)</color>** | <del>**<color #22b14c>Automatic Install:</color>**</del> **<color #ed1c24>(Not yet available for Linux)</color>** | ||
| Line 145: | Line 150: | ||
| * <del>The first time you will need to set your browser to always open those Install links with UMF.</del> | * <del>The first time you will need to set your browser to always open those Install links with UMF.</del> | ||
| * <del>If there is no Install link then follow the Manual Install steps.</del> | * <del>If there is no Install link then follow the Manual Install steps.</del> | ||
| - | \\ | + | /* * {{:installguide_linux_uribrowsers.gif?nolink|}} |
| - | {{:installguide_linux_uribrowsers.gif?nolink|}} | + | * {{:installguide_linux_modinstall.png?nolink|}}*/ |
| - | {{:installguide_linux_modinstall.png?nolink|}} | + | |
| Line 176: | Line 180: | ||
| ====== Installing UMF for MacOS ====== | ====== Installing UMF for MacOS ====== | ||
| + | **<color #ed1c24>Warning: The graphical installer is currently not working for MacOS.\\ | ||
| + | Please install using the [[#command_line_macos|Command Line]] instead.</color>** | ||
| - | **1.** **[[https://umodframework.com/download|Download UMF]]** | + | **1.** **[[https://umodframework.com/beta?os=macos|Download UMF]]** |
| **2.** Extract the zip file to your ''Desktop'' and start the **UMF.Installer(.app)** by double clicking it. | **2.** Extract the zip file to your ''Desktop'' and start the **UMF.Installer(.app)** by double clicking it. | ||
| * In your Security & Privacy panel you may need to choose ''Open Anyway'' for the UMF.Installer. | * In your Security & Privacy panel you may need to choose ''Open Anyway'' for the UMF.Installer. | ||
| + | * If you do not get ''Open Anyway'' you will need to change the options in your Security & Privacy panel. | ||
| * If you do not have mono you will be taken to a download page for mono. | * If you do not have mono you will be taken to a download page for mono. | ||
| * You may need to restart your computer for the changes to take effect. | * You may need to restart your computer for the changes to take effect. | ||
| - | \\ | + | * {{:installguide_macosx_openanyway.png?nolink&600|}} |
| - | {{:installguide_macosx_openanyway.png?nolink&600|}} | + | * {{:installguide_macos_uac.png?nolink&600|}} |
| - | {{:installguide_macos_uac.png?nolink&600|}} | + | |
| **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | **3.** Click Next and Select the drive your game is installed on, then click "Scan for Game Folders". | ||
| * If mouse input is not working for you, you can use Tab, Arrow Keys, and Enter to select. (Don't buy a Mac next time.) | * If mouse input is not working for you, you can use Tab, Arrow Keys, and Enter to select. (Don't buy a Mac next time.) | ||
| * If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | * If you know where your game is installed you can click "Select a Game Folder Manually" instead of using scan to find it. | ||
| - | \\ | + | /* * {{:installguide_macos_started.png?nolink|}} |
| - | {{:installguide_macos_started.png?nolink|}} | + | * {{:installguide_macos_selectdrive.png?nolink|}}*/ |
| - | {{:installguide_macos_selectdrive.png?nolink|}} | + | |
| **4.** Select your game from the drop down list and click "Install". | **4.** Select your game from the drop down list and click "Install". | ||
| - | \\ | + | /* * {{:installguide_macos_selectgame.png?nolink|}}*/ |
| - | {{:installguide_macos_selectgame.png?nolink|}} | + | |
| **5.** Click "Next" and then click "Exit". | **5.** Click "Next" and then click "Exit". | ||
| * You have now installed UMF can can start **[[#Installing Mods for MacOS|Installing Mods]]**. | * You have now installed UMF can can start **[[#Installing Mods for MacOS|Installing Mods]]**. | ||
| + | /* * {{:installguide_macos_installed.png?nolink|}} | ||
| + | * {{:installguide_macos_exit.png?nolink|}}*/ | ||
| + | |||
| \\ | \\ | ||
| - | {{:installguide_macos_installed.png?nolink|}} | ||
| - | {{:installguide_macos_exit.png?nolink|}} | ||
| + | ===== Command line MacOS ===== | ||
| + | If you have issues with the GUI Installer you can also install UMF using a Terminal. | ||
| + | - Download the latest version of [[https://www.mono-project.com/download/stable/#download-mac|Mono]] and install it. | ||
| + | - [[https://umodframework.com/beta|Download UMF]] | ||
| + | - Extract the zip file and place the UMF.Installer(.app) on your desktop. | ||
| + | - Open a **Terminal**. | ||
| + | - Use the ''**-install /PATH/TO/GAME/FOLDER/**'' parameter to install. | ||
| + | * **<color #00a2e8>Path Example:</color>**\\ ''cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install **/PATH/TO/GAME/FOLDER/**'' | ||
| + | * **<color #00a2e8>Default Slime Rancher Steam Example:</color>**\\ ''cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install ~/Library/Application\ Support/Steam/steamapps/common/Slime\ Rancher/'' | ||
| + | * **<color #00a2e8>Default Slime Rancher Epic Example:</color>**\\ ''cd ~/Desktop/UMF.Installer.app/Contents/MacOS/ && mono UMF.Installer.exe -install /Users/Shared/Epic\ Games/SlimeRancher/''\\ | ||
| + | - Some users may need to also use ''chmod -R +rwx **/PATH/TO/GAME/FOLDER/**'' in order to give full permissions. | ||
| + | \\ | ||
| ---- | ---- | ||
| Line 214: | Line 231: | ||
| **1.** Find a mod that you want. | **1.** Find a mod that you want. | ||
| - | \\ | + | * [[https://umodframework.com/mods|Official Mod List]] |
| - | [[https://umodframework.com/mods|Official Mod List]] | + | |
| <del>**<color #22b14c>Automatic Install:</color>**</del> **<color #ed1c24>(Not yet available for MacOS)</color>** | <del>**<color #22b14c>Automatic Install:</color>**</del> **<color #ed1c24>(Not yet available for MacOS)</color>** | ||
| Line 222: | Line 238: | ||
| * <del>The first time you will need to set your browser to always open those Install links with UMF.</del> | * <del>The first time you will need to set your browser to always open those Install links with UMF.</del> | ||
| * <del>If there is no Install link then follow the Manual Install steps.</del> | * <del>If there is no Install link then follow the Manual Install steps.</del> | ||
| - | \\ | + | /* * {{:installguide_macos_uribrowsers.gif?nolink|}} |
| - | {{:installguide_macosx_uribrowsers.gif?nolink|}} | + | * {{:installguide_macos_modinstall.png?nolink|}}*/ |
| - | {{:installguide_macosx_modinstall.png?nolink|}} | + | |
install.1561497855.txt.gz · Last modified: 2019/06/25 22:24 by umfdev