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

Docs edit #2664

Merged
merged 5 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions docs/users/faq/LogFiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To quickly open your logs folder, simply click the "View app logs" button from t
![The top-right corner of the main window with the help menu expanded.](../images/0.5.3/OpenAppLogsButton.webp)

## :fontawesome-brands-windows: Windows
Log files for the app are located in `%LOCALAPPDATA%\NexusMods.App\Logs` on Windows. You can quickly find these files be following the steps below:
Log files for the app are located in `%LOCALAPPDATA%\NexusMods.App\Logs` on Windows. You can quickly find these files by following the steps below:

1. Press ++win+"R"++ to open the "Run" command box.
2. Paste `%LOCALAPPDATA%\NexusMods.App\Logs` into the Open field and press OK.
Expand All @@ -22,11 +22,12 @@ Log files for the app are located in `%LOCALAPPDATA%\NexusMods.App\Logs` on Wind
??? tip "Using the terminal"
If you're familiar with the Linux Terminal, simply type `xdg-open file://$HOME/.local/state/NexusMods.App/Logs/` to browse to the correct location.

Log files for the app are located in `~/.local/state/NexusMods.App/Logs` on Linux. You can quickly find these files be following the steps below:
Log files for the app are located in `~/.local/state/NexusMods.App/Logs` on Linux. You can quickly find these files by following the steps below:

