Difference between revisions of "Modding:Installing SMAPI on Android"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎ZaneYork's port: clarify expand label)
(update info (ZaneYork port updated, remove MartyrPher's port which hasn't updated in a long time), rework page for single port, add warning about SDV 1.5)
Line 8: Line 8:
 
__TOC__
 
__TOC__
  
==Choose a port==
+
==Caveats==
The Android version of the game is very custom compared to other platforms, so the official version of SMAPI isn't compatible. There are two unofficial [[wikipedia:Porting|ports]] of SMAPI for Android, by MartyrPher and ZaneYork. They use different installers, but both use MartyrPher's port as a base so mod compatibility should be equivalent. Both support most SMAPI mods and content packs (including framework mods like Content Patcher, Farm Type Manager, Json Assets, and PyTK).
+
* The Android version of the game is very custom compared to other platforms, so '''the official version of SMAPI isn't compatible'''. There's a [[wikipedia:Porting|port]] of SMAPI to Android developed by MartyrPher and later ZaneYork (see {{github|ZaneYork/SMAPI|main source code}} and {{github|ZaneYork/SMAPI-Android-Installer|installer source code}}). It supports most SMAPI mods and content packs (including framework mods like Content Patcher, Farm Type Manager, Json Assets, and PyTK), but some mods may not be compatible.
 +
* '''Stardew Valley 1.5 and SMAPI 3.8 aren't available on Android yet.''' You may need to use older versions of many mods.
  
