summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/StardewModdingAPI/StardewModdingAPI.config.json175
1 files changed, 94 insertions, 81 deletions
diff --git a/src/StardewModdingAPI/StardewModdingAPI.config.json b/src/StardewModdingAPI/StardewModdingAPI.config.json
index 31514a21..64b4fd53 100644
--- a/src/StardewModdingAPI/StardewModdingAPI.config.json
+++ b/src/StardewModdingAPI/StardewModdingAPI.config.json
@@ -1,269 +1,282 @@
/*
-This file contains advanced configuration for SMAPI. You
-generally shouldn't change this file unless necessary.
+
+This file contains advanced configuration for SMAPI. You generally shouldn't change this file.
+
*/
{
+ /**
+ * Whether to enable features intended for mod developers. Currently this only makes TRACE-level
+ * messages appear in the console.
+ */
"DeveloperMode": true,
- "CheckForUpdates": true,
- "ModCompatibility": [
- /* versions which crash the game */
- {
- "Name": "NPC Map Locations",
- "ID": "NPCMapLocationsMod",
- "LowerVersion": "1.42",
- "UpperVersion": "1.43",
- "UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/239",
- "ReasonPhrase": "this version has an update check error which crashes the game",
- "Compatibility": "AssumeBroken"
- },
- /* versions not compatible with Stardew Valley 1.1+ */
- {
- "Name": "Chest Label System",
- "ID": "SPDChestLabel",
- "UpperVersion": "1.5",
- "UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/242",
- "Compatibility": "AssumeBroken"
- },
+ /**
+ * Whether SMAPI should check for a newer version when you load the game. If a new version is
+ * available, a small message will appear in the console. This doesn't affect the load time even
+ * if your connection is offline or slow, because it happens in the background.
+ */
+ "CheckForUpdates": true,
- /* versions not compatible with Stardew Valley 1.2+ */
+ /**
+ * A list of mod versions SMAPI should consider compatible or broken regardless of whether it
+ * detects incompatible code. Each record can be set to `AssumeCompatible` or `AssumeBroken`.
+ * Changing this field is not recommended and may destabilise your game.
+ */
+ "ModCompatibility": [
{
"Name": "AccessChestAnywhere",
"ID": "AccessChestAnywhere",
"UpperVersion": "1.1",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/257",
"UnofficialUpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/518",
- "Notes": "Crashes with 'Method not found: Void StardewValley.Item.set_Name(System.String)'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'Method not found: Void StardewValley.Item.set_Name(System.String)'."
},
{
"Name": "Almighty Tool",
"ID": "AlmightyTool.dll",
"UpperVersion": "1.1.1",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/439",
- "Notes": "Uses obsolete StardewModdingAPI.Extensions.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Extensions."
},
{
"Name": "Better Sprinklers",
"ID": "SPDSprinklersMod",
"UpperVersion": "2.3",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/41",
"UnofficialUpdateUrl": "http://community.playstarbound.com/threads/125031",
- "Notes": "Uses obsolete StardewModdingAPI.Extensions.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Extensions."
},
{
"Name": "Casks Anywhere",
"ID": "CasksAnywhere",
+ "Compatibility": "AssumeBroken",
"UpperVersion": "1.1",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/878",
- "Notes": "Uses obsolete StardewModdingAPI.Inheritance.ItemStackChange.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Inheritance.ItemStackChange."
+ },
+ {
+ "Name": "Chest Label System",
+ "ID": "SPDChestLabel",
+ "UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
+ "UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/242",
+ "Notes": "Not compatible with Stardew Valley 1.1+"
},
{
"Name": "Chests Anywhere",
"ID": "ChestsAnywhere",
"UpperVersion": "1.8.2",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/518",
- "Notes": "Crashes with 'Method not found: Void StardewValley.Menus.TextBox.set_Highlighted(Boolean)'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'Method not found: Void StardewValley.Menus.TextBox.set_Highlighted(Boolean)'."
},
{
"Name": "Chests Anywhere",
"ID": "Pathoschild.ChestsAnywhere",
"UpperVersion": "1.9-beta",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/518",
- "Notes": "ID changed in 1.9. Crashes with InvalidOperationException: 'The menu doesn't seem to have a player inventory'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "ID changed in 1.9. Crashes with InvalidOperationException: 'The menu doesn't seem to have a player inventory'."
},
{
"Name": "CJB Automation",
"ID": "CJBAutomation",
"UpperVersion": "1.4",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/211",
- "Notes": "Crashes with 'Method not found: Void StardewValley.Item.set_Name(System.String)'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'Method not found: Void StardewValley.Item.set_Name(System.String)'."
},
{
"Name": "CJB Cheats Menu",
"ID": "CJBCheatsMenu",
"UpperVersion": "1.13",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/4",
- "Notes": "Uses removed Game1.borderFont.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses removed Game1.borderFont."
},
{
"Name": "CJB Item Spawner",
"ID": "CJBItemSpawner",
"UpperVersion": "1.6",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/93",
- "Notes": "Uses removed Game1.borderFont.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses removed Game1.borderFont."
},
{
"Name": "Cooking Skill",
"ID": "CookingSkill",
"UpperVersion": "1.0.3",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/522",
- "Notes": "Crashes with 'Method not found: Void StardewValley.Buff..ctor(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, System.String)'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'Method not found: Void StardewValley.Buff..ctor(Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, System.String)'."
},
{
"Name": "Enemy Health Bars",
"ID": "SPDHealthBar",
"UpperVersion": "1.7",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/193",
- "Notes": "Uses obsolete GraphicsEvents.DrawTick.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete GraphicsEvents.DrawTick."
},
{
"Name": "Entoarox Framework",
"ID": "eacdb74b-4080-4452-b16b-93773cda5cf9",
"UpperVersion": "1.6.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/resources/4228",
- "Notes": "Uses obsolete StardewModdingAPI.Inheritance.SObject until 1.6.1; then crashes until 1.6.4 ('Entoarox Framework requested an immediate game shutdown: Fatal error attempting to update player tick properties System.NullReferenceException: Object reference not set to an instance of an object. at Entoarox.Framework.PlayerHelper.Update(Object s, EventArgs e)').",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Inheritance.SObject until 1.6.1; then crashes until 1.6.4 ('Entoarox Framework requested an immediate game shutdown: Fatal error attempting to update player tick properties System.NullReferenceException: Object reference not set to an instance of an object. at Entoarox.Framework.PlayerHelper.Update(Object s, EventArgs e)')."
},
{
"Name": "Extended Fridge",
"ID": "Mystra007ExtendedFridge",
"UpperVersion": "1.0",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/485",
- "Notes": "Actual upper version is 0.94, but mod incorrectly sets it to 1.0 in the manifest. Crashes with 'Field not found: StardewValley.Game1.mouseCursorTransparency'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Actual upper version is 0.94, but mod incorrectly sets it to 1.0 in the manifest. Crashes with 'Field not found: StardewValley.Game1.mouseCursorTransparency'."
},
{
"Name": "Get Dressed",
"ID": "GetDressed.dll",
"UpperVersion": "3.2",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/331",
- "Notes": "Crashes with NullReferenceException in GameEvents.UpdateTick.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with NullReferenceException in GameEvents.UpdateTick."
},
{
"Name": "Lookup Anything",
"ID": "LookupAnything",
"UpperVersion": "1.10",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/541",
- "Notes": "Crashes with FormatException when looking up NPCs.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with FormatException when looking up NPCs."
},
{
"Name": "Lookup Anything",
"ID": "Pathoschild.LookupAnything",
"UpperVersion": "1.10.1",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/541",
- "Notes": "ID changed in 1.10.1. Crashes with FormatException when looking up NPCs.",
- "Compatibility": "AssumeBroken"
+ "Notes": "ID changed in 1.10.1. Crashes with FormatException when looking up NPCs."
},
{
"Name": "Makeshift Multiplayer",
"ID": "StardewValleyMP",
+ "Compatibility": "AssumeBroken",
"UpperVersion": "0.2.10",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/501",
- "Notes": "Uses obsolete GraphicsEvents.OnPreRenderHudEventNoCheck.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete GraphicsEvents.OnPreRenderHudEventNoCheck."
},
{
"Name": "NoSoilDecay",
"ID": "289dee03-5f38-4d8e-8ffc-e440198e8610",
"UpperVersion": "0.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/237",
- "Notes": "Uses Assembly.GetExecutingAssembly().Location.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses Assembly.GetExecutingAssembly().Location."
+ },
+ {
+ "Name": "NPC Map Locations",
+ "ID": "NPCMapLocationsMod",
+ "LowerVersion": "1.42",
+ "UpperVersion": "1.43",
+ "Compatibility": "AssumeBroken",
+ "UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/239",
+ "ReasonPhrase": "this version has an update check error which crashes the game"
},
{
"Name": "Point-and-Plant",
"ID": "PointAndPlant.dll",
"UpperVersion": "1.0.2",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/572",
- "Notes": "Uses obsolete StardewModdingAPI.Extensions.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Extensions."
},
{
"Name": "Reusable Wallpapers",
"ID": "dae1b553-2e39-43e7-8400-c7c5c836134b",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/356",
- "Notes": "Uses obsolete StardewModdingAPI.Inheritance.ItemStackChange.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses obsolete StardewModdingAPI.Inheritance.ItemStackChange."
},
{
"Name": "Save Anywhere",
"ID": "SaveAnywhere",
"UpperVersion": "2.0",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/444",
- "Notes": "Depends on StarDustCore.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Depends on StarDustCore."
},
{
"Name": "StackSplitX",
"ID": "StackSplitX.dll",
"UpperVersion": "1.0",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/798",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
},
{
"Name": "StarDustCore",
"ID": "StarDustCore",
"UpperVersion": "1.0",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://www.nexusmods.com/stardewvalley/mods/683",
- "Notes": "Crashes with 'Method not found: Void StardewModdingAPI.Command.CallCommand(System.String)'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'Method not found: Void StardewModdingAPI.Command.CallCommand(System.String)'."
},
{
"Name": "Teleporter",
"ID": "Teleporter",
"UpperVersion": "1.0.2",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/resources/4374",
- "Notes": "Crashes with 'InvalidOperationException: The StardewValley.Menus.MapPage object doesn't have a private 'points' instance field'.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Crashes with 'InvalidOperationException: The StardewValley.Menus.MapPage object doesn't have a private 'points' instance field'."
},
{
"Name": "Zoryn's Better RNG",
"ID": "76b6d1e1-f7ba-4d72-8c32-5a1e6d2716f6",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/threads/108756",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
},
{
"Name": "Zoryn's Calendar Anywhere",
"ID": "a41c01cd-0437-43eb-944f-78cb5a53002a",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/threads/108756",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
},
{
"Name": "Zoryn's Health Bars",
"ID": "HealthBars.dll",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/threads/108756",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
},
{
"Name": "Zoryn's Movement Mod",
"ID": "8a632929-8335-484f-87dd-c29d2ba3215d",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/threads/108756",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
},
{
"Name": "Zoryn's Regen Mod",
"ID": "dfac4383-1b6b-4f33-ae4e-37fc23e5252e",
"UpperVersion": "1.5",
+ "Compatibility": "AssumeBroken",
"UpdateUrl": "http://community.playstarbound.com/threads/108756",
- "Notes": "Uses SMAPI's internal SGame class.",
- "Compatibility": "AssumeBroken"
+ "Notes": "Uses SMAPI's internal SGame class."
}
]
}