Skip to content

Commit 958661b

Browse files
committed
Updated reference to "Nexus Mods App" to "Nexus Mods app" #1701
1 parent 78639f2 commit 958661b

17 files changed

+43
-43
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1>The Nexus Mods App</h1>
2+
<h1>The Nexus Mods app</h1>
33
<img src="https://github.com/Nexus-Mods/NexusMods.MkDocsMaterial.Themes.Next/blob/2b49cf1fdd0f15684c6057259b52210e73705b98/Images/Nexus-Icon.png?raw=true" width="150" align="center" />
44
<br/> <br/>
55
Mod With Confidence
@@ -14,7 +14,7 @@
1414
</a>
1515
</div>
1616

17-
Nexus Mods App is a mod installer, creator and manager for all your popular games.
17+
Nexus Mods app is a mod installer, creator and manager for all your popular games.
1818

1919
Easy to use, runs on your standard Windows PC and Linux alike. Don't waste time troubleshooting, play your games,
2020
fill those knees with arrows and most importantly, ***Have Fun***!

docs/developers/FAQ.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
**Q:** Company product? Is this going closed source?
1414

15-
**A:** Absolutely not, modding tools should be free, and the Nexus Mods App will always be open source (GPL3). But we also want to use this app as a way to get tools into the hands of modders and users. Instead of publishing only a download API, we want to give users a download CLI tool. Once file uploading is reworked on the site, this repo will contain the code and CLI tools required for authenticating with Nexus Mods and uploading files via a CLI (and eventually a UI). In short, this is us getting serious about supporting (and leading) the desktop side of modding, not just the file hosting side.
15+
**A:** Absolutely not, modding tools should be free, and the Nexus Mods app will always be open source (GPL3). But we also want to use this app as a way to get tools into the hands of modders and users. Instead of publishing only a download API, we want to give users a download CLI tool. Once file uploading is reworked on the site, this repo will contain the code and CLI tools required for authenticating with Nexus Mods and uploading files via a CLI (and eventually a UI). In short, this is us getting serious about supporting (and leading) the desktop side of modding, not just the file hosting side.
1616

1717

1818
**Q:** I see tests run on Linux, Windows, and OSX; are you targeting all those platforms?

docs/developers/ModWithConfidence.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ One of the biggest complaints from users over the years about modding is that th
66

77
Every step of the ***classic modding approach*** is fraught with pitfalls and destructive changes.
88

9-
The Nexus Mods App intends to solve these problems. In addition to being a great mod installer, manager and builder,
9+
The Nexus Mods app intends to solve these problems. In addition to being a great mod installer, manager and builder,
1010
this project aims to always provide an *undo* feature for users. Not just on a metadata level (like most mod managers
1111
offer today) but on a per-file basis as well.
1212

@@ -39,11 +39,11 @@ Virtual FileSystems:
3939
* You have to run xEdit through [Mod Organizer 2][mod-organizer-2] for it to see your mod list (Bethesda Games)
4040
* Files end up in a different place from where the end user expects them.
4141

42-
#### Nexus Mods App Approach
42+
#### Nexus Mods app Approach
4343

44-
!!! nexus "The Nexus Mods App aims to merge the mental simplicity of manual modding with the hygiene of existing mod installers and a promise that "you can always go back to what last worked""
44+
!!! nexus "The Nexus Mods app aims to merge the mental simplicity of manual modding with the hygiene of existing mod installers and a promise that "you can always go back to what last worked""
4545

46-
The 'Data Model' of the Nexus Mods App can be thought of as an extension of lessons learned from the development of
46+
The 'Data Model' of the Nexus Mods app can be thought of as an extension of lessons learned from the development of
4747
Nexus Collections and Wabbajack.
4848

4949
When you make a mod list, we don't directly manipulate files. Instead, we manipulate the 'instructions' used to deploy

docs/developers/ReleaseProcess.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Release Process and Workflow
22

33
## Overview
4-
The Nexus Mods App follows a strict release process which assumes that the
4+
The Nexus Mods app follows a strict release process which assumes that the
55
`main` branch is the development branch and will always be kept in a releasable
66
state. This means that any major overhauls of feature development should either
77
be done in a single PR or be developed behind an optional setting or feature flag.
@@ -15,7 +15,7 @@ will be applied to the release branch, the release branch is deleted. Often, thi
1515
sometime after the next release is made.
1616

