Stardew Valley: implement new game (#1455)
* Stardew Valley Archipelago implementation * fix breaking changes * - Added and Updated Documentation for the game * Removed fun * Remove entire idea of step, due to possible inconsistency with the main AP core * Commented out the desired steps, fix renaming after rebase * Fixed wording * tests now passes on 3.8 * run flake8 * remove dependency so apworld work again * remove dependency for real * - Fix Formatting in the Game Page - Removed disabled Option Descriptions for Entrance Randomizer - Improved Game Page's description of the Arcade Machine buffs - Trimmed down the text on the Options page for Arcade Machines, so that it is smaller * - Removed blankspace * remove player field * remove None check in options * document the scripts * fix pytest warning * use importlib.resources.files * fix * add version requirement to importlib_resources * remove __init__.py from data folder * increment data version * let the __init__.py for 3.9 * use sorted() instead of list() * replace frozenset from fish_data with tuples * remove dependency on pytest * - Add a bit of text to the guide to tell them about how to redeem some received items * - Added a comment about which mod version to use * change single quotes for double quotes * Minimum client version both ways * Changed version number to be more specific. The mod will handle deciding --------- Co-authored-by: Alex Gilbert <alexgilbert@yahoo.com>
This commit is contained in:
Jérémie Bolduc
74
worlds/stardew_valley/docs/setup_en.md
Normal file
74
worlds/stardew_valley/docs/setup_en.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# Stardew Valley Randomizer Setup Guide
|
||||
|
||||
## Required Software
|
||||
|
||||
- Stardew Valley on PC (Recommended: [Steam version](https://store.steampowered.com/app/413150/Stardew_Valley/))
|
||||
- SMAPI ([Mod loader for Stardew Valley](https://smapi.io/))
|
||||
- [StardewArchipelago Mod Release 2.x.x](https://github.com/agilbert1412/StardewArchipelago/releases)
|
||||
- It is important to use a mod release of version 2.x.x to play seeds that have been generated here. Later releases can only be used with later releases of the world generator, that are not hosted on archipelago.gg yet.
|
||||
|
||||
## Optional Software
|
||||
- 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)
|
||||
- It is **not** recommended to further mod Stardew Valley, altough it is possible to do so. Mod interactions can be unpredictable, and no support will be offered for related bugs.
|
||||
- The more mods you have, and the bigger they are, the more likely things are to break.
|
||||
|
||||
## Configuring your YAML file
|
||||
|
||||
### What is a YAML file and why do I need one?
|
||||
|
||||
See the guide on setting up a basic YAML at the Archipelago setup
|
||||
guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
|
||||
|
||||
### Where do I get a YAML file?
|
||||
|
||||
You can customize your settings by visiting the [Stardew Valley Player Settings Page](/games/Stardew Valley/player-settings)
|
||||
|
||||
## Joining a MultiWorld Game
|
||||
|
||||
### Installing the mod
|
||||
|
||||
- Install [SMAPI](https://smapi.io/) by following the instructions on their website
|
||||
- Download and extract the [StardewArchipelago](https://github.com/agilbert1412/StardewArchipelago/releases) mod into your Stardew Valley "Mods" folder
|
||||
- *OPTIONAL*: If you want to launch your game through Steam, add the following to your Stardew Valley launch options:
|
||||
- "[PATH TO STARDEW VALLEY]\Stardew Valley\StardewModdingAPI.exe" %command%
|
||||
- Otherwise just launch "StardewModdingAPI.exe" in your installation folder directly
|
||||
- Stardew Valley should launch itself alongside a console which allows you to read mod information and interact with some of them.
|
||||
|
||||
### Connect to the MultiServer
|
||||
|
||||
Launch Stardew Valley with SMAPI. Once you have reached the Stardew Valley title screen, create a new farm.
|
||||
|
||||
On the new character creation page, you will see 3 new fields, used to link your new character to an archipelago multiworld
|
||||
|
||||
|
||||
|
||||
You can customize your farm and character as much as desired.
|
||||
|
||||
The Server text box needs to have both the address and the port, and your slotname is the name specified in your yaml
|
||||
|
||||
`archipelago.gg:38281`
|
||||
|
||||
`StardewPlayer`
|
||||
|
||||
The password is optional.
|
||||
|
||||
Your game will connect automatically to Archipelago, and reconnect automatically when loading the save, later.
|
||||
|
||||
You will never need to enter this information again for this character.
|
||||
|
||||
### Interacting with the MultiWorld from in-game
|
||||
|
||||
When you connect, you should see a message in the chat informing you of the `!!help` command. This command will list other Stardew-exclusive chat commands you can use.
|
||||
|
||||
Furthermore, you can use the in-game chat box to talk to other players in the multiworld, assuming they are using a game that supports chatting.
|
||||
|
||||
Lastly, you can also run Archipelago commands `!help` from the in game chat box, allowing you to request hints on certain items, or check missing locations.
|
||||
|
||||
It is important to note that the Stardew Valley chat is fairly limited in its capabilities. For example, it doesn't allow scrolling up to see history that has been pushed off screen. The SMAPI console running alonside your game will have the full history as well and may be better suited to read older messages.
|
||||
For a better chat experience, you can also use the official Archipelago Text Client, altough it will not allow you to run Stardew-exclusive commands.
|
||||
|
||||
### Multiplayer
|
||||
|
||||
You cannot play an Archipelago Slot in multiplayer at the moment. There is no short-terms plans to support that feature.
|
||||
Reference in New Issue
Block a user