Merge pull request #487 from ow-mods/dev

Some Docs Improvements

Author: xen-42

docs/config.json

@@ -38,7 +38,12 @@
         "name": "GitHub",
         "link": "https://github.com/ow-mods/owml",
         "icon": "github"
+      },
+      {
+        "name": "Nuget",
+        "link": "https://www.nuget.org/packages/OWML",
+        "icon": "boxes"
       }
     ]
   }
-}
+}

docs/content/pages/guides/getting_started.md

@@ -9,7 +9,7 @@ This page will outline how to get a working mod that will simply log a message t
 
 ## Choosing an IDE
 
-An IDE will help`provide the ability to create, edit, and build your mod.
+An IDE will help provide the ability to create, edit, and build your mod.
 
 The recommended IDE for modding is [Visual Studio](https://visualstudio.microsoft.com/){ target="_blank" }, however, stuff like Rider and VSCode can also work. This tutorial will assume you're using Visual Studio.
 
@@ -21,7 +21,7 @@ Head to the [Visual Studio downloads page](https://visualstudio.microsoft.com/th
 
 We want the "Desktop development with .NET" module, this will provide us with the tools we need to build the mod.
 
-After installing Visual Studio, launch it once an then close it, this will ensure certain files are generated.
+After installing Visual Studio, launch it once and then close it, this will ensure certain files are generated.
 
 ## Installing the Template
 
@@ -58,7 +58,7 @@ Now that we have the template installed, open Visual Studio and select "New Proj
 
 Set the project name to the name of your mod, **please note this should NOT have spaces or special characters in it**.  The standard casing for projects is PascalCase, which involves capitalizing the start of every word and removing spaces.
 
-On the next screen, set author name to the name you want to appear in the manager and on the website, **this should also not contain spaces**
+On the next screen, set the author name to the name you want to appear in the manager and on the website, **this should also not contain spaces**
 
 Finally, click "Create Project"
 
@@ -80,30 +80,30 @@ This file is used by OWML to generate the settings menu for your mod, we'll go o
 
 ### {YourProjectName}.csproj
 
-This file tell Visual Studio about your project, it determines stuff like dependencies and versions, you shouldn't need to touch this.
+This file tells Visual Studio about your project, it determines stuff like dependencies and versions, you shouldn't need to touch this.
 
 ## Viewing The C# File
 
-Double-click {YourProjectName}.cs, it should open up in the main editor pane.
+Double-click {YourProjectName}.cs, and it should open up in the main editor pane.
 
 This file should contain a class that has the same name as your project and some methods within that class.
 
 We'll focus on `Start()`. In this method we do two things:
 
 1. We output a message to the console alerting the user that the mod has loaded
-2. We subscribe to the scene loaded event in order to output a message to the log when the SolarSystem scene is loaded.
+2. We subscribe to the scene loaded event to output a message to the log when the SolarSystem scene is loaded.
 
 You may have noticed we use the ModHelper field to achieve console output, ModHelper is a collection of utilities your mod can use to do a variety of things. It's covered in the "Mod Helper" section of the site.
 
 ## Building The Mod
 
-Now that we know what the mod *should* do, let's make sure it actually does it. Building your mod should be as simple as pressing "Solution -> Build Solution" in the menu bar, if you get an error involving Visual Studio not being able to find a path, please see the section below, otherwise skip to "Running The Mod"
+Now that we know what the mod *should* do, let's make sure it does it. Building your mod should be as simple as pressing "Solution -> Build Solution" in the menu bar, if you get an error involving Visual Studio not being able to find a path, please see the section below, otherwise, skip to "Running The Mod"
 
 ### Fixing .csproj.user
 
-Your mod contains a special file called {YourProjectName}.csproj.user, this file tells Visual Studio where to build the mod to, if you've installed the manager in a non-standard location, this file will be incorrect. To fix this, open the manager and select settings, then copy the path in the "OWML Path" field. Copy and paste this value between the `<OutputPath>` and `</OutputPath>`, and add `\Mods` to the end of the path. Then open up your manifest file and copy the `uniqueName` field (don't include the quotes). Paste this value preceded by a `\` a the end of the path.
+Your mod contains a special file called {YourProjectName}.csproj.user, this file tells Visual Studio where to build the mod, if you've installed the manager in a non-standard location, this file will be incorrect. To fix this, open the manager and select settings, then copy the path in the "OWML Path" field. Copy and paste this value between the `<OutputPath>` and `</OutputPath>`, and add `\Mods` to the end of the path. Then open up your manifest file and copy the `uniqueName` field (don't include the quotes). Paste this value preceded by a `\` at the end of the path.
 
-For example, if my mod's uniqueName is `Bwc9876.CoolMod`, my file would look like:
+For example, if my mod's uniqueName is `Bwc9876.CoolMod`, my file would look like this:
 
 ```xml
 <OutputPath>C:\MyCoolFolder\DifferentManagerInstallFolderBcImAHacker\Mods\Bwc9876.CoolMod</OutputPath>
