Jump to content

Modding:Installing SMAPI on Android: Difference between revisions

From Stardew Valley Wiki
← Older edit
imported>Pathoschild
copyedit, clarify risks of downloading third-party SDK, mention SMAPI mods, minor changes
imported>FreddyKun
No edit summary
 
(82 intermediate revisions by 18 users not shown)
Line 1: Line 1:
← [[Modding:Index]]
{{modding player guide header}}


This page explains how to use mods on Android. Modding on Android is trickier than PC; you can't use SMAPI mods yet and they're more complex to install.
This page explains how to install SMAPI (the tool which lets you use mods) on Android.


For help with mods on Linux/Mac/Windows, see the [https://stardewvalleywiki.com/Modding:Player_Guide player's guide to mods].
See instructions for: [[Modding:Installing SMAPI on Linux|Linux]] • [[Modding:Installing SMAPI on Mac|macOS]] • [[Modding:Installing SMAPI on Steam Deck|Steam Deck]] • [[Modding:Installing SMAPI on Windows|Windows]].


==Obtaining the APK==
__TOC__
The game is stored on your phone in an ''Android Package'' file with an <tt>.apk</tt> extension. Downloading the APK from third-party websites isn't recommended, since they may contain malware or be outdated. You can take it directly from your device if you have root access, located at <tt>/data/app/com.chucklefish.stardewvalley-1/base.apk</tt>.


==SMAPI / Content Patcher mods==
==Install==
These aren't available on Android yet. See [https://github.com/Pathoschild/SMAPI/issues/632 ''SMAPI on other platforms''] for more info.
===Minimum requirements===
* This requires Stardew Valley 1.6.15.1 or later, from either the Play Store or the Galaxy Store.


==XNB mods==
* SMAPI required 64 bit OS (32 bit OS are not compatible).
# Install an unzip program like [https://www.7-zip.org/download.html 7-zip].
# Install JDK 8.
# Install Android Studio (make sure to install build-tools).
# Install APK Signer Tool (v2).
# Unzip the Stardew Valley APK to your computer.
# Replace the vanilla XNBs (found in <tt>./assets/Content/</tt>) with the modded XNBs.
# Re-zip the contents of the Stardew Valley APK. Make sure not to include the container folder.
# Change the file extension from <tt>.zip</tt> to <tt>.apk</tt>.
# Open APK Signer Tool (v2).
# Fill out all fields on the Keyfile Generator page (doesn't matter what you enter).
# On the Align & Sign tab, select the modded APK file.
# Select key and fill out the appropriate fields.
# Click Align and Sign.
# Wait a few moments.
# Move the APK to the device and install.


==Audio mods==
===Install SMAPI===
# Download [https://github.com/mariodon/unxwb/releases unxwb] and [https://github.com/Microsoft/DirectXTK/releases XWBTool].
<div style="border: 1px solid #F96; border-left: 1em solid #F96; padding: 0.5em 1em; border-radius: 5px;">
# Unzip both to your working directory.
'''SMAPI on Android is still experimental. Some mods don't work yet; this may be addressed with upcoming SMAPI updates on Android.'''
# Copy the <tt>.obb</tt> file from your phone's internal storage (located at <tt>Internal Storage/Android/obb/main.2.com.chucklefish.stardewvalley.obb</tt>) to your working directory.
</div>
# Run this command to unpack the file: <pre>unxwb main.2.com.chucklefish.stardewvalley.obb</pre> That will output 87 with names like <tt>00000000.wav</tt>.
# Move the unpacked <tt>.wav</tt> files to a separate folder to keep things organised.
# Replace any of the audio files as desired (but the names must remain the same).
# Run this command to repack the file (replacing <tt>folderPath</tt> with the full path to the folder containing the <tt>.wav</tt> files): <pre>XWBTool "folderPath/*.wav" -o Music.xwb</pre> Note that the output file ''must'' be called <tt>Music.xwb</tt> when repacking.
# Rename <tt>Music.xwb</tt> to <tt>main.2.com.chucklefish.stardewvalley.obb</tt>.
# Move the modified <tt>.obb</tt> file back to your phone's internal storage (at <tt>Internal Storage/Android/obb/main.2.com.chucklefish.stardewvalley.obb</tt>).
# Enjoy your modified music!


Here's [https://docs.google.com/spreadsheets/d/1K3S8YDS4Tfe_LPtyXA9LaVM8edxvDFkwfNl-ql1kFGM a spreadsheet of unpacked <tt>.wav</tt> file names].
# {{github|NRTnarathip/SMAPILoader/releases|Download the SMAPI Launcher APK}} (the file that looks like <code>SMAPI.Launcher.vx.x.x.apk</code>).
# [https://www.greenbot.com/article/2452614/how-to-sideload-an-app-onto-your-android-phone-or-tablet.html Install the APK on your phone].
# {{nexus mod|44436|Download SMAPI}}.
# Open the SMAPI Launcher app.
# Click the "Install SMAPI From Zip" button.
# Choose the downloaded SMAPI file.
# Wait until the launcher says it successfully installed SMAPI.
# Click "Start Game" to run the game with mods.
 
If you need help, see [[#help|''Where can I ask for help specific to Android?'']] below.
 
==Update==
Just follow the [[#Install|install steps]] again; the installer will automatically clean up previous versions.
 
==Uninstall==
# 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==
===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.
 
===Where can I ask for help specific to Android?<span id="help"></span>===
See {{github|NRTnarathip/SMAPILoader/wiki/How-To-Install-SMAPI|SMAPI on Android's tutorial}}, which includes a link to the SMAPI-on-Android Discord where you can get help.
 
===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 which 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?===
The Android version of the game is a bit different from other platforms, and the latest version of SMAPI isn't always available on Android.
 
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":
## change the sort to "Date Uploaded" and "Desc";
## try the latest file which says it's for Android, ''or'' says it's for your SMAPI version or earlier.
# Else do the same under "Old Files" (if present).
# Else check the archived files (if any):
## If there's a "File Archive" button at the bottom of the page, click it.
## 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.
 
===Who ported SMAPI to Android?===
SMAPI on Android was originally ported by {{github|MartyrPher|MartyrPher}} for Stardew Valley 1.4.''x'', updated and improved by {{github|ZaneYork|ZaneYork}} for Stardew Valley 1.5.''x'', and then updated and improved by {{github|NRTnarathip|NRTnarathip}} for Stardew Valley 1.6.''x''. Each update builds on the last (e.g. NRTnarathip's version continues from the work by MartyrPher and ZaneYork).
 
{{Modding guide footer
  |prev = [[Modding:Player Guide/Getting Started|Getting Started]]
  |next =
}}


[[Category:Modding]]
[[Category:Modding]]
[[es:Modding:Instalar SMAPI en Android]]
[[ru:Модификации:Установка SMAPI на Android]]
[[tr:Modlama:Android'de SMAPI İndirme]]
[[zh:模组:在Android上安装SMAPI]]

Latest revision as of 08:41, 25 July 2026

← 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

Minimum requirements

  • This requires Stardew Valley 1.6.15.1 or later, from either the Play Store or the Galaxy Store.
  • SMAPI required 64 bit OS (32 bit OS are not compatible).

Install SMAPI

SMAPI on Android is still experimental. Some mods don't work yet; this may be addressed with upcoming SMAPI updates on Android.

  1. Download the SMAPI Launcher APK (the file that looks like SMAPI.Launcher.vx.x.x.apk).
  2. Install the APK on your phone.
  3. Download SMAPI.
  4. Open the SMAPI Launcher app.
  5. Click the "Install SMAPI From Zip" button.
  6. Choose the downloaded SMAPI file.
  7. Wait until the launcher says it successfully installed SMAPI.
  8. Click "Start Game" to run the game with mods.

If you need help, see Where can I ask for help specific to Android? below.

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.

Where can I ask for help specific to Android?

See SMAPI on Android's tutorial, which includes a link to the SMAPI-on-Android Discord where you can get help.

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 which 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?

The Android version of the game is a bit different from other platforms, and the latest version of SMAPI isn't always available on Android.

Here's how to find a compatible version for most mods:

  1. Try the latest version.
  2. From the Nexus mod page, click the Files tab to find all available versions.
  3. Under "Main Files" and "Optional Files":
    1. change the sort to "Date Uploaded" and "Desc";
    2. try the latest file which says it's for Android, or says it's for your SMAPI version or earlier.
  4. Else do the same under "Old Files" (if present).
  5. Else check the archived files (if any):
    1. If there's a "File Archive" button at the bottom of the page, click it.
    2. Try the latest file which matches the rules from step 3. (You can use this script to add download links.)
  6. If you didn't find a matching file, try checking the mod comments or posting a new comment there.

Who ported SMAPI to Android?

SMAPI on Android was originally ported by MartyrPher for Stardew Valley 1.4.x, updated and improved by ZaneYork for Stardew Valley 1.5.x, and then updated and improved by NRTnarathip for Stardew Valley 1.6.x. Each update builds on the last (e.g. NRTnarathip's version continues from the work by MartyrPher and ZaneYork).

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