Jump to content

Modding:Installing SMAPI on Android: Difference between revisions

From Stardew Valley Wiki
← Older edit
imported>RennyFTW
m line endings are annoying when there's word wrapping
imported>FreddyKun
No edit summary
 
(85 intermediate revisions by 18 users not shown)
Line 1: Line 1:
==Before You Begin==
{{modding player guide header}}
Mod at your own risk, not all mods will be compatible with Android. User has the full responsibility of ensuring they do not cause damage by following this guide.


==Where To Obtain The APK==
This page explains how to install SMAPI (the tool which lets you use mods) on Android.
Unfortunately sourcing the apk from third party websites is not recommended as it can be unsafe and can pose a risk to your device.
However, the apk can be taken directly from your device, providing you have root access. It can be located at <code>/data/app/com.chucklefish.stardewvalley-1/base.apk</code>


==XNB Mods: How To==
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]].
# Install zip program of your choice. Recommended: [https://www.7-zip.org/download.html 7zip].
# Install JDK 8.
# Install Android Studio, make sure to install build-tools.
# Install APK Signer Tool (v2).
# Extract the Stardew Valley apk to your computer with zip program.
# Replace the Vanilla XNBs (found in <code>./assets/Content/</code>) with the Modded XNBs.
# Archive the contents of the Stardew Valley apk with your chosen zip program (Make sure to not archive the folder containing the files, but the files themselves, so the file structure is <code>com.yourchosenapk.name.apk\different files and folders here</code>), rename from .zip to .apk.
# Open APK Signer Tool (v2)
# Fill out all fields in Keyfile Generator page. (Fill as you wish, these aren't important as long as they are filled).
# Click Align & Sign tab. Browse for the modded .apk
# Select key, and fill out appropriate fields
# Click Align and Sign
# Wait a few moments
# Move apk to device and install


==Audio Mods: How To==
__TOC__
{{Stub|section=true}}
 
# Download both <code>unxwb</code> (Link TBU, program created by Luigi Auriemma), and <code>XWBTool</code> (Link TBU, found on Microsoft's GitHub) and extract both of them to your working directory.
==Install==
# Copy over the .obb from your phone's internal storage to your working directory. The OBB can be found at <code>Internal Storage/Android/obb/main.2.com.chucklefish.stardewvalley.obb</code>
===Minimum requirements===
# To unpack simply run <code>unxwb main.2.com.chucklefish.stardewvalley.obb</code> in Command Prompt which should output 87 files named <code>00000000.wav etc..</code>. It is highly recommended for cleanliness to move the unpacked .wav files to a separate folder.
* This requires Stardew Valley 1.6.15.1 or later, from either the Play Store or the Galaxy Store.
# Replace any of the files with audio of your choosing, however you '''MUST''' keep the file names the same.
 
# To repack, simply run <code>XWBTool "wherever you extracted and moved the .wavs to/*.wav" -o Music.xwb</code> (The output file '''must''' be called Music.xwb when repacking). Then rename <code>Music.xwb</code> to <code>main.2.com.chucklefish.stardewvalley.obb</code>.
* SMAPI required 64 bit OS (32 bit OS are not compatible).
# Move the now modified .obb back to <code>Internal Storage/Android/obb/main.2.com.chucklefish.stardewvalley.obb</code>.
 
# Enjoy your modified music!
===Install SMAPI===
<div style="border: 1px solid #F96; border-left: 1em solid #F96; padding: 0.5em 1em; border-radius: 5px;">
'''SMAPI on Android is still experimental. Some mods don't work yet; this may be addressed with upcoming SMAPI updates on Android.'''
</div>
 
# {{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 =
}}


Spreadsheet of all of the .wav files mapped to their internal file names:
https://docs.google.com/spreadsheets/d/1K3S8YDS4Tfe_LPtyXA9LaVM8edxvDFkwfNl-ql1kFGM/edit?usp=drivesdk
[[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"