1717
## Release Schedule
18-
The Nexus Mods App developer team follows a 3-week iteration cycle, so releases are expected
18+
The Nexus Mods app developer team follows a 3-week iteration cycle, so releases are expected
1919
to be made at the same interval. Most often, releases will be cut by the team lead, [halgari](https://github.com/halgari),
2020
who lives in the MST timezone. The cutoff point for a release is sometime in the early morning on Wednesday
2121
of the release week (MST). Due to the requirement that main kept in an "always releasable" state,

docs/developers/decisions/backend/0009-advanced-installer-design.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ In the presence of these scenarios, the mod manager must still have a way to ins
2525
## Decision Drivers & Requirements
2626

2727
- Certain mods may not come with a recognizable file structure.
28-
- The Nexus Mods App might not know how to install them automatically.
28+
- The Nexus Mods app might not know how to install them automatically.
2929

30-
- Interoperability: The Nexus Mods App must be able to somehow deploy ANY mod, regardless of its packaging format.
30+
- Interoperability: The Nexus Mods app must be able to somehow deploy ANY mod, regardless of its packaging format.
3131
- Otherwise, if users end up having to deploy files manually, they may be discouraged from using the mod manager.
3232

3333
- The Manual Installer must work with minimal game implementation code.
@@ -81,7 +81,7 @@ Blue Hair
8181
```
8282

8383
The user is expected to select items from one of the given folders. These folders do map to game folder, but
84-
because there are duplicates and multiple candidates for deployment, the Nexus Mods App cannot automatically
84+
because there are duplicates and multiple candidates for deployment, the Nexus Mods app cannot automatically
8585
choose which one to deploy.
8686

8787
## Considered Options (Deployment)
@@ -159,7 +159,7 @@ public Dictionary<RelativePath, GamePath> ArchiveToOutputMap;
159159
When the user selects a `target`, we simply add the mapping to the dictionary. Accordingly, we remove the mapping when the
160160
user undoes the operation.
161161

162-
The implementation should adhere to the [path standards used internally within the Nexus Mods App](./0003-paths.md);
162+
The implementation should adhere to the [path standards used internally within the Nexus Mods app](./0003-paths.md);
163163
i.e. All paths should use a separator of `/`, trim whitespace, do not alter `..`, etc.
164164

165165
#### API Design (Proposed)
@@ -184,7 +184,7 @@ public struct DeploymentData
184184
/// then the KeyValuePair would be like ("texture.dds", "Game/Data/Textures/texture.dds").
185185
/// </example>
186186
/// <remarks>
187-
/// Paths follow internal Nexus Mods App path standards: they use a "/" as a separator, trim whitespace, and do not alter "..".
187+
/// Paths follow internal Nexus Mods app path standards: they use a "/" as a separator, trim whitespace, and do not alter "..".
188188
/// </remarks>
189189
internal Dictionary<RelativePath, GamePath> ArchiveToOutputMap { get; init; } = new();
190190

docs/developers/development-guidelines/AddingAGame.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Adding a Game
22

3-
!!! info "Describes how to add a game to the Nexus Mods App."
3+
!!! info "Describes how to add a game to the Nexus Mods app."
44

5-
To have a game be automatically recognised by the Nexus Mods App, create a class that inherits from `AGame`.
5+
To have a game be automatically recognised by the Nexus Mods app, create a class that inherits from `AGame`.
66

77
??? "Example Game (Click to Expand)"
88

@@ -61,7 +61,7 @@ To add automatic detection for a given game, make your `AGame` implement the fol
6161

6262
### Quickly Finding the 'App IDs'
6363

64-
!!! tip "Builds of the Nexus Mods App in `Debug` configuration will print all found games."
64+
!!! tip "Builds of the Nexus Mods app in `Debug` configuration will print all found games."
6565

6666
```
6767
[DEBUG] Found Steam Game: 252950, Rocket League
@@ -139,7 +139,7 @@ After that, you may also need to add it to [AddApp][add-app] and call `services.
139139

140140
!!! tip "If your code targets a specific common 'game engine' or middleware, you might want to put your logic there."
141141

142-
For example, the Nexus Mods App has `NexusMods.Games.BethesdaGameStudios`, which contains code for the `Creation` engine.
142+
For example, the Nexus Mods app has `NexusMods.Games.BethesdaGameStudios`, which contains code for the `Creation` engine.
143143

144144
This code is used by games such as `Skyrim LE` and `Skyrim SE`, so these two games live in the
145145
`NexusMods.Games.BethesdaGameStudios` project.

docs/developers/development-guidelines/DependencyInjection.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
!!! tip "Quick Primer to Dependency Injection"
22

3-
The Nexus Mods App uses Dependency Injection (DI) for creating classes.
3+
The Nexus Mods app uses Dependency Injection (DI) for creating classes.
44

55
Dependency Injection is like having a smart assistant who prepares all the tools
66
(interfaces, a.k.a. abstract classes, traits) for a class you are trying to create.
@@ -9,7 +9,7 @@ This reduces a lot of boilerplate, helps with maintenance and makes our code cle
99

1010
## A Quick Primer
1111

12-
!!! nexus "In the Nexus Mods App, we mostly use 'Constructor Injection'"
12+
!!! nexus "In the Nexus Mods app, we mostly use 'Constructor Injection'"
1313

1414
When you create a new class, you specify what 'services' it needs right in the constructor, via interfaces.
1515

@@ -122,7 +122,7 @@ Example:
122122
services.AddAllSingleton<IFoo, Foo>();
123123
```
124124

125-
!!! note "Although we mostly use `Singleton` in the Nexus Mods App, services can have different `lifetimes`"
125+
!!! note "Although we mostly use `Singleton` in the Nexus Mods app, services can have different `lifetimes`"
126126

127127
1. **Singleton**: Only one instance, instance is reused for every requested parameter. (like `static` field)
128128
```csharp

docs/developers/development-guidelines/InstallingMods.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
!!! info "Informs you how you can add support for installing different kinds of mods."
44

5-
!!! tip "What does 'Installing a Mod' mean in the context of the Nexus Mods App?"
5+
!!! tip "What does 'Installing a Mod' mean in the context of the Nexus Mods app?"
66

7-
The *Nexus Mods App* is strictly a *Mod Manager*, ***not*** a mod loader/framework (e.g. it's not ASI Loader, SMAPI, UE4SS, BepinEx, MelonLoader etc.).
7+
The *Nexus Mods app* is strictly a *Mod Manager*, ***not*** a mod loader/framework (e.g. it's not ASI Loader, SMAPI, UE4SS, BepinEx, MelonLoader etc.).
88

9-
In the context of the *Nexus Mods App*, 'Installing Mod' means 'Decide where to put it files belonging to a mod in the Mod Folder'
9+
In the context of the *Nexus Mods app*, 'Installing Mod' means 'Decide where to put it files belonging to a mod in the Mod Folder'
1010
for an existing 'loader' or 'game' to use.
1111

1212
Mod installation in the app happens in several phases:

docs/developers/development-guidelines/LocalizationAndTranslation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Localization and Translation in the Nexus Mods App
1+
# Localization and Translation in the Nexus Mods app
22

33
!!! info "This page describes how to work with 'languages' in the App."
44

55
!!! tip "For the research info, see [07: Localization and Internationalisation](../decisions/backend/0007-localization-and-internationalisation.md)"
66

7-
In the Nexus Mods App we use the industry standard `Resource` (`.resx`) files for porting
7+
In the Nexus Mods app we use the industry standard `Resource` (`.resx`) files for porting
88
the App to different languages and cultures.
99

1010
You can find them in `Resources` folder for any project that contains UI elements.

docs/developers/development-guidelines/UICodingGuidelines.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UI Coding Conventions and Guidelines
22

3-
!!! info "The Nexus Mods App uses [Avalonia] combined with [ReactiveUI] and [Dynamic Data] for the user interface."
3+
!!! info "The Nexus Mods app uses [Avalonia] combined with [ReactiveUI] and [Dynamic Data] for the user interface."
44

55
This document contains conventions, guidelines, tips and tutorials on how to use these tools in the project.
66

@@ -158,7 +158,7 @@ only a specific part of the UI, since it now knows exactly which parts of the UI
158158

159159
!!! warning "Changes to the displayed content must be done on the UI Thread."
160160

161-
## How Nexus Mods App Does UI (ReactiveUI)
161+
## How Nexus Mods app Does UI (ReactiveUI)
162162

163163
### Events & Bindings
164164

docs/developers/development-guidelines/UIStylingGuidelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document contains guidelines and tutorials for Stying and Theming the UI of
77

88
These design can evolve and change over time, requiring the UI of the app to be updated accordingly.
99

10-
The Nexus Mods App uses [Avalonia](https://avaloniaui.net/) for its UI framework.<br/>
10+
The Nexus Mods app uses [Avalonia](https://avaloniaui.net/) for its UI framework.<br/>
1111
Avalonia has a [CSS-like styling system](https://docs.avaloniaui.net/docs/get-started/wpf/styling), which is used to style the UI.
1212

1313
## Avalonia Styling

docs/developers/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1>The Nexus Mods App</h1>
2+
<h1>The Nexus Mods app</h1>
33
<img src="../Nexus/Images/Nexus-Icon.png" width="150" align="center" />
44
<br/> <br/>
55
Mod With Confidence
@@ -18,9 +18,9 @@ If you want to know how the App works, see [Mod With Confidence](./ModWithConfid
1818

1919
## The Team
2020

21-
### Nexus Mods App Team
21+
### Nexus Mods app Team
2222

23-
- [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/).
23+
- [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/).
2424
- [Al12rs](https://github.com/Al12rs): Lead developer of [Mod Organizer 2](https://www.modorganizer.org/).
2525
- [erri120](https://github.com/erri120): Developer of [Wabbajack](https://www.wabbajack.org) and creator of [GameFinder](https://github.com/erri120/GameFinder).
2626
- [Sewer56](https://github.com/Sewer56): Creator of [Reloaded-II](https://reloaded-project.github.io/Reloaded-II/).

docs/developers/misc/ComparisonOfFileManagementSystems.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ files, that interact with the game via their presence in game folders. This incl
1313
supported by the game, and proxy DLLs that override certain methods in the game engine (such as ENBs).
1414

1515

16-
| | Nexus Mod Manager | Vortex | Mod Organizer 2 | Nexus Mods App |
16+
| | Nexus Mod Manager | Vortex | Mod Organizer 2 | Nexus Mods app |
1717
|------------------------|-------------------------------------|---------------------------------|------------------------------------------------|------------------------------------------------------------|
1818
| Deployment Method | Hard/Sym Links | Hard/Sym Links | UVFS | File Copy / Hashing |
1919
| File Deleted / Created | Changes are left in Game Folder | Changes are left in Game Folder | File exists after create, original is replaced | Detected, new modlist with changes is created |

docs/developers/misc/DrawbacksOfNexusApproach.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
!!! warning "The Nexus Mods App approach requires more book-keeping than traditional approaches"
1+
!!! warning "The Nexus Mods app approach requires more book-keeping than traditional approaches"
22

33
- Keeping backup of original game files.
44
- Watching for changes in game folder. (Backup user/game generated files)
@@ -11,7 +11,7 @@ This takes considerable CPU and Disk resources.
1111

1212
This typically results in an increase in disk usage of 60-100% compared to regular game size.
1313

14-
!!! tip "For a 10 GB game, an additional 6-10 GB of space will be used once 'managed' with the Nexus Mods App."
14+
!!! tip "For a 10 GB game, an additional 6-10 GB of space will be used once 'managed' with the Nexus Mods app."
1515

1616
For desktops, storage today is fairly cheap, however, there are still limitations.
1717

@@ -34,7 +34,7 @@ This may be problematic if the user wants to immediately play their game, as the
3434

3535
## Footnote
3636

37-
!!! nexus "The Nexus Mods App is built with the hardware of today in mind. Taking advantage of fast CPUs and SSDs."
37+
!!! nexus "The Nexus Mods app is built with the hardware of today in mind. Taking advantage of fast CPUs and SSDs."
3838

3939
With sufficient optimization and planning, we hope these processes become mostly 'transparent' to end users,
4040
so they don't really notice a difference.

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1>The Nexus Mods App</h1>
2+
<h1>The Nexus Mods app</h1>
33
<img src="./Nexus/Images/Nexus-Icon.png" width="150" align="center" />
44
<br/> <br/>
55
Mod With Confidence
@@ -18,7 +18,7 @@
1818
User Guides
1919
</span>
2020
</a>
21-
<p>Tutorials and guides to help you get started with the Nexus Mods App.</p>
21+
<p>Tutorials and guides to help you get started with the Nexus Mods app.</p>
2222
</th>
2323
<th style="text-align: center; border: .05rem solid var(--md-typeset-table-color); width: 50%; vertical-align: middle">
2424
<a href="./developers/">

docs/users/Uninstall.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# How to Uninstall the Nexus Mods App
1+
# How to Uninstall the Nexus Mods app
22

3-
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.
3+
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.
44

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

@@ -11,11 +11,11 @@ Please keep in mind that the app will make the following changes to your system
1111

1212
## Uninstall on Windows 10/11
1313

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

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

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Nexus Mods App
1+
site_name: Nexus Mods app
22
site_url: https://github.com/Nexus-Mods/NexusMods.App
33

44
repo_name: Nexus-Mods/NexusMods.App

0 commit comments

Comments
 (0)