1. Open the file explorer and ensure you're at the "Home" directory.
2. Press ++ctrl+"L"++ to edit the file path.
3. In the input box, enter add `/.local/state/NexusMods.App/Logs/` to the end of the existing path. (e.g. `/home/mike/.local/state/NexusMods.App/Logs/`)
3. In the input box, enter
+ `/.local/state/NexusMods.App/Logs/` to the end of the existing path. (e.g. `/home/mike/.local/state/NexusMods.App/Logs/`)
![The file explorer in Ubuntu pre-filled with /home/mike/.local/state/NexusMods.App/Logs/](../images/RunCommandLogsLinux.webp)
4. Identify that latest files starting with `nexusmods.app.main.` and ``nexusmods.app.slim.`. You can sort by "Date Modified" to make this easier.
5. Share these files in your Discord, GitHub or Forum post by dragging and dropping them into the text field.
6 changes: 3 additions & 3 deletions docs/users/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
This page includes answers to the commonly asked questions about the app.

## Why doesn't the app support my game?
The Nexus Mods app is still in development and will not support specific games because these features have not been included yet. Our primary focus is to establish core functionality and foundational elements.
The Nexus Mods app is still in development and will not support some games because these features have not been included yet. Our primary focus is to establish core functionality and foundational elements.

Adding support for a wide range of games it not a practical decision at this stage of development, as it can introduce additional complexity and obscure underlying issues that need to be resolved first. The goal is to ensure the mod manager works seamlessly for a select few games before expanding compatibility in subsequent beta and final releases.
Adding support for a wide range of games is not a practical decision at this stage of development, as it can introduce additional complexity and obscure underlying issues that need to be resolved first. The goal is to ensure the mod manager works seamlessly for a select few games before expanding compatibility in subsequent beta and final releases.

Our plan is to go game-by-game and work with the modding community at each step to ensure we're building something great. To see which games are supported, coming next and planned for the future please see the [roadmap](https://trello.com/b/gPzMuIr3/nexus-mods-app-roadmap).
Our plan is to go game-by-game and work collaboratively with the modding community at each step to ensure we're building something great. To see which games are supported, coming next and planned for the future, please see the [roadmap](https://trello.com/b/gPzMuIr3/nexus-mods-app-roadmap).

## Why can't I log into the app or download from Nexus Mods?

Expand Down
2 changes: 1 addition & 1 deletion docs/users/features/Loadouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Loadouts offer a convenient way to manage several different mod setups for a single game. Players can easily swap between simple or complex mod setups by creating multiple loadouts. Some examples of why you would use loadouts are:

- A single player and multiplayer loadout for Stardew Valley or Bannerlord.
- A single player and multiplayer loadout for Stardew Valley or Mount & Blade II: Bannerlord.
- Different loadouts for different characters in Cyberpunk 2077.
- Separated loadouts for total conversion mods in Elder Scrolls or Fallout games.
- Testing a new setup without impacting your stable mod setup.
Expand Down
2 changes: 1 addition & 1 deletion docs/users/features/Workspaces.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The Workspace feature allows incredible flexibility and customisation when managing your mods. Different pages in the app can be opened in new tabs or panels to help arrange the most relevant information in the most useful way.
The Workspace feature allows increased flexibility and customisation when managing your mods. Different pages in the app can be opened in new tabs or panels to help arrange the most relevant information in the most useful way.

![An example of a workspace set up with multiple tabs and panels](../images/0.5.2/WorkspacesExample.webp)

Expand Down
2 changes: 1 addition & 1 deletion docs/users/games/BaldursGate3.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Diagnostics are shown in the following situations:
- On Linux, BG3 Script Extender is installed via WINE but the WINE DLL Override setting is not set to allow the correct DLL file to be used.

### Selective Game Backup
When managing Baldur's Gate 3 the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.
When managing Baldur's Gate 3, the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.


## Compatibility
Expand Down
2 changes: 1 addition & 1 deletion docs/users/games/Bannerlord.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Diagnostics are shown in the following situations and uses the SubModule.xml fil


### Selective Game Backup
When managing Bannerlord the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.
When managing Mount & Blade II: Bannerlord, the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.

## Compatibility
This game can be managed via the app on the following operating systems and platforms. The application will automatically detect valid installations from supported game stores if possible.
Expand Down
2 changes: 1 addition & 1 deletion docs/users/games/Cyberpunk2077.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Changes in REDmods are always overwritten by similar changes inside archive mods
When mods using the official REDmod system are installed, it may be necessary to run the the REDmod tool. The app will detect when this is necessary and run it automatically before starting the game.

### Selective Game Backup
When managing Cyberpunk 2077 the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.
When managing Cyberpunk 2077, the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.

## Compatibility
This game can be managed via the app on the following operating systems and platforms. The application will automatically detect valid installations from supported game stores if possible.
Expand Down
4 changes: 2 additions & 2 deletions docs/users/games/StardewValley.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ Diagnostics are shown in the following situations:
Settings files for mods (e.g. `config.json`) are saved as part of a Loadout. This allows for different combinations of settings to be used in each loadout. Copying a loadout will duplicate all existing settings whereas creating a new loadout will start with the defaults. See [Loadouts](../features/Loadouts.md).

### Edit Config Files
Easily edit mod config files in your loadout(s). When new config files are created after starting the game, the app will automatically assign them to mod they correspond to. To edit these settings select the mod in the "My Mods" view and click "View Mod Files" on the toolbar. Locate the config file (e.g. config.json) and click "Edit File" from the toolbar. Click save when finished editing, then apply the changes to your game.
When new config files are created after starting the game, the app will automatically assign them to the mod they correspond to. To edit these settings, select the mod in the "My Mods" view and click "View Mod Files" on the toolbar. Locate the config file (e.g. config.json) and click "Edit File" from the toolbar. Click save when you've finished editing, then apply the changes to your game.

![Using the app to edit a config.json](../images/0.5.3/SDVEditConfig.webp)

### Selective Game Backup
When managing Stardew Valley the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.
When managing Stardew Valley, the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.

## Compatibility
This game can be managed via the app on the following operating systems and platforms. The application will automatically detect valid installations from supported game stores if possible.
Expand Down
6 changes: 3 additions & 3 deletions docs/users/gettingstarted/DownloadAMod.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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.
Mods shared on the Nexus Mods website can be downloaded quickly and easily with the app. On a Nexus Mods page for a supported game, look for the "Mod Manager" button in the top-right of the page or the "Mod Manager Download" button on each file in the files tab. Clicking these buttons will pass 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)

Expand All @@ -19,15 +19,15 @@ To add the file to the app, click the "From Drive" option on the Library page. Y

![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.
Each imported file will be "grouped" as its 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.
1. The game you're trying to download files for 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.
Expand Down
17 changes: 12 additions & 5 deletions docs/users/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# Help Centre

!!! danger "Important"
!!! info "Before you start"

Before playing with the App, you need to know a few things. Please don't skip over this information as it may negatively impact your experience.
Please be aware of the following points before using the app. If you skip over this information as it may negatively impact your experience.

- This alpha software, meaning it is still very early in development and may have bugs or issues that could break your mod setup. We've done our best to patch up any major problems, but there will always be a few "gotchas" we haven't accounted for.
- This is alpha software, meaning it's still very early in development and may have bugs or issues that could break your mod setup. We've done our best to patch up any major problems, but there will always be a few "gotchas" we haven't accounted for.
- The app only works on Windows (10+) or Linux. MacOS support is coming later!
- The current build only supports a [limited number of games](./games/index.md) - more games are planned to be added soon, so don't worry if you don't see your favourites yet!
- Please only use the app on a clean, un-modded instance of any game installation. This means removing any mods you have installed before managing it with the app. The state of the game folder when you start modding the game will be the state the app will roll back to when mods are removed.
- As we release new versions you may be required to reset your loadout and start over. We'll do our best to avoid this though and it won't be a requirement in the final release!
- We strongly recommend starting with a clean, un-modded instance of any game installation. This means removing any mods you have installed before managing it with the app.
- As we release new versions you may be required to reset your loadout and start over. However we'll do our best to avoid this and it won't be a requirement in the final release!
- The app will work on Steam Deck but the experience isn't optimised yet, let us know how you get on!


<center>
You can share your feedback or get support at the locations linked below.

[:material-forum-outline: Forums](https://forums.nexusmods.com/forum/9052-nexus-mods-app/){ .md-button } [:fontawesome-brands-discord: Discord](https://discord.gg/NexusMods){ .md-button } [:fontawesome-brands-github: GitHub](https://github.com/Nexus-Mods/NexusMods.App){ .md-button }
</center>