Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sdv preview docs #2634

Merged
merged 24 commits into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bbdf934
Restructured docs
Pickysaurus Jan 22, 2025
bcf1e46
Updated social links
Pickysaurus Jan 22, 2025
de40c1a
Notes for FAQ
Pickysaurus Jan 22, 2025
b24ef90
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Jan 29, 2025
5adbf0a
Merge branch 'main' into sdv-preview-docs
Pickysaurus Feb 3, 2025
c560d2f
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 4, 2025
52dadf0
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 5, 2025
dcb9de5
Added migration info
Pickysaurus Feb 5, 2025
912648b
Added tabs for Vortex options
Pickysaurus Feb 5, 2025
a1e7767
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 10, 2025
33bc13b
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 10, 2025
500504e
Updated migration guide (needs further refinement given the incoming …
Pickysaurus Feb 10, 2025
dcad15e
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 11, 2025
5702759
Completed migration guide prior to the new backup/import feature (nee…
Pickysaurus Feb 11, 2025
2f4a24a
Collection docs WIP
Pickysaurus Feb 11, 2025
ed7d3e4
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 12, 2025
6ff5c2b
Download a collectiion completed.
Pickysaurus Feb 12, 2025
1ce4157
Hidden intro page as I'm not happy with the structure yet
Pickysaurus Feb 12, 2025
7bb4217
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 13, 2025
5f3304f
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 13, 2025
4ab0da5
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 13, 2025
ebcba45
Merge remote-tracking branch 'origin/main' into sdv-preview-docs
Pickysaurus Feb 13, 2025
d5844e3
Fixed asset name
Pickysaurus Feb 17, 2025
4b0ad97
Updated topbar image
Pickysaurus Feb 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/users/features/Loadouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ To remove a loadout, use the :material-delete-forever: icon at the bottom of the

![The My Loadouts screen showing a multiple loadouts for Cyberpunk 2077](../images/0.7.2/LoadoutsMultiple.webp)

The currently active loadout cannot be removed. To completely remove a game from the app, including all loadouts, please see [Removing a Game](../AddGames.md#removing-a-game).
The currently active loadout cannot be removed. To completely remove a game from the app, including all loadouts, please see [Removing a Game](../gettingstarted/AddGames.md#removing-a-game).
13 changes: 9 additions & 4 deletions docs/users/AddGames.md → docs/users/gettingstarted/AddGames.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@
In this guide, we'll cover adding and removing games in the app.

## Adding a Game
!!! tip "Before you start"
Modding with the Nexus Mods app works best on a completely clean game installation. It is highly recommended that you remove any existing mods/customisations from your game folder and re-verify the integrity of the game files using your game launcher (e.g. Steam/GOG Galaxy) before modding.

If you're moving from another mod manager, check out our advice [here](./MovingToTheApp.md).

To get started, head to the home screen of the app by clicking the Nexus Mods logo at the top of the spine on the left. From here, click the "My Games" option in the left menu.

![The My Games screen with Stardew Valley, Cyberpunk 2077, Baldur's Gate 3 and Bannerlord unmanaged.](./images/0.7.2/AddGame.webp)
![The My Games screen with Stardew Valley, Cyberpunk 2077, Baldur's Gate 3 and Bannerlord unmanaged.](../images/0.7.2/AddGame.webp)

This page shows a list of games that are currently supported and those that are managed by the app currently.

To add a game, simply click the "Add Game" button at the bottom of the game card.

![The My Games screen with Cyberpunk 2077 in the process of being added.](./images/0.6.0/AddingGameCyberpunk.webp)
![The My Games screen with Cyberpunk 2077 in the process of being added.](../images/0.6.0/AddingGameCyberpunk.webp)

While the spinner is displayed the app is taking a backup of the current state of the game files which will allow you to easily restore back to this state when you're finished modding. This can take a few seconds depending on the size of the game.

Expand All @@ -23,8 +28,8 @@ Once the process is complete a new entry will be added to the spine menu on the

To stop managing a game with the app, click the home button at the top of the spine menu on the left, then select "My Games" in the left menu. This will open a screen with a list of both supported and managed games.

![The My Games screen with Stardew Valley and Cyberpunk 2077 managed.](./images/0.7.2/GameAdded.webp)
![The My Games screen with Stardew Valley and Cyberpunk 2077 managed.](../images/0.7.2/GameAdded.webp)

Click on the :material-delete-forever: icon on the game you wish to remove. This process may take a few second as the game is reverted back to the state it was in before you started modding it. Your mods are not deleted and will still be available in the Library section next time you manage the game.

To completely remove the Nexus Mods app and all downloaded mods, please see [Uninstalling the app](./Uninstall.md).
To completely remove the Nexus Mods app and all downloaded mods, please see [Uninstalling the app](../Uninstall.md).
49 changes: 49 additions & 0 deletions docs/users/gettingstarted/DownloadACollection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Downloading a Collection

In this guide, we'll cover adding a collection to the Library by downloading it from Nexus Mods.

## Browsing the website
To get started, head over the [Nexus Mods website](https://next.nexusmods.com/collections/) and find a collection you would like to try out.

Simply click the "Add collection" button to add the collection to your Library and begin the download process.

![The Collections page on the Nexus Mods website with the "Add Collection" button highlighted](../images/NexusModsCollectionPageDownload.webp)

## Downloading a collection
!!! tip "Easier with Nexus Mods Premium"
[Nexus Mods Premium](https://next.nexusmods.com/premium){:target="_blank"} enables uncapped download speeds and allows you to download all mods in a collection in one-click!

After clicking through on the website, the collection will be downloaded into the app. This can take a few moments. An indicator will appear in the bottom left of the app to show in-progress downloads. Once downloaded, the collection will be available in your Library.

![Collection installed to the Library.](../images/0.7.3/CollectionInLibrary.webp)

When you are ready to download the mods, click "Continue Download" to open the Collection Download page. Here you can see the required mods, optional mods, and any additional instructions provided by the curator of the collection.

![The Collection Download page with no mods installed.](../images/0.7.3/CollectionDownloadPage.webp)

To install the mods, click the "Download" button at the end of each row in the "Required" section. If you have a Nexus Mods Premium account, you can also click "Download all required mods" to automate this process. [Why do I as a Free user have to go to each mod page individually?](https://modding.wiki/en/nexusmods/collections/FAQ#why-do-i-as-a-free-user-have-to-go-to-each-mod-page-individually){:target="_blank"}

??? note "Mods from websites other than Nexus Mods"
If a collection includes mods that are not hosted on Nexus Mods, they must be added to your Library manually. Here's an example.

Once all the mods have been downloaded into the app, the "Install Collection" button will be available above the mod list.

![The Collection Download page with all mods downloaded and ready install.](../images/0.7.3/CollectionReadyToInstall.webp)

After clicking "Install Collection", the mods will be added to your loadout to match the curator's setup. A new option will appear in the left menu which allows you to view the collection and toggle it on or off.

![The Collection showing in the left menu after being installed.](../images/0.7.3/CollectionLeftMenu.webp)

Your collection is now installed. Don't forgot to click "Apply" before playing the game!

## Troubleshooting
Below are the common issues users report while installing collections and the solutions.

### Clicking the "Add Collection" button doesn't start the download

If the buttons on the collection page do not trigger a download, check the following:

- **Check other mod managers:** It's only possible for one application to handle downloads from Nexus Mods at once. Some applications automatically re-register to handle download links when starting up. Check if any other applications open when clicking the buttons on the website. The app will re-register as the primary download handler on startup, so restarting the app should fix this association.
- **Troubleshoot common set up issues:** The common use cases for downloads not starting are covered [in the FAQ](../faq/NexusModsDownloads.md).
- **Still having issues?:** If your downloads still aren't working, consult the [Troubleshooting Website Issues](https://help.nexusmods.com/article/113-troubleshooting-website-issues) guide or reach out on the [forums](https://forums.nexusmods.com/) for additional support.

41 changes: 41 additions & 0 deletions docs/users/gettingstarted/DownloadAMod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Downloading a Mod

In this guide, we'll cover adding a mod to the Library by downloading it from Nexus Mods or importing a file from your PC.

## Downloading directly from Nexus Mods
Mods shared on the Nexus Mods website can be downloaded quickly and easily into the app. On a Nexus Mods page for a supported game, look for the "Mod Manager" button in the top-right of the page and the "Mod Manager Download" button on each file in the files tab. Clicking these buttons will pass a the mod to the app and begin the download.

![The Nexus Mods website with the top-right "Vortex" button highlighted and the "Mod Manager Download" button in the Files tab](../images/NexusModsModDownloadButtons.webp)

Once the mod is downloaded, it will appear in the Library for the relevant game.

## Adding a mod to the Library manually
??? info "Downloading from websites other than Nexus Mods"
The app can import mods from any website, however, the rich metadata (including images, titles, version info) is only available for files downloaded from Nexus Mods.

Mods that don't have a "Mod Manager" button can be downloaded to your PC using the "Manual Download" button.

To add the file to the app, click the "From Drive" option on the Library page. You can select multiple files from the same folder to import at the same time.

![The "From Drive" option highlighted in the Library to show how to add manually added archives.](../images/0.7.3/AddFromDrive.webp)

Each imported file will be "grouped" as it's own mod and does not have any Nexus Mods metadata associated with it.

## Troubleshooting
Below are the common issues users report while downloading mods and the solutions.

### The mod doesn't have the "Mod Manager" buttons
If a mod page doesn't have the buttons to download directly into the app, this can be for one of two reasons:

1. The game you're trying to download files from is not supported by a mod manager that integrates with Nexus Mods.
2. The mod author has intentionally disabled the mod manager download options, this might be because the file cannot be installed with a mod manager - check the mod page for more information.

In both cases, you can still add mods to the Library as explained in [Adding a mod to the Library manually](#adding-a-mod-to-the-library-manually) above.

### Clicking the "Mod Manager" button doesn't start the download

If the buttons on the mod page do not trigger a download, check the following:

- **Check other mod managers:** It's only possible for one application to handle downloads from Nexus Mods at once. Some applications automatically re-register to handle download links when starting up. Check if any other applications open when clicking the buttons on the website. The app will re-register as the primary download handler on startup, so restarting the app should fix this association.
- **Troubleshoot common set up issues:** The common use cases for downloads not starting are covered [in the FAQ](../faq/NexusModsDownloads.md).
- **Still having issues?:** If your downloads still aren't working, consult the [Troubleshooting Website Issues](https://help.nexusmods.com/article/113-troubleshooting-website-issues) guide or reach out on the [forums](https://forums.nexusmods.com/) for additional support.
15 changes: 15 additions & 0 deletions docs/users/gettingstarted/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Introducing to the Nexus Mods app
---

# Introducing to the Nexus Mods app

This guide includes the basics you'll need to know to use the app effectively.

## What is a Mod Manager?

## Why use a Mod Manager?

## What's different about the Nexus Mods app?
- How it adds mods to the game folder
- The concept of Library vs Loadout
93 changes: 93 additions & 0 deletions docs/users/gettingstarted/MovingToTheApp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Transferring Existing Stardew Valley Mods to the App

In this guide, we will cover the basics of importing existing mods from other mod managers into the app. This information is primarily intended for Stardew Valley players but may have applications in other games.

!!! danger "Clean Installation Recommended"
We highly recommend that you start modding with the Nexus Mods app using a completely clean game installation. Mods added prior to use of the app may cause issues managing your content.

## Vortex
[Vortex](https://www.nexusmods.com/site/mods/1) is the predecessor to the app and is a popular choice among Stardew Valley modders. With full Nexus Mods integration, there are two options for importing your mods to the app.

=== "Option 1 - Making a Collection"
??? note "Note - Customised and Off-site Mods"
If you have altered a mod in any way after installing it, these changes may not be preserved when importing into the app. Mods installed from sources other than Nexus Mods may not be exported.

Using the collections feature, your existing mod setup can be exported and re-downloaded through the app. To make a collection from your active profile in Vortex, follow the instructions below:

1. Open the "Collections" tab from the side menu in Vortex.
2. Click on the "Workshop" tab at the top of the page.
3. Hover over "Create a collection" and select "From Profile". Give your collection a name and press "Create".
![The option to create a collection in Vortex.](../images/VortexCreateCollection.webp)
- (Optional) In the collection edit screen, we recommend selecting all the mods with ++ctrl+"A"++, clicking "Set version" on the bottom toolbar and choose "Exact only". This will ensure that the exact same mod file is downloaded into the app, rather than an updated version.
4. Click "Upload New" at the top of the page to upload your collection to the Nexus Mods website. There may be some warnings to resolve, if you need help with these errors please post on the [Vortex forums](https://forums.nexusmods.com/forum/4306-vortex-support/).
5. Once the upload has completed, click "Open in Browser" in the notification.
6. On the collection webpage, set a title, summary, category, image and description. This can be anything as the collection isn't intended to be shared publicly.
7. At the top of the page, click "Save & publish revision 1" and in the pop-up select "Unlisted" and click "Publish".
8. Navigate to the "Mods" tab, select all your mods with ++ctrl+"A"++ and click "Disable" on the bottom toolbar, then click "Deploy Mods" on the top toolbar to confirm the changes. This will remove the mod files from the game.
9. Close Vortex.
10. Open the app and press the "Add collection" button on the collection page to begin the download/install process.

Once you are confident all your mods are installed in the app, you can re-open Vortex and remove all the mods from there.

=== "Option 2 - Importing downloads"
This method does not use the collections feature, but uses the files already downloaded to your PC.

??? note "Note - Mod Updates"
Importing mods using this method means they do not have any Nexus Mods data associated with them and cannot be checked for updates.

1. In Vortex, head to the "Mods" tab, select all mods with ++ctrl+"A"++, then disable them.
2. Click "Deploy Mods" to ensure all Vortex-managed files are removed from the game folder.
3. Select on the "Downloads" option in the side menu, the click "Open Folder" on the toolbar.
4. Take note of the download folder location - you'll need this shortly. You may now close Vortex.
5. Open the Nexus Mods app and [add Stardew Valley](../gettingstarted/AddGames.md).
6. In the Library, select "Get Mods: From Drive".
7. Navigate to the download folder location found in Step 2.
8. Press ++ctrl+"A"++ to select all mod archives in the folder.
9. Click "Open" and wait for the app to import all the mods (this can take several minutes).
10. You can now start adding these mods to your loadout.


## Stardrop
[Stardrop](https://www.nexusmods.com/stardewvalley/mods/10455) is a community-created cross-platform mod manager that is also a popular choice for Stardew Valley modders.

??? note "Note - Mod Updates"
Importing mods using this method means they do not have any Nexus Mods data associated with them and cannot be checked for updates.

By default, Stardrop uses a subfolder of "Mods" in the game directory. To preserve the mods you already have installed with Stardrop, we suggest follow these instructions to relocated Stardrop's mod files. This means you can easily swap back to Stardrop, if you like:

1. Create a folder called "Mods" somewhere on your computer outside of the Stardew Valley game folder. Inside that folder create a "Stardrop Installed Mods" folder.
- On Windows :fontawesome-brands-windows:, we recommend using `%localappdata%\Stardrop\Mods` and `%localappdata%\Stardrop\Mods\Stardrop Installed Mods`.
- On Linux :fontawesome-brands-linux:,we recommend using `$XDG_CONFIG_HOME\Stardrop\Mods` and `$XDG_CONFIG_HOME\Stardrop\Mods\Stardrop Installed Mods`
2. In Stardrop, select View -> Settings from the top bar.
![The Stardrop settings popup.](../images/StardropSettings.webp)
3. Open the folder listed as "Mod Folder Path" in the Stardrop Settings.
4. Move all the files and folders from the Mod Folder path to the new "Mods" folder you created in Step 1.
5. Update the folder in the Stardrop settings menu to match the new location.
6. Repeat steps 3-5 for the "Stardrop Installed Mods" folder.
7. Uninstall SMAPI from your game folder (Uninstall instructions [:fontawesome-brands-windows:](https://stardewvalleywiki.com/Modding:Installing_SMAPI_on_Windows#Uninstall) [:fontawesome-brands-linux:](https://stardewvalleywiki.com/Modding:Installing_SMAPI_on_Linux#Uninstall)).
8. For each folder in the new "Stardrop Installed Mods" folder, create a zipped folder containing it. These can then be [imported into the app](./DownloadAMod.md#adding-a-mod-to-the-library-manually).

## Mod Organizer 2
[Mod Organizer 2](https://www.nexusmods.com/skyrimspecialedition/mods/6194) is an alternative community-created mod manager used primarily for Bethesda games but also offers support for Stardew Valley. To add your mods downloaded into MO2 to the app, follow the steps below:

??? note "Note - Mod Updates"
Importing mods using this method means they do not have any Nexus Mods data associated with them and cannot be checked for updates.

1. In Mod Organizer 2, verify you are managing Stardew Valley, then click the folder icon above the mod list and select "Open Downloads Folder".
![The Mod Organizer 2 UI showing the button to open the download folder](../images/MO2DownloadFolder.webp)
2. Take note of the download folder location - you'll need this shortly.
3. Uninstall SMAPI from your game folder ([Uninstall instructions](https://stardewvalleywiki.com/Modding:Installing_SMAPI_on_Windows#Uninstall)).
4. Open the Nexus Mods app and [add Stardew Valley](../gettingstarted/AddGames.md).
5. In the Library, select "Get Mods: From Drive".
6. Navigate to the download folder location found in Step 2.
7. Press ++ctrl+"A"++ to select all mod archives in the folder.
8. Click "Open" and wait for the app to import all the mods (this can take several minutes).
9. You can now start adding these mods to your loadout.

## Manually Installed Mods
Some users choose to install their mods by manually copying and pasting the downloaded mod files into their game folder. This method doesn't have a clean way to import files so the best we can do is clean up your game folder read for use with the app.

1. Open your game installation folder.
2. Move the "Mods" folder so that it is no longer inside the Stardew Valley game folder (you can also delete it, but that is not recommended).
3. Uninstall SMAPI from your game folder (Uninstall instructions [:fontawesome-brands-windows:](https://stardewvalleywiki.com/Modding:Installing_SMAPI_on_Windows#Uninstall) [:fontawesome-brands-linux:](https://stardewvalleywiki.com/Modding:Installing_SMAPI_on_Linux#Uninstall)).
4. To start modding with the app, install your mods again by [importing the downloaded archives into the app](./DownloadAMod.md#adding-a-mod-to-the-library-manually).
Loading