Generally, you can use whichever port has the newer SMAPI version. When you switch from one port to the other, uninstalling the previous one first is recommended (but there's no need to remove mods).
+
==Install==
 
 
==MartyrPher's port==
 
<div style="border: 1px solid #C00; border-left: 1em solid #C00; padding: 0.5em 1em; border-radius: 5px;">
 
MartyrPher's port is currently out of date, so you should use [[#ZaneYork's port|ZaneYork's port]] instead. (See ''[[#Choose a port|choose a port]]'' above for more info.)
 
</div>
 
<!--
 
 
 
{{collapse|content=&#32;
 
===Install===
 
: ''See also [https://www.youtube.com/watch?v=jOXl6Dmu7wY unofficial video guide].''
 
 
 
# Download the latest installer APK from {{github|MartyrPher/SMAPI-Android-Installer/releases|the unofficial download page}} onto your phone. The APK file is located under the expandable subheading "Assets"—see image on right.[[File:Android_APK_file_location_guide.png|thumb|APK file is underlined in green]] Make sure you get the download that looks like <code>SMAPI-Android-Installer-&lt;version&gt;.apk</code>.
 
# [https://www.greenbot.com/article/2452614/how-to-sideload-an-app-onto-your-android-phone-or-tablet.html Install the APK].
 
# Run the new app to install SMAPI. This may take a while depending on your device (e.g. 21s on a Samsung Galaxy S10, and 1 minute 13s on a Samsung Galaxy S6).
 
# When it's done, you can safely uninstall the installer app.
 
 
 
That's it! Just launch the game to play with mods.
 
 
 
===Update===
 
Just install the new version; the installer will automatically clean up previous versions.
 
 
 
===Uninstall===
 
# Uninstall the SMAPI Stardew Valley app.
 
# Uninstall the SMAPI installer (if you haven't already).
 
# Manually delete the <tt>smapi-internal</tt> folder from the <tt>StardewValley</tt> game folder.
 
 
 
===Using mods===
 
To install mods, just unzip them into the newly-created <tt>StardewValley/Mods</tt> folder. To launch the game with mod support, just run the SMAPI Stardew Valley icon.
 
}}
 
-->
 
 
 
==ZaneYork's port==
 
<div style="border: 1px solid #C00; border-left: 1em solid #C00; padding: 0.5em 1em; border-radius: 5px;">
 
ZaneYork's port broke in Stardew Valley 1.4.5.148 on Android, and unfortunately has not been updated yet.
 
</div>
 
 
 
{{collapse|instructions for older versions of Stardew Valley|content=&#32;
 
===Install===
 
 
# Download the {{github|ZaneYork/SMAPI-Android-Installer/releases|latest installer APK file}} (the file under "Assets" that ends with <tt>.apk</tt>).
 
# Download the {{github|ZaneYork/SMAPI-Android-Installer/releases|latest installer APK file}} (the file under "Assets" that ends with <tt>.apk</tt>).
 
# [https://www.greenbot.com/article/2452614/how-to-sideload-an-app-onto-your-android-phone-or-tablet.html Install the APK on your phone].
 
# [https://www.greenbot.com/article/2452614/how-to-sideload-an-app-onto-your-android-phone-or-tablet.html Install the APK on your phone].
Line 57: Line 20:
 
That's it! Just launch the game to play with mods.
 
That's it! Just launch the game to play with mods.
  
===Update===
+
==Update==
 
Just follow the [[#Install|install steps]] again; the installer will automatically clean up previous versions.
 
Just follow the [[#Install|install steps]] again; the installer will automatically clean up previous versions.
  
===Uninstall===
+
==Uninstall==
 
# Uninstall the SMAPI Stardew Valley app.
 
# Uninstall the SMAPI Stardew Valley app.
 
# Uninstall the SMAPI installer.
 
# Uninstall the SMAPI installer.
 
# Manually delete the <tt>smapi-internal</tt> folder from the <tt>StardewValley</tt> game folder.
 
# Manually delete the <tt>smapi-internal</tt> folder from the <tt>StardewValley</tt> game folder.
  
===Using mods===
+
==Using mods==
 
To install mods, just unzip them into the newly-created <tt>StardewValley/Mods</tt> folder. To launch the game with mod support, just run the SMAPI Stardew Valley icon or tap the floating action button in the installer app.
 
To install mods, just unzip them into the newly-created <tt>StardewValley/Mods</tt> folder. To launch the game with mod support, just run the SMAPI Stardew Valley icon or tap the floating action button in the installer app.
}}
 
  
 
{{Modding guide footer
 
{{Modding guide footer
Line 73: Line 35:
 
   |next =  
 
   |next =  
 
}}
 
}}
 
==See also==
 
* Source code for SMAPI ({{github|MartyrPher/SMAPI/tree/android|MartyrPher}}, {{github|ZaneYork/SMAPI|ZaneYork}}) and the installer ({{github|MartyrPher/SMAPI-Android-Installer|MartyrPher}}, {{github|ZaneYork/SMAPI-Android-Installer|ZaneYork}})
 
  
 
[[Category:Modding]]
 
[[Category:Modding]]
  
 
[[es:Modding:Instalar SMAPI en Android]]
 
[[es:Modding:Instalar SMAPI en Android]]

Revision as of 15:59, 28 January 2021

Modding:Player Guide/header

This page explains how to install SMAPI (the tool which lets you use mods) on Android. See also:

Caveats

  • The Android version of the game is very custom compared to other platforms, so the official version of SMAPI isn't compatible. There's a port of SMAPI to Android developed by MartyrPher and later ZaneYork (see main source code and installer source code). It supports most SMAPI mods and content packs (including framework mods like Content Patcher, Farm Type Manager, Json Assets, and PyTK), but some mods may not be compatible.
  • Stardew Valley 1.5 and SMAPI 3.8 aren't available on Android yet. You may need to use older versions of many mods.

Install

  1. Download the latest installer APK file (the file under "Assets" that ends with .apk).
  2. Install the APK on your phone.
  3. Run the new app to install SMAPI. This may take a while depending on your device (e.g. 21s on a Samsung Galaxy S10, and 1 minute 13s on a Samsung Galaxy S6).
  4. When it's done, you can safely uninstall the installer app.

That's it! Just launch the game to play with mods.

Update

Just follow the install steps again; the installer will automatically clean up previous versions.

Uninstall

  1. Uninstall the SMAPI Stardew Valley app.
  2. Uninstall the SMAPI installer.
  3. Manually delete the smapi-internal folder from the StardewValley game folder.

Using mods

To install mods, just unzip them into the newly-created StardewValley/Mods folder. To launch the game with mod support, just run the SMAPI Stardew Valley icon or tap the floating action button in the installer app.