Install Guide

This is a guide for installing Ridgeside Village, or RSV for short. It will contain links to required mods, steps on how install the mod for the first time, and steps for updating or reinstalling.

*Last edited by Moetrash on 2023-08-28 20:12:01 GMT.*

## Required Mods

RSV requires the following list of mods to work correctly. It is recommended that you refer to their own installation guides for installing them correctly, as some of them have their own required mods. Below are links for your convenience. If you are unsure of how to install mods, check out this guide or see the next section.

## First-time install

This is for the main RSV mod and will add the new village & NPCs.

1. Make sure you have Stardew Valley and SMAPI installed, then locate your mods folder.
	* Steps for installing SMAPI and finding your mods folder are here.
2. Download RSV and **all of its requirements** (see above) from Nexus Mods.
	* Click here for the link to Ridgeside Village.
3. Unzip each file into your mods folder.
	* For more info on what it means to unzip a file, see here.
4. Your **Mods folder** should have a folder called **Ridgeside Village** inside of it, along with several other mods. It should look something like this:

The **Ridgeside Village folder** should have **several more folders** within it, labeled:

* [CC] Ridgeside Village
* [CP] Ridgeside Village
* [FTM] Ridgeside Village
* [JA] Ridgeside Village
* [MFM] Ridgeside Village
* [SAAT] Ridgeside Village
* [STF] Ridgeside Village
* RidgesideVillage

That's it! You are ready to play. If you've successfully installed the mod, then upon entering the Bus Stop, you will see a cutscene with Lewis and Lenny. You can then access the Cable Car Station using the staircase above and to the right of the bus, as shown in the image to the right.

### Mobile Install

As of Version 2.5.2, Ridgeside Village should be compatible with mobile with no extra steps. So all you need to do is simply follow the installation guide above!

However, **please note** that the mobile version must disable two specific features of RSV.

* The Ridgeside Village world map will not automatically open when you open your map in the village. Instead, you'll have to click on the RSV icon in the upper left corner of the map to see it.
* The Mountain Mistblade's projectile functionality is disabled.

Other than that, everything should be exactly the same as PC!

## Configuration Options

Ridgeside Village does have several configuration options as well. To easily change these options in a graphical user interface, we recommend downloading Generic Mod Config Menu which allows you to change the settings from the Stardew Valley main menu. Please note that changing the config options with GMCM can sometimes cause small bugs like NPC pathing issues, but these will only last for the first in-game day. To change the config options manually, after loading up the game once, a file called "config.json" will be generated in Mods/Ridgeside Village/[CP] Ridgeside Village, where you can change the values in a text editor. The config options are as follows:

* **"ShowVillagersOnMap"**: The possible values are "true" and "false" - set to "true" by default. If true, the locations of villagers will be visible on the RSV map.
* **"ProgressiveStory"**: The possible values are "true" and "false" - set to "true" by default. If true, certain events will take place relative to when RSV was installed.
* **"RepeatCableCarCutscene"**: The possible values are "true" and "false" - set to "true" by default. If true, a short cutscene of the farmer riding in the cable car will play the first time you go up and down it each day.
* **"EnableOtherNPCsInCableCar"**: The possible values are "true" and "false" - set to "true" by default. If true, other NPCs may appear in the Cable Car cutscene.
* **"EnableRidgesideMusic"**: The possible values are "true" and "false" - set to "true" by default. If true, Ridgeside Village's custom music will play when in the Ridgeside-specific maps and festivals.
* **"RSVNPCSAttendFestivals"**: The possible values are "true" and "false" - set to "true" by default. If true, RSV NPCs will attend the Pelican Town festivals. If false, no Ridgeside NPCs will attend Pelican Town festivals.
* **"ExpandedFestivalMaps"**: The possible values are "true" and "false" - set to "true" by default. If true, Pelican Town festivals will use custom maps from RSV that allow more space for the festival area - RSV NPCs will be in a new area away from others. If false (and RSVNPCsAttendFestivals is true), the RSV NPCs will appear within the default area.
* **"EasyIntroduction"**: The possible values are "true" and "false" - set to "false" by default. If true, only the original Ridgeside Village characters must be met to complete the Introductions quest (in addition to all Pelican Town characters). If false, all characters who live in Ridgeside Village must be met to complete the quest.
* **"EnableBetterBusStop"**: The possible values are "true" and "false" - set to "true" by default. If true, the bus stop design is changed so that villagers no longer pass over the road when going between towns. If false, the bus stop is changed minimally so that the only difference from the original map is the entrance to the cable car station.
* **"PoleAtBackwoods"**: The possible values are "true" and "false" - set to "true" by default. If true, a pole that supports the Ridgeside Cable Car will be added to the Backwoods map. If false, the pole will not be added.
* **"SeasonalRSVMap"**: The possible values are "true" and "false" - set to "true" by default. If true, the RSV world map will use seasonal variants. If false, the map will use the Spring variant regardless of the season.
* **"EnableTouristNPCs"**: The possible values are "true" and "false" - set to "true" by default. If true, the second floor of the Log Cabin Hotel will have non-NPC tourists staying in its rooms.
* **"EnableWTDRCompat"**: The possible values are "true" and "false" - set to "false" by default. If true, a path will open up across from the Liden Residence that leads to a bus to Zuzu City. (The bus is only functional if Walk to the Desert Redux and Downtown Zuzu are also installed.)

## Updating/Reinstalling

When updating or reinstalling RSV you will need to **delete the existing version** before installing the update. Failing to do this can cause various bugs, ranging from SMAPI warnings to complete crashes. This is safe to do and will not affect progress on saves! Once you have deleted the old version of the game, the steps for reinstalling are essentially the same as they were for installing:

* Go to your Stardew Valley Mods folder
* Delete the folder named "Ridgeside Village"
* Download the most recent version of RSV from Nexus Mods
* Unzip the downloaded files to the Mods folder
* *If you also have the optional Music of Ridgeside mod, you will have to delete and re-install that one as well!*

## Installing on an existing save file

Ridgeside Village **is safe** to install onto an existing save file. You may encounter a few issues, but these are all minor and easy to fix.

1. Bushes blocking the Bus Stop path
	* You may notice a few bushes placed in odd positions on the Bus Stop map which prevent the villagers from walking in a straight line, and also prevent your horse from being able to pass through. We recommend downloading the mod Noclip Mode mod along with Destroyable Bushes so that you can destroy each of these bushes without getting rid of other bushes on the map. An alternative method is to download the mod Reset Terrain Features, go into the game, press L, then check off all the boxes (including the "affect all locations") and pressing reset.
	If you'd like to remove this new path entirely, please set the config option **"EnableBetterBusStop"** to false, as is described above.
2. Progressive story mode
	* As of version 2.2, RSV now has the config option **"ProgressiveStory"** set to true by default. This means that certain events that are supposed to happen mid-game will now happen relative to when you installed the mod. For example, the Log Cabin Hotel expansion typically occurs at the beginning of Year 2, but if you install the mod in the middle of Winter Y3, the expansion would occur in the middle of Winter Y4. If you prefer not to wait for these changes, please set the config option to false, and all these events can then happen immediately.
3. If some characters start disappearing or walking in places that should not be possible:
	* This, unfortunately, is one of the issues that can't really be fixed, and just comes with the territory of performing such a massive update on an existing save. Luckily, this tends to only last a few in-game days and quickly resolves itself. If it poses a major issue, feel free to reach out to us on the Nexusmods page, Discord, Reddit, or any other one of our social media platforms.
4. JSON Assets items changing into other custom items
	* This issue should not occur if your version of JA is up-to-date, but it still may happen by chance, particularly with respect to items in machines (kegs, cheese makers, etc.). In that case, please see this page.

## History

* **Version 2.1.0**: "AutoWeddingReception" default value changed from "true" to "false".
* **Version 2.2.0**: Many config options modified.
* **Version 2.5.0**: Mobile compatibility updated.