@@ -113,7 +113,7 @@ For example, if my mod's uniqueName is `Bwc9876.CoolMod`, my file would look lik
 
 Now the mod should have appeared in your mod manager at the very bottom, notice how the download count is a dash.
 
-You mod should now be ready to run!
+Your mod should now be ready to run!
 
 Click start game and wait for the title screen to load in. Now search your manager logs (there's a search box) for a message along the lines of "My mod {YourProjectName} is loaded!".  This means your mod was loaded successfully! You can also try loading into the main game and checking the logs for another message from your mod.
 
@@ -123,4 +123,10 @@ When developing your mod you may want to get line numbers in your stack trace. T
 
 ## Next Steps
 
-You've successfully created and built your first Outer Wilds mod, moving forward may require a bit of knowledge in unity and will depend on what exactly you're trying to do. These guides will provide information on how to use various aspects of OWML, but it won't cover everything.  If you ever need help, or even just want to chat about modding, feel free to [join our Discord](https://discord.gg/wusTQYbYTc){ target="_blank" }. There's almost always someone available to help.
+You've successfully created and built your first Outer Wilds mod, moving forward may require a bit of knowledge in unity and will depend on what exactly you're trying to do. You may want to read the following guides to get an idea of how to make your mod:
+
+- [Patching the game with HarmonyX]({{ "Patching"|route }})
+- [Creating custom mod settings]({{ "Creating Mod Settings"|route }})
+- [Publishing your mod]({{ "Publishing Your Mod"|route }})
+
+These guides will provide information on how to use various aspects of OWML, but they won't cover everything.  If you ever need help, or even just want to chat about modding, feel free to [join our Discord](https://discord.gg/wusTQYbYTc){ target="_blank" }. There's almost always someone available to help.

docs/content/pages/guides/mod_settings.md

@@ -9,7 +9,7 @@ This guide outlines how to use OWML's config system to display mod settings in t
 
 ## Editing default-config.json
 
-First things first, you're going to need to define your settings, open up `default-config.json` and add an object called `settings`.
+First things first, you're going to need to define your settings, open up `default-config.json`, and add an object called `settings`.
 
 ```json
 {
@@ -20,7 +20,7 @@ First things first, you're going to need to define your settings, open up `defau
 }
 ```
 
-The settings object is comprised of key-value pairs where the key is the ID of the setting and the value is default value of that setting.  
+The settings object is comprised of key-value pairs where the key is the ID of the setting and the value is the default value of that setting.  
 
 For example, if I wanted a check box called "Party Mode", I would do:
 
@@ -33,7 +33,7 @@ For example, if I wanted a check box called "Party Mode", I would do:
 }
 ```
 
