Difference between revisions of "Modding:Mod compatibility"
Jump to navigation
Jump to search
Pathoschild (talk | contribs) (reorganise page a bit) |
Pathoschild (talk | contribs) (→What to do: rewrite more concisely) |
||
| Line 2,060: | Line 2,060: | ||
==For mod developers== | ==For mod developers== | ||
===What to do=== | ===What to do=== | ||
| − | + | See [[Modding:Updating deprecated SMAPI code|how to update deprecated code]]. You can... | |
| − | + | * Add or update your mods in the list above ([[/entry#Usage|see format]]). | |
| − | + | * Post a message in the [http://community.playstarbound.com/threads/135000 SMAPI 2.0 migration thread]. | |
| + | * Chat or ask questions in [https://discord.gg/kH55QXP #modding on Discord]. (A preview version of SMAPI 2.0 is also pinned there to test your mods.) | ||
===Overall compatibility=== | ===Overall compatibility=== | ||
Revision as of 03:29, 19 July 2017
SMAPI 2.0 enables new kinds of mods, but no longer supports deprecated APIs. Mods with deprecation warnings won't work in SMAPI 2.0, which will release in Q4 2017. Those mods will work fine until then.
For players
What to do
- For each mod you have installed, follow the instructions in the list below. If it's not listed, try updating to its latest version.
- If a mod is still failing, post a message in the SMAPI 2.0 migration thread (with your SMAPI log attached) and we'll help.
SMAPI mods
Here's a list of mods tested with SMAPI 2.0. Please don't edit this list directly; post a message in the SMAPI 2.0 migration thread instead.
| mod name | author | compatibility[1] | (metadata) | ||
|---|---|---|---|---|---|
| AccessChestAnywhere | dumb0t | ⚠ broken, use Chests Anywhere instead. | source | # | |
| Adjust Artisan Prices | ThatNorthernMonkey | source | # | ||
| Adjust Monster | mmanlapat | ✓ use latest version. | closed source | # | |
| Advanced Location Loader | Entoarox | source | # | ||
| Adventure Shop Inventory | Hammurabi | ✓ use latest version. | source | # | |
| AgingMod | skn | ↻ broken, not open-source. | closed source | # | |
| All Crops All Seasons | cantorsdust & community | ✓ use latest version. | source | # | |
| All Professions | cantorsdust & community | ✓ use latest version. | source | # | |
| Almighty Farming Tool | momoaau | ✓ use latest version. | closed source | # | |
| Animal Mood Fix | Grant Peters | ✖ remove this mod (no longer needed since Stardew Valley 1.2). | closed source | # | |
| Animal Sitter | jwdred | source | # | ||
| A Tapper's Dream | Goldenrevolver | source | # | ||
| AutoGate | Teban100 | ✓ use latest version. | closed source | # | |
| Automate | Pathoschild | ✓ use latest version. | source | # | |
| Auto Speed | Omegasis | ✓ use latest version. | source | # | |
| Basic Sprinkler Improved | LittleRaskols | ✓ use latest version. | closed source | # | |
| Better Quality More Seeds | bmarquismarkail | ✓ use latest version. | closed source | # | |
| Better Quarry | Nishtra | ↻ broken, not open-source. | closed source | # | |
| Better Ranching | Urbanyeti | ✓ use latest version. | closed source | # | |
| Better RNG | Zoryn | ✓ use latest version. | source | # | |
| Better Shipping Box | Kithio | ↻ broken, not open-source. | closed source | # | |
| Better Sprinklers | OrSpeeder | ⚠ broken, use unofficial update (2.3.1-pathoschild-update.3). | source | # | |
| Billboard Anywhere | Omegasis | ✓ use latest version. | source | # | |
| Birthday Mail | KathrynHazuka | ⚠ broken, use unofficial update (1.2.3-pathoschild-update.2). | closed source | # | |
| BreedLikeRabbits | Dycedarger | ✓ use latest version. | closed source | # | |
| Build Health | Omegasis | source | # | ||
| Build Endurance | Omegasis | source | # | ||
| Buy Back Collectables | Omegasis | source | # | ||
| Buy cooking recipes | Denifia | source | # | ||
| Calendar Anywhere | Zoryn | ✓ use latest version. | source | # | |
| Carry Chest | spacechase0 | ✓ use latest version. | source | # | |
| Casks Anywhere | YukiShiku | ✓ use latest version. | source | # | |
| Categorize Chests | SteelixLeiter | ✓ use latest version. | closed source | # | |
| Chefs Closet | elDudeerino | ✓ use latest version. | source | # | |
| Chest Label System | OrSpeeder | ⚠ broken, use unofficial update (1.5.1-pathoschild-update). | source | # | |
| Chest Label System for SV1.1 | MarianoMDQ | ⚠ broken, see Chest Label System. | closed source | # | |
| Chest Pooling | mralbobo | ✓ use latest version. | source | # | |
| Chests Anywhere | Pathoschild | ✓ use latest version. | source | # | |
| Choose Baby Gender | Travoos | ⚠ broken, Open manifest.json, and add this right before the final } character: , "UniqueID": "Travoos.ChooseBabyGender"
|
closed source | # | |
| CJB Automation | CJB | ⚠ broken, use Automate instead. | source | # | |
| CJB Cheats Menu | CJB | ✓ use latest version. | source | # | |
| CJB Item Spawner | CJB | ✓ use latest version. | source | # | |
| CJB Show Item Sell Price | CJB | ✓ use latest version. | source | # | |
| CleanFarm | tstaples | ✓ use latest version. | source | # | |
| Climates of Ferngill | Sakorona | source | # | ||
| Cold Weather Haley SMAPI | DanielSerrano | ↻ broken, not open-source. | closed source | # | |
| Colored Chests | Igorious | ✓ broken, remove this mod (no longer needed since colored chests were added to the game). | closed source | # | |
| Combat with Farming Implements | OrSpeeder | ✓ use latest version. | source | # | |
| Community Bundle Item Tooltip | Musbah Sinno | ✓ use latest version. | source | # | |
| Configurable Machines | KnockedMallard42 | ✓ use latest version. | closed source | # | |
| Configurable Shipping Dates | Nishtra | ↻ broken, not open-source. | closed source | # | |
| Cooking Skill | spacechase0 | source | # | ||
| Crab Net | jwdred | source | # | ||
| CurrentLocation | Omegasis | ✓ use latest version. | source | # | |
| Custom Critters | spacechase0 | ✓ use latest version. | source | # | |
| CustomElementHandler | Platonymous | ✓ use latest version. | source | # | |
| Custom Farming | Platonymous | ✓ use latest version. | source | # | |
| Custom Farm Types | spacechase0 | ✓ use latest version. | source | # | |
| Custom Furniture | Platonymous | ✓ use latest version. | source | # | |
| Customize Exterior | spacechase0 | source | # | ||
| Custom Linens | Mevima | ✓ use latest version. | closed source | # | |
| Custom TV | Platonymous | ✓ use latest version. | source | # | |
| Daily Luck Message | Schematix | ✓ use latest version. | closed source | # | |
| Daily News | bashNinja | source | # | ||
| Daily Notifications | dreamsicl | ⚠ broken, use Stardew Notifications instead. | closed source | # | |
| Daily Quest Anywhere | Omegasis | ✓ use latest version. | source | # | |
| Debug Mode | Pathoschild | ✓ use latest version. | source | # | |
| Durable Fences | Zoryn | ✓ use latest version. | source | # | |
| Dynamic Checklist | gunnargolf | source | # | ||
| Dynamic Horses | Bpendragon | ✓ use latest version. | closed source | # | |
| Dynamic Machines | tyran285 | ↻ broken, not open-source. | closed source | # | |
| DynamicNPCSprites | BashNinja | ✓ use latest version. | source | # | |
| Empty Hands | Oblitus | source | # | ||
| Enemy Health Bars | OrSpeeder | ⚠ broken, use unofficial update (1.7.1-pathoschild-update). | source | # | |
| Entoarox Framework | Entoarox | source | # | ||
| Even More Crops | TenkoKuugen | ⚠ broken, use unofficial update (MysticTempest 2017-06-03). | closed source | # | |
| Expanded Fridge | Lodukas | ✓ use latest version. | closed source | # | |
| Experience Bars | spacechase0 | ✓ use latest version. | source | # | |
| Extended BusSystem | Tondorian | ↻ broken, depends on Entoarox Framework, which isn't compatible yet. | closed source | # | |
| Extended Fridge | Crystalmir | ⚠ broken, use unofficial update, Expanded Fridge, or Chefs Closet. | source | # | |
| Extended Greenhouse | TheRaven81 | ✓ use latest version. | closed source | # | |
| Extended Minecart | Entoarox | source | # | ||
| Fall 28 Snow Day | Omegasis | source | # | ||
| Farm Automation: Barn Door Automation | Oranisagu | source | # | ||
| Farm Automation: Item Collector | Oranisagu | source | # | ||
| Farm Automation Unofficial: Item Collector | Oranisagu & maddy99 | source | # | ||
| Farm Expansion | Advize | ↻ broken, uses obsolete XmlSerializerRetool framework, which broke in SDV 1.1. | closed source | # | |
| Farm Resource Generator | jwdred | ↻ broken, not open-source. | closed source | # | |
| Fast Animations | Pathoschild | ✓ use latest version. | source | # | |
| Fast Geodes | ofmanynames | ⚠ broken, use Fast Animations instead. | closed source | # | |
| Faster Paths | Entoarox | source | # | ||
| FasterRun | KathrynHazuka | source | # | ||
| Fishing Mod | Zoryn | ✓ use latest version. | source | # | |
| Fishing Tuner Redux | Hammurabi | ✓ use latest version. | source | # | |
| FLO - New Custom NPC | randomAnon1234 | ↻ broken, not open-source. | closed source | # | |
| Flower Color Picker | spacechase0 | ✓ use latest version. | source | # | |
| Forage at the Farm | Nishtra | ↻ broken, not open-source. | closed source | # | |
| Furniture Anywhere | Entoarox | source | # | ||
| Game Reminder | mmanlapat | ✓ use latest version. | closed source | # | |
| GateOpener | mralbobo | ✓ use latest version. | source | # | |
| Generic Shop Extender | rabbitgreen49 | source | # | ||
| GetDressed | Jinxiewinxie and Advize | ✓ use latest version. | source | # | |
| Giant Crop Ring | CatCattyCat | ✓ use latest version. | closed source | # | |
| Gift Taste Helper | tstaples | ✓ use latest version. | source | # | |
| Happy Birthday | Omegasis | source | # | ||
| Happy Birthday | Oxyligen | ✓ use latest version. | closed source | # | |
| Harp of Yoba Redux | Platonymous | ✓ use latest version. | source | # | |
| Harvest Moon Witch Princess Mod | Dounat2201 | ✓ use latest version. | closed source | # | |
| Harvest With Scythe | ThatNorthernMonkey | ⚠ broken, Open its manifest.json in a text editor, and change the MajorVersion value from 0 to 1. | source | # | |
| Health Bars | Zoryn | ✓ use latest version. | source | # | |
| Horse Whistle | icepuente | ✓ use latest version. | source | # | |
| Horse Whistle | nabuma | ⚠ broken, use Horse Whistle by icepuente. | closed source | # | |
| Hunger | Yyeahdude | ✓ use latest version. | closed source | # | |
| HungerMod | skn | ✓ use latest version. | closed source | # | |
| IdlePause | Veleek | ✓ use latest version. | source | # | |
| Improved Quality of Life | Demiacle | source | # | ||
| Instant Geodes | montana123 | ⚠ broken, use Fast Animations instead. | closed source | # | |
| Instant Grow Trees | cantorsdust & community | ✓ use latest version. | source | # | |
| Interaction Helper | Hammurabi | ↻ broken, not updated yet. | source | # | |
| Item Auto Stacker | CatCattyCat | ✓ use latest version. | closed source | # | |
| Junimo Deposit Anywhere | Zoryn | ✓ use latest version. | source | # | |
| Junimo Farm | Platonymous | ✓ use latest version. | source | # | |
| Level Up Notifications | kd8lvt | ✓ use latest version. | closed source | # | |
| Lookup Anything | Pathoschild | ✓ use latest version. | source | # | |
| Longevity | RTGOAT | ✓ use latest version. | closed source | # | |
| Love Bubbles | SteelixLeiter | ✓ use latest version. | closed source | # | |
| Loved Labels | Advize and Jinxiewinxie | ✓ use latest version. | source | # | |
| Luck Skill | spacechase0 | source | # | ||
| Mail Order Pigs | jwdred | source | # | ||
| Makeshift Multiplayer | spacechase0 | source | # | ||
| Map Image Export | spacechase0 | ✓ use latest version. | source | # | |
| Message Box [API?] | Kithio | ↻ broken, not open-source. | closed source | [[#Message Box [API?]|#]] | |
| Mining at the Farm | Nishtra | ✓ use latest version. | closed source | # | |
| Mining with Explosives | Nishtra | ✓ use latest version. | closed source | # | |
| More Artifact Spots | momoaau | ↻ broken, not open-source. | closed source | # | |
| More Map Layers | Platonymous | ✓ use latest version. | source | # | |
| More Pets | Entoarox | source | # | ||
| More Rain | Omegasis | source | # | ||
| More Weapons | Joco80 & Sasara | ✓ use latest version. | closed source | # | |
| Movement Mod | Zoryn | ✓ use latest version. | source | # | |
| Multiple Sprites and Portraits On Rotation | SlyMerc | ↻ broken, not open-source. | closed source | # | |
| Museum Rearranger | Omegasis | source | # | ||
| New machines | Igorious | source | # | ||
| Night Owl | Omegasis | source | # | ||
| No Debug Mode | Pathoschild | ✖ remove this mod (debug mode was removed in SMAPI 1.0). | source | # | |
| No Fence Decay | CatCattyCat | ✓ use latest version. | closed source | # | |
| NoMorePets | Omegasis | ✓ use latest version. | closed source | # | |
| No Soil Decay | ThatNorthernMonkey | ⚠ broken, use No Soil Decay Redux instead. | source | # | |
| No Soil Decay Redux | Platonymous | ✓ use latest version. | source | # | |
| NPC Map Locations | Bouhm | source | # | ||
| NPC Speak | jwdred | ↻ broken, not open-source. | closed source | # | |
| Object Time Left | spacechase0 | ✓ use latest version. | source | # | |
| OmniFarm | lambui | source | # | ||
| Part of the Community | bmarquismarkail | ✓ use latest version. | source | # | |
| PelicanFiber | jwdred | source | # | ||
| PelicanTTS | Platonymous | source | # | ||
| Persival's BundleMod | Persival | ⚠ broken, broken in SDV 1.1; use Junimo Deposit Anywhere instead. | closed source | # | |
| Point-And-Plant | jwdred | source | # | ||
| Portraiture | Platonymous | ✓ use latest version. | source | # | |
| Prairie King Made Easy | Mucchan | ⚠ broken, use unofficial update (1.0.1-pathoschild-update). | source | # | |
| Range Display for Sprinklers and Scarecrows | CatCattyCat | ✓ use latest version. | closed source | # | |
| Recatch Legendary Fish | cantorsdust & community | ✓ use latest version. | source | # | |
| Regen Mod | Zoryn | ✓ use latest version. | source | # | |
| Regeneration | Hammurabi | ✓ use latest version. | source | # | |
| ReRegeneration | littleraskol | ✓ use latest version. | closed source | # | |
| Relationship Bar UI | SlyMerc | ✓ use latest version. | closed source | # | |
| Relationships Enhanced | rodrigovaz | ↻ broken, not open-source. | closed source | #
| |
| RelationShipStatus | Dragonisser | ↻ broken, not open-source. | closed source | # | |
| Rented Tools | JarvieK | ✓ use latest version. | source | # | |
| Replanter | jwdred | source | # | ||
| Reusable Wallpapers and Floors | Iceburg | ↻ broken, not open-source. | closed source | # | |
| Ring of Fire | Platonymous | ✓ use latest version. | source | # | |
| Rise and Shine | Yoshify | ↻ broken, ancient mod, not open-source. | closed source | # | |
| Roc's Reseed Mod | rocslayer | ✓ use latest version. | closed source | # | |
| RopeBridge | Teban100 | ✓ use latest version. | closed source | # | |
| Rotate Toolbar | Pathoschid | ✓ use latest version. | closed source | # | |
| Rush Orders | spacechase0 | ✓ use latest version. | source | # | |
| Save Anywhere | Omegasis | source | # | ||
| Scroll To Blank | Caraxian | ✓ use latest version. | closed source | # | |
| Scythe Harvesting | mmanlapat | ✓ use latest version. | closed source | # | |
| Seasonal Immersion | Entoarox | source | # | ||
| Seed Bag | Platonymous | ✓ use latest version. | source | # | |
| Self Service | JarvieK | ✓ use latest version. | source | # | |
| Send Items to other farmers | Denifia | source | # | ||
| Shed Notifications | TheCroak | ↻ broken, not open-source. | closed source | # | |
| Shenandoah Library | Nishtra | ↻ broken, not open-source. | closed source | # | |
| Shipment Tracker | Iceburg | ↻ broken, not open-source. | closed source | # | |
| Shop Expander | Entoarox | source | # | ||
| Showcase | Igorious | source | # | ||
| Shroom Spotter | TehPers | ✓ use latest version. | closed source | # | |
| Simple Crop Label | TheMusketeer | ✓ use latest version. | closed source | # | |
| Simple Sprinklers | ADoby | ✓ use latest version. | source | # | |
| Siv's Marriage | sivolobwho | ↻ broken, broken by game update, not open-source; author notified. | closed source | # | |
| Skip Intro | Pathoschild | ✓ use latest version. | source | # | |
| Skill Prestige | Alphablackwolf | source | # | ||
| Skill Prestige Mod: Cooking Skill Adapter | Alphablackwolf | ⚠ broken, use unofficial update (1.0.5-pathoschild-update). | source | # | |
| Skull Cavern Elevator | Bifibi | ✓ use latest version. | closed source | # | |
| Skull Cave Saver | cantorsdust & community | ✓ use latest version. | source | # | |
| Sleepy Eye | spacechase0 | ↻ broken, depends on Entoarox Framework, which isn't compatible yet. | source | # | |
| Slower Fence Decay | OrSpeeder | source | # | ||
| SmartMod | KuroBear | ↻ broken, broken by game update, not open-source; author notified. | closed source | # | |
| Solar Eclipse Event | Sakorona | source | # | ||
| Speedster | Platonymous | ✓ use latest version. | source | # | |
| Sprinkles | Platonymous | ↻ broken, not open-source. | closed source | # | |
| Sprint | Yoshify | ↻ broken, not open-source. | closed source | # | |
| Sprint and Dash Redux | littleraskol | ✓ use latest version. | source | # | |
| StackSplitX | tstaples | ✓ use latest version. | source | # | |
| Stardew Auto Backup | Omegasis | source | # | ||
| Stardew Content Compatibility Layer (SCCL) | TehPers | source | # | ||
| Stardew Editor | spacechase0 | ✓ use latest version. | source | # | |
| Stardew Notification | monopandora | source | # | ||
| Stardew Symphony | Omegasis | source | # | ||
| Stardew Valley Expansion | tegobash | ✖ mod page says not to use it. | closed source | # | |
| StarDustCore | Omegasis | ✖ remove this mod (no longer used by Save Anywhere despite what its mod page says). | source | # | |
| Starting Money | mmanlapat | ✓ use latest version. | closed source | # | |
| StashItemsToChest | lambui | source | # | ||
| Stephan's Lots of Crops | stephanreiken | ✓ use latest version. | closed source | # | |
| Stone Bridge Over Pond | Advize & jinxiewinxie | ✖ compatible but doesn't work (in any version of SMAPI). | closed source | # | |
| Stumps to Hardwood Stumps | Nishtra | ✓ use latest version. | closed source | # | |
| Super Greenhouse | TheRaven81 | ✓ use latest version. | closed source | # | |
| Swim (Almost) Anywhere | Platonymous | ✓ use latest version. | source | # | |
| Tapper Ready | skunkkky | ✓ use latest version. | closed source | # | |
| Taxes Mod | bdawson1993 | ↻ broken, ancient mod, not open-source. | closed source | # | |
| Teh's Fishing Overhaul | TehPers | ✓ use latest version. | source | # | |
| Teleporter | Bifibi | ↻ broken, broken by game update, not open-source; author notified. | closed source | # | |
| Three Heart Flower Festival Dance Partners | spacechase0 | source | # | ||
| TimeFreeze | Omegasis | ⚠ broken, change the UniqueID field in manifest.json to TimeFreeze. | source | # | |
| Time Reminder | Sakorona | ✓ use latest version. | closed source | # | |
| TimeSpeed | cantorsdust & community | ✓ use latest version. | source | # | |
| TimeSpeed 2.0 (unofficial) | LasurDragon | ⚠ broken, use TimeSpeed instead. | closed source | # | |
| Tractor Mod | lambui | ✓ use latest version. | source | # | |
| TrainerMod | SMAPI | ✓ use latest version. | source | # | |
| TreeTransplant | YukiShiku | ✓ use latest version. | source | # | |
| UiModSuite | Demiacle | ⚠ broken, use Ui Info Suite instead. | source | # | |
| UiModSuite updated for SMAPI 1.9 | AltF7 | ⚠ broken, use Ui Info Suite instead. | closed source | # | |
| Variable Grass | dantheman999 | ⚠ broken, use unofficial update (1.3.1-pathoschild-update). | source | # | |
| Vertical Toolbar | bmarquismarkail | ✓ use latest version. | closed source | # | |
| Wallpaper Fix | Travoos | ↻ broken, not open-source. | closed source | # | |
| Weather Controller | EvilPdor | ⚠ broken, use Climates of Ferngill instead. | source | # | |
| What FarmCave | Oxyligen | ✓ use latest version. | closed source | # | |
| wHats Up | Oxyligen | ✓ use latest version. | closed source | # | |
| XmlSerializerRetool | Persival | ✖ broken in SDV 1.1; remove this mod (no longer used by any current mod). | closed source | # | |
| Xnb Loader | Entoarox | source | # | ||
| zDailyIncrease | thakyZ | ✓ use latest version. | source | # | |
| ZoomMod / Zoom Out Extreme | RockinRolla | ✓ use latest version. | source | # |
- ↑ This only shows whether a mod is compatible; it may have bugs unrelated to SMAPI 2.0. Many mods broke in Stardew Valley 1.1 and 1.2, so 'broken' doesn't necessarily mean broken by SMAPI 2.0 itself.
For mod developers
What to do
See how to update deprecated code. You can...
- Add or update your mods in the list above (see format).
- Post a message in the SMAPI 2.0 migration thread.
- Chat or ask questions in #modding on Discord. (A preview version of SMAPI 2.0 is also pinned there to test your mods.)
Overall compatibility
Status of known SMAPI mods:
| <div style="display: inline-block; width: Division by zero.px; background: #9F9;"> | Division by zero.% are compatible or have a working alternative. |
| <div style="display: inline-block; width: Division by zero.px; background: #FF9;"> | Division by zero.% have an update coming soon. |
| <div style="display: inline-block; width: Division by zero.px; background: #F99;"> | Division by zero.% are broken and not open-source.¹ |
¹ Many of these broke due to a Stardew Valley update. Some may be updated by their authors later.