SML3.11 docs

.vscode/tasks.json

@@ -19,7 +19,16 @@
 			"hide": true,
 			"presentation": {
 				"group": "hot-rebuild-server"
-			}
+			},
+			"problemMatcher": [
+				{
+					"base": "$tsc-watch",
+					"background": {
+						"beginsPattern": "Listening on",
+						"endsPattern": "TODO_WHAT_END_PATTERN_TO_USE_SEEMS_FINE_WITH_THIS?"
+					}
+				}
+			]
 		},
 		{
 			"type": "shell",
@@ -31,8 +40,8 @@
 			}
 		},
 		{
-			"label": "Open in browser",
 			"type": "shell",
+			"label": "Open in browser",
 			"windows": {
 				"command": "Start-Process http://127.0.0.1:8000/"
 			},

README.md

@@ -73,7 +73,7 @@ follow the below directions.
 
 #### Installing
 
-1. Install [Node.js](https://nodejs.org/en/download/) (the CI uses 16 but newer should be fine)
+1. Install [Node.js](https://nodejs.org/en/download/) (Check `/.github/workflows/push.yml` to find the exact version, but anything >=20 will probably be fine)
    and [pnpm Package Manager](https://pnpm.io/) through your preferred method.
 
 2. Clone the repository

antora-playbook.yml

@@ -12,7 +12,7 @@ content:
   sources:
     ## Used for prod
     - url: https://github.com/satisfactorymodding/Documentation.git
-      branches: master, v3.9.1, v3.8.0, v3.7.0, v3.6.1, v3.5.1, v3.4.1, v3.3.2, v3.1.1, v2.2.1, v2.1.1, v2.0.0, v1.0.2
+      branches: master, v3.10.0, v3.9.1, v3.8.0, v3.7.0, v3.6.1, v3.5.1, v3.4.1, v3.3.2, v3.1.1, v2.2.1, v2.1.1, v2.0.0, v1.0.2
       edit_url: '{web_url}/blob/{refname}/{path}'
 
     ## Used for dev

lychee.toml

@@ -36,10 +36,15 @@ exclude = [
     # 403s despite being valid page, we should try to get this working somehow, since these links can change without warning
     "https://docs.unrealengine.com/",
     "https://dev.epicgames.com/",
+    "^https://www.unrealengine.com/en-US/blog/.*",
     # Times out despite being valid
     "https://www.adobe.com/learn/substance-3d-designer/web/the-pbr-guide-part-1",
     # Pages often time out and Shouldn't™ ever get deleted anyways
     "https://web.archive.org/web/",
+    # Cloudflare checks this, unlikely to be deleted
+    "^https://superuser.com/.*",
+    # Temporarily allow link to 3.10 docs that won't exist till PR is merged. Clean this up as soon as 3.10 is stable.
+    "https://docs.ficsit.app/satisfactory-modding/v3.10.0/index.html"
 ]
 
 # Exclude these filesystem paths from getting checked.

modules/ROOT/nav.adoc

@@ -13,7 +13,9 @@
 
 * xref:Development/index.adoc[Development]
 
-   ** xref:Development/UpdatingFromSml39.adoc[Updating from SML 3.9.0]
+    ** xref:Development/UpdatingFromSml310.adoc[Updating from SML 3.10.0]
+        *** xref:Development/Migration/ScsMigrationGuide.adoc[SCS Hook Migration Guide]
+        *** xref:Development/Migration/BpHookMigrationGuide.adoc[Blueprint Hook Migration Guide]
     ** xref:Development/UpdatingToNewVersions.adoc[_Updating your Mod_]
     ** xref:Development/BeginnersGuide/index.adoc[Getting Started]
         *** Installing Dependencies
@@ -37,15 +39,17 @@
         *** xref:Development/BeginnersGuide/overwriting.adoc[Class Default Objects (CDOs) and Overwriting Content]
         *** xref:Development/BeginnersGuide/ReleaseMod.adoc[Releasing Your Mod]
         *** xref:Development/BeginnersGuide/ImportingAnotherMod.adoc[Importing Other Mods to your Project]
+// TODO *** xref:Development/ExampleModDirectory.adoc[ExampleMod Feature List] // Also uncomment in StaterProjectStructure.adoc
     ** Git and Modding
         *** xref:Development/BeginnersGuide/LearnGit.adoc[Learning Git]
         *** xref:Development/BeginnersGuide/CreateGitRepo.adoc[Creating a Mod Git Repo]
     ** xref:Development/Cpp/index.adoc[C++ Modding]
         *** xref:Development/Cpp/setup.adoc[Setup]
         *** xref:Development/Cpp/debugging.adoc[Debugging]
-        *** xref:Development/Cpp/hooking.adoc[Hooking]
+        *** xref:Development/Cpp/hooking.adoc[Native Hooking]
 // TODO *** xref:Development/Cpp/GettingBpData.adoc[Working with Assets and Blueprint-Defined Data from {cpp}]
         *** xref:Development/Cpp/thirdparty.adoc[Third Party Libraries]
+// TODO *** xref:Development/Cpp/Cookbook.adoc[Cookbook]
     ** xref:Development/Modeling/index.adoc[3D Modeling]
         *** xref:Development/Modeling/setup.adoc[Workflow Setup]
         *** xref:Development/Modeling/MainMaterials.adoc[Main Materials]
@@ -80,6 +84,7 @@
             **** xref:Development/Satisfactory/EnhancedInputSystem.adoc[Enhanced Input System]
             **** xref:Development/Satisfactory/FactoryTick.adoc[Factory Tick]
             **** xref:Development/Satisfactory/FactoryConnectors.adoc[Factory-Connectors]
+            **** xref:Development/Satisfactory/FactoryLegs.adoc[Factory Legs]
             **** xref:Development/Satisfactory/AbstractInstance.adoc[Abstract Instances]
             **** xref:Development/Satisfactory/ConditionalPropertyReplication.adoc[Conditional Property Replication]
             **** xref:Development/Satisfactory/Savegame.adoc[SaveGame]
@@ -94,7 +99,8 @@
         *** xref:Development/ModLoader/AccessTransformers.adoc[Access Transformers]
         *** xref:Development/ModLoader/Subsystems.adoc[Mod Subsystems]
         *** xref:Development/ModLoader/Configuration.adoc[Configuration]
-        *** xref:Development/ModLoader/SimpleConstructionScript.adoc[Simple Construction Script (SCS) Hooks]
+        *** xref:Development/ModLoader/BlueprintHooks.adoc[Blueprint Hooking System]
+        *** xref:Development/ModLoader/ActorMixins.adoc[Actor Mixins]
         *** xref:Development/ModLoader/WidgetBlueprintHooks.adoc[Widget Blueprint Hooks]
         *** xref:Development/ModLoader/BlueprintInterface.adoc[Blueprint Interface]
         *** xref:Development/ModLoader/SessionSettings.adoc[Session Settings]
@@ -105,12 +111,15 @@
         *** xref:Development/ModLoader/ExtendedAttributeProvider.adoc[Extended Attribute Provider]
         *** xref:SMLConfiguration.adoc[SML Configuration]
         *** Legacy
-            **** xref:Development/UpdatingFromSml38.adoc[Updating from SML 3.8.0]
-            **** xref:Development/UpdatingFromSml37.adoc[Updating from SML 3.7.0]
-            **** xref:Development/UpdatingFromSml36.adoc[Updating from SML 3.6.1]
-            **** xref:Development/UpdatingFromSml35.adoc[Updating from SML 3.5.1]
-            **** xref:Development/UpdatingFromSml34.adoc[Updating from SML 3.4.1]
-            ****  xref:Development/UpdatingFromSml2.adoc[Updating from SML 2.2.1]
+            **** Migration Guides
+                ***** xref:Development/UpdatingFromSml39.adoc[Updating from SML 3.9.0]
+                ***** xref:Development/UpdatingFromSml38.adoc[Updating from SML 3.8.0]
+                ***** xref:Development/UpdatingFromSml37.adoc[Updating from SML 3.7.0]
+                ***** xref:Development/UpdatingFromSml36.adoc[Updating from SML 3.6.1]
+                ***** xref:Development/UpdatingFromSml35.adoc[Updating from SML 3.5.1]
+                ***** xref:Development/UpdatingFromSml34.adoc[Updating from SML 3.4.1]
+                *****  xref:Development/UpdatingFromSml2.adoc[Updating from SML 2.2.1]
+            **** xref:Development/ModLoader/SimpleConstructionScript.adoc[Simple Construction Script (SCS) Hooks]
     ** Editor Tools
         *** xref:Development/EditorTools/SMLEditor/SMLEditor.adoc[SML Editor Utilities]
             **** xref:Development/EditorTools/SMLEditor/ResearchTreeEditor.adoc[Research Tree Editor]

modules/ROOT/pages/CommunityResources/AssetToolkit.adoc

@@ -421,12 +421,17 @@ trying to use the UI usually won't fix them!
 Ask for help on the discord.
 
 There are currently numerous crashing issues when using the UI of the Asset Toolkit plugins as opposed to the command line interface.
-Unless you have a specific reason for using the UI,
-you should probably use the command line directions above to dump and generate assets instead.
+Unless you have a very specific reason for using the UI,
+use the command line directions above to dump and generate assets instead.
 ====
 
-[id="UI_Dump"]
-==== Dumping
++++ <details><summary> +++
+Deprecated UI Instructions
++++ </summary><div> +++
+
+// [id="UI_Dump"]
+// ==== Dumping
+*Dumping*
 
 In order to extract the assets to be imported to the editor,
 launch your copy of Satisfactory and open the in-game developer console,
@@ -442,14 +447,16 @@ or use the `...` button to select a specific path.
 Next, select the asset paths you would like to dump, usually `Game/FactoryGame/`,
 and optionally restrict what is exported with the Asset Type Filter dropdown.
 
-Once you're ready, press "Begin Asset Dumping".
+Once you're ready, press `Begin Asset Dumping`.
 This will take some time; go pet a lizard doggo while you wait.
 
-[id="UI_Generate"]
-==== Generating
+// [id="UI_Generate"]
+// ==== Generating
+
+*Generating*
 
-To open the in-editor interface, navigate to Window -> Developer Tools -> Asset Generator.
+To open the in-editor interface, navigate to Tools -> Miscellaneous -> Asset Generator.
 Check all the asset types and asset paths, and uncheck "Public Project",
 otherwise you will generate placeholder assets again.
 
-image:CommunityResources/AssetToolkit/OpenAssetGeneratorUI.png[image]
++++ </div></details> +++

modules/ROOT/pages/Development/BeginnersGuide/SimpleMod/gameworldmodule.adoc

@@ -382,7 +382,7 @@ This error could appear when launching the game.
 You probably don't have Satisfactory Mod Loader installed in your copy of the game,
 and Unreal Engine is telling you it must be installed for your own mod to function.
 You can package a copy of SML yourself using Alpakit following the steps
-xref:Development/BeginnersGuide/project_setup.adoc#_optional_packaging_sml[on the previous page].
+xref:Development/BeginnersGuide/project_setup.adoc#InstallSML[on the previous page].
 
 === Corrupt data found, please verify your installation
 

modules/ROOT/pages/Development/BeginnersGuide/StarterProject/ObtainStarterProject.adoc

@@ -1,7 +1,10 @@
 = Starter Project
 
-The SML development team provides an Unreal project
-that comes pre-installed with Satisfactory Mod Loader,
+The Starter Project is distributed by the Satisfactory Modding team
+as a GitHub repository named "Satisfactory Mod Loader".
+Despite the name, the repository is actually an Unreal Engine project
+that includes the source code of the Satisfactory Mod Loader (as a plugin),
+the game's {cpp} headers,
 placeholder assets for base game content,
 and some useful developer plugins.
 

modules/ROOT/pages/Development/BeginnersGuide/StarterProject/StarterProjectViaClone.adoc

@@ -14,11 +14,27 @@ check out our xref:Development/BeginnersGuide/LearnGit.adoc[mini tutorial] that
 
 == What Branch to Clone
 
+====
+If you are looking to develop mods for Update 1.0,
+follow the link:https://docs.ficsit.app/satisfactory-modding/v3.10.0/index.html[SML v3.10.0] documentation instead.
+However, we strongly suggest developing mods for Update 1.1 instead as it will be released to the stable branch on June 10th.
+====
+
 // When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
 ====
-This is the *SML v3.10.0* version of the docs.
+This is the *latest stable* version of the docs.
+// This is the *development* version of the docs.
+
+// Stable (Release) and Experimental are currently both the same version - 1.0 Release.
+
+Clone the **`master` branch** to develop a mod for the stable version of SML.
+// You should clone the **`dev` branch** because SML 3.8.? is not released yet.
+
+// You should clone either the **`dev` branch** or the **`master` branch**.
+// Of those two, you probably want whichever branch was pushed to most recently, which you can see
+// https://github.com/satisfactorymodding/SatisfactoryModLoader/branches[on the GitHub repository].
 
-To develop for 3.10.0, clone the `v3.10.0` tag.
+If you're uncertain about which branch to clone, **ask us on the Discord**.
 ====
 
 https://github.com/satisfactorymodding/SatisfactoryModLoader/[Here]

modules/ROOT/pages/Development/BeginnersGuide/StarterProject/StarterProjectViaZip.adoc

@@ -8,12 +8,28 @@ or you will have to repeat some of the setup process again.
 
 == What Version to Download
 
+====
+If you are looking to develop mods for Update 1.0,
+follow the link:https://docs.ficsit.app/satisfactory-modding/v3.10.0/index.html[SML v3.10.0] documentation instead.
+However, we strongly suggest developing mods for Update 1.1 instead as it will be released to the stable branch on June 10th.
+====
+
 // When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
 ====
-This is the *SML v3.10.0* version of the docs.
+This is the *latest stable* version of the docs.
+// This is the *development* version of the docs.
+
+Download a zip of the **`master` branch** to develop a mod for the stable version of SML
+by clicking https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/master.zip[here].
+
+// Download a zip of the **`dev` branch** (because SML 3.8.? is not released yet)
+// by clicking https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/dev.zip[here].
+
+// You should download a zip either of the **`dev` branch** or the **`master` branch**.
+// Of those two, you probably want whichever branch was pushed to most recently, which you can see
+// https://github.com/satisfactorymodding/SatisfactoryModLoader/branches[on the GitHub repository].
 
-To develop for 3.10.0, use this zip:
-https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/tags/v3.10.0.zip
+If you're uncertain about which branch to download, **ask us on the Discord**.
 ====
 
 == Unzipping the Files

modules/ROOT/pages/Development/BeginnersGuide/StarterProjectStructure.adoc

@@ -127,6 +127,8 @@ image:BeginnersGuide/simpleMod/ShowPluginContentInViewer.png[Show Plugin Content
 * xref:Development/EditorTools/SMLEditor/SMLEditor.adoc[SMLEditor]
 ** Editor-only mod that provides helpful utilities to mod creators, such as a mod configuration screen preview and a Research Tree Editor.
 
+// TODO link to xref:Development/ExampleModDirectory.adoc[ExampleMod Feature List] once done
+
 You should not need to edit any of the provided mod files under normal circumstances.
 
 == Plugins Folder

modules/ROOT/pages/Development/BeginnersGuide/dependencies.adoc

@@ -178,12 +178,22 @@ The below box will contain a link to the specific release that you should downlo
 It's imperative that you download the correct engine for the version of the game you're modding
 or you will have to repeat a large amount of the setup process again.
 
+====
+If you are looking to develop mods for Update 1.0,
+follow the link:https://docs.ficsit.app/satisfactory-modding/v3.10.0/index.html[SML v3.10.0] documentation instead.
+However, we strongly suggest developing mods for Update 1.1 instead as it will be released to the stable branch on June 10th.
+====
+
 // When updating the below, remember to update StaterProjectViaClone.adoc, StarterProjectViaZip.adoc, and dependencies.adoc (engine)
 ====
-This is the *SML v3.10.0* version of the docs.
+This is the *latest stable* version of the docs.
+// This is the *development* version of the docs.
+
+// Stable (Release) and Experimental are currently both the same version - 1.0 Release.
 
-To develop for 3.10.0, use this engine version:
-https://github.com/satisfactorymodding/UnrealEngine/releases/tag/5.3.2-css-66
+You should download from the *latest engine release*,
+which an be found at the top of this page:
+https://github.com/satisfactorymodding/UnrealEngine/releases
 ====
 
 Download the following files from the release linked above:
@@ -268,8 +278,8 @@ In the launcher's left sidebar, select the topmost `Wwise` section
 (note: not the "Wwise Audio Lab" section).
 Under the "INSTALL A NEW VERSION" heading,
 click the `Latest` drop-down and change it to `All`.
-Select `2022.1` from the "Major" dropdown.
-Select version `2022.1.10.8393` from the "Version" dropdown.
+Select `2023.1` from the "Major" dropdown.
+Select version `2023.1.3.8471` from the "Version" dropdown.
 Click `Install`.
 
 [WARNING]
@@ -280,7 +290,7 @@ but they are likely to have other incompatible changes that will break the setup
 
 **Try to download the exact Wwise version mentioned above**.
 If you don't see it,
-try any other version starting with `2022.1.10`, preferring newer versions,
+try any other version starting with `2023.1.3`, preferring newer versions,
 or asking for help on the Discord.
 ====
 
@@ -307,20 +317,23 @@ If anything is selected by default, do not uncheck them. They are required for V
 Click `Next` (you may need to scroll down to see the button).
 You don't need to add any plugins,
 so press `Select None` in the top right then `Install` in the bottom left to begin the installation process.
-Accept the terms and conditions prompts that appear along the way.
+Accept any User Account Control or Terms and Conditions prompts that appear along the way.
 
 == Satisfactory Mod Manager
 
 xref:index.adoc#_satisfactory_mod_manager_aka_smm[Satisfactory Mod Manager]
 is a powerful tool that automatically install the correct versions of mod dependencies for you.
-Basically all end users will be using this tool to install your mods.
+All end users will be using this tool,
+or its command-line colleague
+xref:ForUsers/DedicatedServerSetup.adoc#GetModManager_CLI[ficsit-cli],
+to play with your mods.
 
-As a developer, you can use it to install the https://ficsit.app/mod/SML[Satisfactory Mod Loader (SML)] mod
-and install other mods to test with.
+Although you don't need to install it to develop mods,
+you can use it to download other mods to test with,
+such as xref:ForUsers/Tags.adoc[helpful mods tagged with `#developer-utility`],
+and to view your mod web page within the mod manager to check its appearance and formatting.
 
-Alternatively, once your modding environment is set up,
-you can use Alpakit to automatically build and install SML.
-This process will be explained on the next page.
+To install Satisfactory Mod Manager, follow the directions xref:ForUsers/SatisfactoryModManager.adoc[here].
 
 == Next Steps
 

modules/ROOT/pages/Development/BeginnersGuide/project_setup.adoc

@@ -50,11 +50,11 @@ and ensure the "Unreal Engine project path" matches the path to your project.
 Click on the `Integrate Wwise in Project...` button.
 
 Change the "Integration Version" drop-down from `Latest` to `All` otherwise Wwise will not show the version you care about.
-Then use the "Major" and "Version" dropdowns to select the same version you installed earlier (likely `2022.1.10.8393`). 
+Then use the "Major" and "Version" dropdowns to select the same version you installed earlier (likely `2023.1.3.8471`). 
 The version number may have additional numbers on the end of it e.g.
-`2022.1.10.8393.2898` but as long as it starts with `2022.1.10.8393` it should work.
+`2023.1.3.8471.2970` but as long as it starts with `2023.1.3.8471` it should work.
 
-If version `2022.1.10.8393` does not appear even after you have selected `All`,
+If version `2023.1.3.8471` does not appear even after you have selected `All`,
 edit the `.uproject` file in a text editor to be sure that `EngineAssociation`
 is set to `5.3.2-CSS`.
 
@@ -492,13 +492,17 @@ and delete the folder named with the
 xref:Development/BeginnersGuide/SimpleMod/gameworldmodule.adoc#ModReference[Mod Reference]
 of the mod you wish to uninstall.
 
-== (Optional) Packaging SML
+[id="InstallSML"]
+== Packaging SML
 
-Note that if you have not yet installed the Satisfactory Mod Loader (SML) in your game client,
+If you have not yet installed the Satisfactory Mod Loader (SML) in your game client from playing with mods before,
 you can use Alpakit to build SML for you and put it in the right folder.
 Simply press the `Alpakit!` button next to `Satisfactory Mod Loader (SML)` in the list.
 
-In the future, using a locally build copy of SML could cause problems
+Alternatively, you can use
+xref:ForUsers/SatisfactoryModManager.adoc#_installing_mods[the Mod Manager to install SML from a published version].
+
+As a note for the future, using a locally built copy of SML could cause problems
 if your copy of the Starter Project is older than the latest SML release,
 in which case you should
 xref:Development/UpdatingToNewVersions.adoc[update your Starter Project]