Jump to content

Modding:Installing SMAPI on Android: Difference between revisions

From Stardew Valley Wiki
← Older editNewer edit →
imported>Pathoschild
→Install: update for the latest Android versions (AOT is no longer enabled on Android)
imported>Pathoschild
revert to docs about the last working version (so it can be updated for the new one)
Line 8: Line 8:


==Install==
==Install==
<div style="border: 1px solid #F66; border-left: 1em solid #F66; padding: 0.5em 1em; border-radius: 5px;">
<div style="border: 1px solid #F96; border-left: 1em solid #F96; padding: 0.5em 1em; border-radius: 5px;">
'''Mods are poorly supported on Android and may be a frustrating experience.'''<br />
'''SMAPI for Stardew Valley 1.5.6 is in alpha testing. Some mods may not work with the latest version of the game yet.'''<br />
To play with mods, Stardew Valley on PC (Linux/macOS/Windows) or Steam Deck is strongly recommended.
You can watch {{github|ZaneYork/SMAPI-Android-Installer/issues/246|this tracking ticket}} to see the latest updates.


The main issues are:
An incomplete list of working/non-working Android mods can be found [https://android.stardew.rocks here].
# SMAPI on Android only works up to [[Mobile Version History#1.5.6.39|Stardew Valley 1.5.6.39]], and hasn't been updated since then. You can't legally download an older version of the game, so you can't get help doing it in any official community (including Discord, Reddit, or the forums).
</div>
# You'll also need older versions of mods compatible with Stardew Valley 1.5.6 (see [[#FAQs|FAQs below]]), and many newer mods won't work.
 
# Even mod versions for Stardew Valley 1.5.6 may not work on Android, due to differences between the Android and PC versions of the game.
'''Note: Because Android SMAPI is still in its testing phases, even the latest release may not work for everyone'''
# Newer Android versions have stricter storage policies which make accessing the files much more difficult.
 
# Reinstalling the game or installing SMAPI will delete your saves, so you need to manually back up and restore them each time.
# Download the {{github|ZaneYork/SMAPI-Android-Installer/releases|latest installer APK file}} (the file under "Assets" that ends with <samp>.apk</samp>).
# [https://www.greenbot.com/article/2452614/how-to-sideload-an-app-onto-your-android-phone-or-tablet.html Install the APK on your phone].
# 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 follow the [[#Install|install steps]] again; the installer will automatically clean up previous versions.


If you really want to use mods on Android, good luck! You can check the {{github|ZaneYork/SMAPI-Android-Installer/issues/246|tracking ticket in the SMAPI for Android repository}} for discussion.
==Uninstall==
</div>
# Uninstall the SMAPI Stardew Valley app.
# Uninstall the SMAPI installer.
# Manually delete the <samp>smapi-internal</samp> folder from the <samp>StardewValley</samp> game folder.


==FAQs==
==FAQs==
===How do I add and use mods?===
Once SMAPI is installed, install mods by unzipping them into the newly-created <samp>StardewValley/Mods</samp> 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.
===Why is there a separate SMAPI for Android?===
===Why is there a separate SMAPI for Android?===
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.
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.
===How do I find the version of a mod which works on Android?===
Since you need to use an older version of the game, you'll need older versions of many mods too. Here's how to find a compatible version for most mods:
# Try the latest version.
# From the Nexus mod page, click the ''Files'' tab to find all available versions.
# Under "Main Files" and "Optional Files", try the latest file which...
#* says it's for Android;
#* ''or'' says it's for Stardew Valley 1.5.6 or earlier;
#* ''or'' says it's for SMAPI 3.7.6 or earlier;
#* ''or'' was uploaded before 19 March 2024.
# Under "Old Files" (if present):
## Change the sort to "Date Uploaded" and "Desc".
## Try the latest file using the rules from step 3.
# Check the archived files (if any):
## If there's a "File Archive" button at the bottom of the page, click it.</li>
## Try the latest file which matches the rules from step 3. (You can [https://github.com/Pathoschild/StardewScripts/tree/main/nexus-download-archived-files use this script to add download links].)
# If you didn't find a matching file, try checking the mod comments or posting a new comment there.
See a [https://android.stardew.rocks very incomplete list of working Android mods].


{{Modding guide footer
{{Modding guide footer

Revision as of 19:03, 24 December 2024

← Modding:Index
Player's guide to using mods

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

See instructions for: Linux • macOS • Steam Deck • Windows.

Install

SMAPI for Stardew Valley 1.5.6 is in alpha testing. Some mods may not work with the latest version of the game yet.
You can watch this tracking ticket to see the latest updates.

An incomplete list of working/non-working Android mods can be found here.

Note: Because Android SMAPI is still in its testing phases, even the latest release may not work for everyone

  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.

FAQs

How do I add and use mods?

Once SMAPI is installed, install mods by unzipping 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.

Why is there a separate SMAPI for Android?

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.

Retrieved from "https://stardew.fastobject.net/index.php?title=Modding:Installing_SMAPI_on_Android&oldid=162907"