morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Stardew valley: Supported Mods documentation and changes required for legal reasons (#2038)

Browse Source 
## What is this fixing or adding?
It was pointed out that distributing an archive with copies of all the supported mods could lead to legal problems down the line. So we are moving away from this approach.
This also means that, in the event that a mod gets updated and the previous version is no longer available, we need the ability to update the mod's supported version at any point in time, and cannot rely on AP's release schedule for such updates that will, in most cases, be only changing the string for the required version.

Changes:
- Scrub all references to the support mods zip file from documentation
- Create dedicated "Supported Mods" documentation page, external to AP so we can keep it updated with mod versions regardless of their release schedule
- Remove mod version validation from the AP backend, and manage that in the mod itself, for the same reason.
This commit is contained in:
agilbert1412
2023-07-28 22:08:22 -04:00
committed by GitHub
parent 672a97c9ae
commit 280ebf9c34
4 changed files with 21 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
worlds/stardew_valley/docs/setup_en.md
View File

@@ -11,8 +11,9 @@
- Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
- (Only for the TextClient)
- Other Stardew Valley Mods [Nexus Mods](https://www.nexusmods.com/stardewvalley)
- For Supported mods (see related section in this page), it is recommend to install them from the mods archive available with the StardewArchipelago mod release
- It is **not** recommended to further mod Stardew Valley with unsupported mods, altough it is possible to do so. Mod interactions can be unpredictable, and no support will be offered for related bugs.
- There are [supported mods](https://github.com/agilbert1412/StardewArchipelago/blob/4.x.x/Documentation/Supported%20Mods.md) that you can add to your yaml to include them with the Archipelago randomization
- It is **not** recommended to further mod Stardew Valley with unsupported mods, although it is possible to do so. Mod interactions can be unpredictable, and no support will be offered for related bugs.
- The more unsupported mods you have, and the bigger they are, the more likely things are to break.
## Configuring your YAML file
@@ -79,43 +80,7 @@ For a better chat experience, you can also use the official Archipelago Text Cli
### Playing with supported mods
To include supported mods in your multiworld slot, you need to include a section in your yaml settings called "mods".
This section must be an array with the **exact** names of every mod you wish to include. Any improperly typed mod name will be ignored.
![image](https://i.imgur.com/uOHtXmU.png)
These mods will then be included in the multiworld generation, and considered in logic. For example, the Magic mod includes a spell that allow a player to teleport, and, if included, teleporting can be required to reach checks.
Furthermore, as mod development can be unpredictable, the generator and the StardewArchipelago client are designed and tested for a very specific version of any supported mod. When installing them, you must choose the correct version, or you will not be able to play.
A Zip archive of **every supported mod** is included in the [StardewArchipelago Mod Releases](https://github.com/agilbert1412/StardewArchipelago/releases) alongside the main mod, which should all have the correct versions available. The archive also contains recommended configs for customizable mods.
The archive also contains every dependency for these mods, but dependency versions are less strict.
If you can load the supported mod on the correct version, the exact version of a dependency is not important.
#### All supported mod exact names and required versions:
- "DeepWoods" -> 3.0.0-beta
- "Tractor Mod" -> 4.16.4
- "Bigger Backpack" -> 6.0.0
- "Skull Cavern Elevator" -> 1.5.0
- "Luck Skill" -> 1.2.4
- "Magic" -> 0.8.2
- "Socializing Skill" -> 1.1.5
- "Archaeology" -> 1.5.0
- "Cooking Skill" -> 1.4.5
- "Binning Skill" -> 1.2.7
- "Ayeisha - The Postal Worker (Custom NPC)" -> 0.5.0-alpha
- "Mister Ginger (cat npc)" -> 1.5.9
- "Juna - Roommate NPC" -> 2.1.3
- "Professor Jasper Thomas" -> 1.7.6
- "Alec Revisited" -> 2.1.0
- "Custom NPC - Yoba" -> 1.0.0
- "Custom NPC Eugene" -> 1.3.1
- "'Prophet' Wellwick" -> 1.0.0
- "Shiko - New Custom NPC" -> 1.1.0
- "Delores - Custom NPC" -> 1.1.2
- "Custom NPC - Riley" -> 1.2.2
See the [Supported mods documentation](https://github.com/agilbert1412/StardewArchipelago/blob/4.x.x/Documentation/Supported%20Mods.md)
### Multiplayer