-You can also do other data-types like numbers and strings
+You can also do other data types like numbers and strings
 
 ```json
 {

docs/content/pages/guides/patching.md

@@ -9,17 +9,17 @@ Patching allows you to run code before and after base-game methods.  It also all
 
 ## Decompiling The Game
 
-In order to examine base-game methods and figure out what you need to patch, we recommend you use [DnSpy](https://github.com/dnSpyEx/dnSpy/releases){target="_blank"}, a tool for decompiling and viewing .NET assemblies.
+To examine base-game methods and figure out what you need to patch, we recommend you use [DnSpy](https://github.com/dnSpyEx/dnSpy/releases){target="_blank"}, a tool for decompiling and viewing .NET assemblies.
 
 Once installed, select File -> Open. Then, navigate to the game's folder and open the `Assembly-CSharp.dll` file located in `OuterWilds_Data/Managed`.
 
 You should now see the assembly loaded on the left, most classes in Outer Wilds' assembly do not have a namespace, so they'll be located under a `-`
 
 ![The - Namespace]({{ "images/patching/dnspy.webp"|static }})
 
-Here's some tip for viewing base game code:
+Here are some tips for viewing the base game code:
 
-- If you ever need to find out where a method, class, or variable is used, you can right click it an select "Analyze".
+- If you ever need to find out where a method, class, or variable is used, you can right-click it and select "Analyze".
 - You can jump to the definition of a method, class, or variable by clicking on it, you can also control-click to open it in a new tab.
 - Sometimes the decompiler treats switch statements strangely, it may look like they're simply chaining else ifs when in reality they're using a switch
 
@@ -32,17 +32,17 @@ To prepare for adding patches to our mod we'll do two things:
 
 ### CreateAndPatchAll
 
-To make our patches actually run, we need to execute `Harmony.CreateAndPatchAll` in our `Start` method (technically it doesn't *need* to be in start but you should try to run it as early as possible)
+To make our patches run, we need to execute `Harmony.CreateAndPatchAll` in our `Awake` method (technically it doesn't *need* to be in `Awake` but you should try to run it as early as possible)
 
 ```csharp
 public class MyCoolMod : ModBehaviour {
-    public void Start() {
+    public void Awake() {
         Harmony.CreateAndPatchAll(Assembly.GetExecutingAssembly());
     }
 }
 ```
 
-And that's it! Now our patches will actually be applied
+And that's it! Now our patches will be applied
 
 ### Using A Singleton
 
@@ -81,9 +81,9 @@ A prefix is code that runs before another method.
 
 To create a prefix, add a new method with the `HarmonyPrefix` attribute.
 
-Then, add the `HarmonyPatch` attribute as well, this attribute takes at least two arguments, the first is the type you want to patch, the second is the name of the method you wish to patch.
+Then, add the `HarmonyPatch` attribute as well, this attribute takes at least two arguments, the first is the type you want to patch, and the second is the name of the method you wish to patch.
 
-Let's say I want to log to the console everytime the player dies, to do so I need to prefix `DeathManager.KillPlayer`, so my patch might look something like this:
+Let's say I want to log to the console every time the player dies, to do so I need to prefix `DeathManager.KillPlayer`, so my patch might look something like this:
 
 ```csharp
 [HarmonyPatch]
@@ -104,7 +104,7 @@ public class MyPatchClass {
 Prefixes also allow you to completely stop the original method from running, to do so, make your method return a bool.
 
 - If the boolean returned from the method is `true` the original method will be skipped
-- If the boolean returned from the method if `false` the original method is still run
+- If the boolean returned from the method is `false` the original method is still run
 
 Let's say instead of simply logging when the player dies, we want to prevent it from happening entirely.
 
@@ -126,7 +126,7 @@ A postfix is code that runs after another method.
 
 To create a postfix, add a new method with the `HarmonyPostfix` attribute.
 
-Also add the `HarmonyPatch` attribute, it functions the exact same as it does with prefixes, you need to provide the type to patch and the name of the method to patch.
+Also add the `HarmonyPatch` attribute, it functions the same as it does with prefixes, you need to provide the type to patch and the name of the method to patch.
 
 We'll use `DeathManager.KillPlayer` as an example again:
 
@@ -147,9 +147,9 @@ These next few sections will apply to both Prefixes and Postfixes, so even if th
 
 ### Getting The Object You're Patching
 
-If you want to be able to access the actual object you'r patching you can make your patch take an argument named `__instance`.
+If you want to be able to access the actual object you're patching you can make your patch take an argument named `__instance`.
 
-Let's say I want to log to the console where the Quantum Moon goes to everytime it's observed:
+Let's say I want to log to the console where the Quantum Moon goes to every time it's observed:
 
 ```csharp
 public class MyPatchClass {
@@ -200,7 +200,7 @@ public class MyPatchClass {
 
 You can patch the getters and setters of properties by passing in a third argument to the `HarmonyPatch` attribute of `MethodType.Getter` and `MethodType.Setter` respectively.
 
-For example if I wanted to log the repair fraction everytime ShipComponent.repairFraction is gotten, I would do:
+For example, if I wanted to log the repair fraction every time ShipComponent.repairFraction is gotten, I would do:
 
 ```csharp
 [HarmonyPatch]
@@ -215,9 +215,9 @@ public class MyPatchClass {
 
 ### Patching Overloads
 
-When you want to patch a specific overload of a method, you need to pass the types of the parameters that overload takes as a `Type[]` as a third argument to `HarmonyPatch`.
+When you want to patch a specific overload of a method, you need to pass the types of the parameters that overload takes as a `Type[]` as the third argument to `HarmonyPatch`.
 
-For example if I wanted to log `ReferenceFrameTracker.UntargetReferenceFrame` but only the overload that takes a single `bool`, I would do:
+For example, if I wanted to log `ReferenceFrameTracker.UntargetReferenceFrame` but only the overload that takes a single `bool`, I would do:
 
 ```csharp
 [HarmonyPatch]

docs/content/pages/mod_helper/assets.md

@@ -2,9 +2,6 @@
 Title: Assets
 ---
 
-<!-- TODO: AAAAAAAAAAAAAAAAAA WHY ARE THE SIGNATURES SO WEIRD -->
-<!-- Awaiting context -->
-
 # ModHelper.Assets
 
 This module helps with loading assets from the filesystem.

docs/content/pages/mod_helper/config.md

@@ -12,19 +12,19 @@ Whether your mod is enabled.
 
 ## Settings
 
-A `Dictionary<string, object>` containing your mod's settings, it's recommended to use the below methods to access the settings instead of interfacing with this dict directly.
+A `Dictionary<string, object>` containing your mod's settings, it's recommended to use the below methods to access the settings instead of interfacing with this dictionary directly.
 
 ## GetSettingValue&lt;T&gt;
 
-Gets the settings value from the mod's config with the given key. Deserialized into type `T`
+Gets the setting's value from the mod's config with the given key. Deserialized into type `T`
 
 ### Get Parameters
 
 - `string key`: The key to get
 
 ## SetSettingsValue
 
-Sets the settings value in the mod's config with the given key to the given value.
+Sets the setting's value in the mod's config with the given key to the given value.
 
 ### Set Parameters
 

docs/content/pages/mod_helper/console.md

@@ -16,7 +16,7 @@ Used to log a message to the console.
 
 - `string message`: The message to log
 - *`MessageType type`*: The type of message to log, see below; Defaults to `MessageType.Message`
-- *`string senderType`*: Usually used internally, the type that logged this message, don't pass unless you have to
+- *`string senderType`*: Usually used internally, the type that logged this message, don't pass this unless you have to
 
 ### MessageType Reference
 

docs/content/pages/mod_helper/interaction.md

@@ -21,7 +21,7 @@ public class MyCoolMod : ModBehaviour {
 
 ## GetDependants
 
-Gets a list of all mods that are dependant on the mod with the given uniqueName
+Gets a list of all mods that are dependent on the mod with the given uniqueName
 
 ```csharp
 public class MyCoolMod : ModBehaviour {
@@ -60,7 +60,7 @@ public class MyCoolMod : ModBehaviour {
 
 ## TryGetModApi<T>
 
-Attempts to get the api for the mod with the given unique name. You must define the mod's api as an interface and pass that in as the `T`. Returns `null` if the API couldn't be loaded.
+Attempts to get the API for the mod with the given unique name. You must define the mod's API as an interface and pass that in as the `T`. Returns `null` if the API couldn't be loaded.
 
 ```csharp
 public class MyCoolMod : ModBehaviour {

docs/content/pages/mod_helper/manifest.md

@@ -18,4 +18,4 @@ These properties are converted from camelCase to PascalCase (ex: `uniqueName` ->
 
 ## ModFolderPath
 
-The absolute filepath to your mod's directory, most OWML methods auto-prepend this.
+The absolute file path to your mod's directory, most OWML methods auto-prepend this.

docs/content/pages/mod_helper/menus.md

@@ -4,7 +4,7 @@ Title: Menus
 
 # ModHelper.Menus
 
-Provides utilities to extend base-game menus and ui.
+Provides utilities to extend base-game menus and UI.
 
 ## Interfaces
 
@@ -16,15 +16,15 @@ Represents a menu
 
 ### OnInit
 
-Event that's fired when the menu has been initialized.
+The event that's fired when the menu has been initialized.
 
 ## IModButton
 
 Represents a button
 
 ### OnClick
 
-Event that fires when clicked
+The event that fires when clicked
 
 ### Title
 
@@ -46,11 +46,11 @@ Hides the button
 
 ### OnConfirm
 
-Event that's fired when the confirm button is pressed
+The event that's fired when the confirm button is pressed
 
 ### OnCancel
 
-Event that's fired when the cancel button is pressed
+The event that's fired when the cancel button is pressed
 
 ## IModInputMenu
 
@@ -60,7 +60,7 @@ The event that's fired when the input is confirmed, it expects an Action<stri
 
 ## MainMenu
 
-The main menu of the game, represented by `IModMainMenu`.
+The main menu of the game. It is represented by `IModMainMenu`.
 
 ### IModButtons
 
@@ -73,7 +73,7 @@ The main menu of the game, represented by `IModMainMenu`.
 
 ## PauseMenu
 
-The pause menu, represented by `IModPauseMenu`.
+The pause menu. It is represented by `IModPauseMenu`.
 
 ### IModButtons
 

docs/content/pages/mod_helper/storage.md

@@ -8,24 +8,24 @@ Helps with storing data that persists through different runs using JSON.
 
 ## Load<T>
 
-Loads an object (of type <T>) from the given filepath. Loads the `default` of `T` if the file doesn't exist.
+Loads an object (of type <T>) from the given file path. Loads the `default` of `T` if the file doesn't exist.
 
 ### Load Parameters
 
 (*italicized* = optional)
 
-- `string filename`: The filepath, relative to your mod's directory, of the JSON file to load the object from.
-- *`bool fixBackslashes`*: Replaces back slashes with forward slashes, this can mess up escape characters, defaults to `true`
+- `string filename`: The file path, relative to your mod's directory, of the JSON file to load the object from.
+- *`bool fixBackslashes`*: Replaces backslashes with forward-slashes, this can mess up escape characters; defaults to `true`
 - *`JsonSerializerSettings settings`*: Use custom [JsonSerializerSettings](https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_JsonSerializerSettings.htm){target="_blank"}.
 
 ## Save<T>
 
-Saves an object (of type <T>) to the given filepath. Creates a new file if one doesn't exist.
+Saves an object (of type <T>) to the given file path. Creates a new file if one doesn't exist.
 
 ### Save Parameters
 
 - `T obj`: The object to save.
-- `string filename`: The filepath, relative to your mod's directory, of the file to save the object to.
+- `string filename`: The file path, relative to your mod's directory, of the file to save the object to.
 
 ## Example