sv-mod-manager

Table of Content

• sv-mod-manager
  • Table of Content
  • Hardware requirements
  • Prerequisites
  • Installation
  • Usage
  • Mod Repos

Hardware requirements

• Linux
• macOS
• Windows (requires WSL)

Prerequisites

• Stardew Valley installation
• A compatible Mod Repository
• unzip
• unrar/rar

Installation

1. Clone this repository:

   git clone https://gitlab.com/irfanhakim/sv-mod-manager.git
   

2. Change directory to the repository:

   cd sv-mod-manager
   

3. Run the sv-mod-manager installer:

   ./installer.sh
   

   The default installation prefix is ~/.local/bin. Please ensure that the installation prefix has been added to your PATH environment variable.

   Optional arguments:

   • -h or --help: Display help message.
   • -i or --install-prefix <prefix>: Specify an installation prefix.
   • -l or --link-install: Perform a symbolic link installation.
   • -u or --uninstall: Uninstall sv-mod-manager from the system.

Usage

1. (Recommended) Configure your sv-mod-manager settings by creating or updating your config file:

   nano ~/.config/svmm/svmm.config
   

   Update the following variables in the file with your own values:

   Variable	Description	Sample	Default
   game_directory	The full path to your Stardew Valley installation directory.	C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley	~/.local/share/Steam/steamapps/common/Stardew Valley
   dl_directory	The full path to your downloads directory.	/home/deck/Downloads/svmm	~/Downloads
   mod_profile	The name of the mod profile you wish to use/install.	sv-expanded	default
   mod_repo	The full path to the mod repository you wish to use/install mods from.	~/games/my-custom-mods	~/svmm-mods
   skip_mods	Comma separated list of mods to skip during installation should they be included in the specified mod profile.	Mod1,Mod2,Mod3	-

   For example:

   game_directory=C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley
   dl_directory=/home/deck/Downloads/svmm
   mod_profile=sv-expanded
   mod_repo=~/games/my-custom-mods
   skip_mods=Mod1,Mod2,Mod3
   

   ℹ️ NOTE
   Windows users on WSL could use either Windows paths or Linux paths.

   Alternatively, you could also supply these values as command line arguments. Variables passed as arguments will take precedence over those supplied through the config file.

   Any required values that were not passed as arguments or set in the config file will take the default values set by sv-mod-manager.

2. Run the programme:

   sv-mod-manager
   

   Optional arguments:

   • -h or --help: Display help message.
   • --dl-directory <dl_directory>: System downloads directory.
   • --game-directory <game_directory>: Stardew Valley game directory.
   • --mod-profile <mod_profile>: Mod profile name.
   • --mod-repo <mod_repo>: Specify the full path to the mod repository.
   • --skip-smapi: Skip SMAPI installation or upgrade. Only use this if you strictly need to be on the same version of SMAPI.
   • --version: Display version information.

Mod Repos

A compatible Mod Repository is required for use together with sv-mod-manager as a source of mods or configs to install.

The following is a list of known compatible Mod Repos:

Name	Description
SVMM Mods	Official sv-mod-manager mod repository.