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

Restructured the docs website to accommodate both user and dev docs #1624

Merged
merged 14 commits into from
Jun 18, 2024
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -1684,8 +1684,8 @@ The final result should look something like:
To add a custom column, we will take the following steps:

- [**Create a View**](#view): `FileColumnView.axaml` & `FileColumnView.axaml.cs`
- [**Update the TreeDataGrid**](#using-the-custom-column): Use the custom view, and give it a key.
- [**Modify the Column Definition**](#using-the-custom-column): Reference the key for custom view.
- [**Update the TreeDataGrid**](#using-the-custom-column-with-treedatagrid): Use the custom view, and give it a key.
- [**Modify the Column Definition**](#using-the-custom-column-with-treedatagrid): Reference the key for custom view.

##### ViewModel

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
77 changes: 77 additions & 0 deletions docs/developers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<div align="center">
<h1>The Nexus Mods App</h1>
<img src="../Nexus/Images/Nexus-Icon.png" width="150" align="center" />
<br/> <br/>
Mod With Confidence
<br/>
The <i>future</i> of modding with <i>Nexus Mods</i>.
<br/><br/>
<a href="https://discord.gg/ReWTxb93jS" target="_blank">
<img src="https://img.shields.io/discord/1134149061080002713?logo=discord&logoColor=white&color=7289da" alt="Discord">
</a>
<a href="https://github.com/Nexus-Mods/NexusMods.App/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/nexus-mods/nexusmods.app?include_prereleases&sort=semver&display_name=release">
</a>
</div>

If you want to know how the App works, see [Mod With Confidence](./ModWithConfidence.md).

## Installation

### Windows

**Requirements**: Windows 10 or newer and a x64 CPU, we don't support Windows on ARM.

Download and run the [Windows Installer] from the [latest release] on GitHub.

### Linux

The App requires the following programs to be available at runtime:

- `xdg-open` to open URLs in your browser.
- `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.

#### AppImage

You can download the AppImage file `NexusMods.App.x86_64.AppImage` from the [latest release] on GitHub. Make sure you have the following dependencies installed before running the AppImage:

- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required to run any AppImage.
- `glibc` 2.2.5 or newer
- `glibc++` 3.4 or newer

#### System Package Manager

If you're want to create a package for a platform, see [Contributing](./Contributing.md#for-package-maintainers) for more details.

[![Packaging status](https://repology.org/badge/vertical-allrepos/nexusmods-app.svg)](https://repology.org/project/nexusmods-app/versions)

### macOS

We currently don't publish releases for macOS.
Pickysaurus marked this conversation as resolved.
Show resolved Hide resolved

## The Team

### Nexus Mods App Team

- [halgari](https://github.com/halgari): Team lead of the Nexus Mods App, creator of [Wabbajack](https://www.wabbajack.org) and former developer of [Clojure](https://clojure.org/).
- [Al12rs](https://github.com/Al12rs): Lead developer of [Mod Organizer 2](https://www.modorganizer.org/).
- [erri120](https://github.com/erri120): Developer of [Wabbajack](https://www.wabbajack.org) and creator of [GameFinder](https://github.com/erri120/GameFinder).
- [Sewer56](https://github.com/Sewer56): Creator of [Reloaded-II](https://reloaded-project.github.io/Reloaded-II/).

### Vortex Team

- [Simon](https://github.com/insomnious): Lead developer of [Vortex](https://www.nexusmods.com/about/vortex/).
- [Nagev](https://github.com/IDCs): Developer of [Vortex](https://www.nexusmods.com/about/vortex/).

### Others

See [Contributors](https://github.com/Nexus-Mods/NexusMods.App/graphs/contributors) for a full list of contributors.

Former maintainers:

- [TanninOne](https://github.com/TanninOne): Creator of [Vortex](https://www.nexusmods.com/about/vortex/) and [Mod Organizer 1](https://github.com/TanninOne/modorganizer).

---

[Windows Installer]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe
[latest release]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest
File renamed without changes.
1 change: 1 addition & 0 deletions docs/images/developer_mode.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/images/nexus-logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/support.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 32 additions & 65 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,74 +4,41 @@
<br/> <br/>
Mod With Confidence
<br/>
The <i>future</i> of modding with <i>Nexus Mods</i>.
<br/><br/>
The <i>future</i> of modding with <i>Nexus Mods</i>.
</div>

<div align="center">
<table style="width: 100%">
<tbody>
<tr>
<th style="text-align: center; border: .05rem solid var(--md-typeset-table-color); width: 50%; vertical-align: middle">
<a href="./users/">
<div><img src="./images/support.svg" style="width: 50px; height: 50px" /></div>
<span style="font-size: 1.5em;">
User Guides
</span>
</a>
<p>Tutorials and guides to help you get started with the Nexus Mods App.</p>
</th>
<th style="text-align: center; border: .05rem solid var(--md-typeset-table-color); width: 50%; vertical-align: middle">
<a href="./developers/">
<div><img src="./images/developer_mode.svg" style="width: 50px; height: 50px" /></div>
<span style="font-size: 1.5em;">
Developer Docs
</span>
</a>
<p>Technical documentation for contributors and users interested in learning about the design of the app.</p>
</th>
</tr>
</tbody>
</table>
</div>

<div align="center">
<a href="https://discord.gg/ReWTxb93jS" target="_blank">
<img src="https://img.shields.io/discord/1134149061080002713?logo=discord&logoColor=white&color=7289da" alt="Discord">
</a>
<a href="https://github.com/Nexus-Mods/NexusMods.App/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/nexus-mods/nexusmods.app?include_prereleases&sort=semver&display_name=release">
</a>
</a>
</div>

If you want to know how the App works, see [Mod With Confidence](./ModWithConfidence.md).

## Installation

### Windows

**Requirements**: Windows 10 or newer and a x64 CPU, we don't support Windows on ARM.

Download and run the [Windows Installer] from the [latest release] on GitHub.

### Linux

The App requires the following programs to be available at runtime:

- `xdg-open` to open URLs in your browser.
- `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.

#### AppImage

You can download the AppImage file `NexusMods.App.x86_64.AppImage` from the [latest release] on GitHub. Make sure you have the following dependencies installed before running the AppImage:

- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required to run any AppImage.
- `glibc` 2.2.5 or newer
- `glibc++` 3.4 or newer

#### System Package Manager

If you're want to create a package for a platform, see [Contributing](./Contributing.md#for-package-maintainers) for more details.

[![Packaging status](https://repology.org/badge/vertical-allrepos/nexusmods-app.svg)](https://repology.org/project/nexusmods-app/versions)

### macOS

We currently don't publish releases for macOS.

## The Team

### Nexus Mods App Team

- [halgari](https://github.com/halgari): Team lead of the Nexus Mods App, creator of [Wabbajack](https://www.wabbajack.org) and former developer of [Clojure](https://clojure.org/).
- [Al12rs](https://github.com/Al12rs): Lead developer of [Mod Organizer 2](https://www.modorganizer.org/).
- [erri120](https://github.com/erri120): Developer of [Wabbajack](https://www.wabbajack.org) and creator of [GameFinder](https://github.com/erri120/GameFinder).
- [Sewer56](https://github.com/Sewer56): Creator of [Reloaded-II](https://reloaded-project.github.io/Reloaded-II/).

### Vortex Team

- [Simon](https://github.com/insomnious): Lead developer of [Vortex](https://www.nexusmods.com/about/vortex/).
- [Nagev](https://github.com/IDCs): Developer of [Vortex](https://www.nexusmods.com/about/vortex/).

### Others

See [Contributors](https://github.com/Nexus-Mods/NexusMods.App/graphs/contributors) for a full list of contributors.

Former maintainers:

- [TanninOne](https://github.com/TanninOne): Creator of [Vortex](https://www.nexusmods.com/about/vortex/) and [Mod Organizer 1](https://github.com/TanninOne/modorganizer).

---

[Windows Installer]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe
[latest release]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest
9 changes: 9 additions & 0 deletions docs/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* Extra styles for the Nexus Mods App docs */

.md-tabs {
background-color: var(--nexus-background-tertiary);
}

[dir=ltr] .md-header__title {
margin-left: 0
}
halgari marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 12 additions & 0 deletions docs/users/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

!!! warning "Important Notice"
The Nexus Mods app is still in development and is not recommend to be used as your primary mod manager. For the latest supporter mod manager please see [Vortex](https://staticdelivery.nexusmods.com/mods/2295/images/thumbnails/1/1-1690272155-1455020317.png).

Before installing the app, please ensure that your PC meets the system requirements for both [this app](./SystemRequirements.md) and the game you are modding.

## Installation

Download the latest version of the app and run the installer on your system.

- [Windows Installer](https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe)
- [Linux AppImage](https://github.com/Nexus-Mods/NexusMods.App/releases/latest)
24 changes: 24 additions & 0 deletions docs/users/SystemRequirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# System Requirements
!!! note "This page does not include the requirements to run any supported games. Please refer to the game store page for details."

This page lists the recommended system requirements to install and run the app on all supported platforms. More details will be added later as the app is tested on different systems and configurations.

## Windows

* Windows 10 or 11

## Linux dependencies
The App requires the following programs to be available at runtime:

- `xdg-open` to open URLs in your browser.
- `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.

If you plan to install using the AppImage, make sure you have the following dependencies installed:

- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required to run any AppImage.
- `glibc` 2.2.5 or newer
- `glibc++` 3.4 or newer

## macOS

!!! failure "macOS is not currently supported."
44 changes: 44 additions & 0 deletions docs/users/Uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# How to Uninstall the Nexus Mods App

So you're done with testing the Nexus Mods App and want to remove it from your system? Here's a quick guide on how to do it.

Please keep in mind that the app will make the following changes to your system on uninstall.

- Your game folder(s) will be reset to how they were before managing them with the app.
- All mods you've downloaded will be deleted.
- All your preferences or other configuration settings for the app or any of your loadouts will be removed.


## Uninstall on Windows 10/11

If you installed the Nexus Mods App from the installer (most common), you can remove it by doing the following.

- Open your settings menu by pressing the Start button and clicking the ⚙️ icon next to the power button.
- Select "Apps", then "Installed apps".
- Type "Nexus Mods App" into the search bar.
- Click the menu at the end of the row.
- Select uninstall and click through the wizard.

![Uninstalling the app in Windows 11](./images/uninstall.webp)


## Uninstall via Command Line (Linux or portable installs)

This part only applies if you are using Linux, have a portable install or have built the app from source and are running a development build.

- Open a terminal and run the following command (case-sensitive):
- On Windows `./NexusMods.App.exe uninstall-app`
- On Linux `./NexusMods.App uninstall-app`


## Manual Uninstall (Fallback)

!!! warning "Caution"
Manual uninstall should only be used as a fallback if the normal installer is not available. You will need to manually remove any mod files from your game folder(s).

If something goes wrong during uninstall, it may be necessary to remove the app manually. The following steps must be performed manually by the user:

1. Inside the App, ensure that all mods for your loadouts in all games are disabled and these changes have been applied. This will remove any files added to the game folder and get the game back to a "vanilla" state. (When possible, you should delete your loadouts).</li>
2. Close the App.
3. Delete the contents of `%LOCALAPPDATA%\NexusMods.App` on Windows or `$XDG_STATE_HOME/NexusMods.App/Logs` and `$XDG_DATA_HOME/NexusMods.App` on Linux to remove all downloaded mods and internal databases used by the app.
4. Delete the App itself (or uninstall it using the Windows system settings if possible). </li>
Empty file.
Empty file added docs/users/features/Rewind.md
Empty file.
2 changes: 2 additions & 0 deletions docs/users/games/Cyberpunk2077.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
!!! tip "Coming Soon"
Cyberpunk 2077 is not supported yet, but will be one of the next games we add to the app. Stay tuned!
2 changes: 2 additions & 0 deletions docs/users/games/StardewValley.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
!!! tip "Coming Soon"
Stardew Valley is not supported yet, but will be one of the next games we add to the app. Stay tuned!
1 change: 1 addition & 0 deletions docs/users/games/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Game Support
Binary file added docs/users/images/uninstall.webp
Binary file not shown.
Loading
Loading