From 9b073e35ca0da9a83127c69aa80e53950c662de7 Mon Sep 17 00:00:00 2001 From: Rob B Date: Sat, 14 Sep 2024 02:51:10 -0400 Subject: [PATCH] 1.0 dependency information --- cspell.json | 1 + .../pages/Development/UpdatingFromSml37.adoc | 58 +++++++++++++------ .../Development/UpdatingToNewVersions.adoc | 21 ++++++- 3 files changed, 59 insertions(+), 21 deletions(-) diff --git a/cspell.json b/cspell.json index bda428c6..9c540bda 100644 --- a/cspell.json +++ b/cspell.json @@ -31,6 +31,7 @@ "customizer", "Deantendo", "devcontainer", + "Digby", "disqualifier", "disqualifiers", "doggos", diff --git a/modules/ROOT/pages/Development/UpdatingFromSml37.adoc b/modules/ROOT/pages/Development/UpdatingFromSml37.adoc index ac1a1cad..16713145 100644 --- a/modules/ROOT/pages/Development/UpdatingFromSml37.adoc +++ b/modules/ROOT/pages/Development/UpdatingFromSml37.adoc @@ -29,24 +29,6 @@ follow the directions on the xref:Development/UpdatingToNewVersions.adoc[Updating your Mod] guide to install the updated engine, starter project, and update your mod. -== The Winds of Change are Blowing - -TODO if no pre-1.0 release this is irrelevant - -=== Preparing for 1.0 - -Now is the time to make a backup of your current copy of the game -xref:faq.adoc#PlayOlderVersion[as described in the FAQ] -so you can test mod functionality and extract assets if something you previously referenced is no longer available in 1.0. - -[id="SMLNoLongerHardRequired"] -=== Mods No Longer Require a Dependency on SML - -Although 99% of mods should still depend on SML for its feature set, -Ficsit.app now supports uploading mods without an SML dependency. -If you think your mod is part of the 1%, -read more on the xref:Development/Satisfactory/ModsWithoutSML.adoc[Modding Without SML] page. - == New Features === Session Setting Replication @@ -64,6 +46,8 @@ An example of a mod that implements this functionality is https://ficsit.app/mod Of course, a number of certain things will not be possible without the server also having SML installed. +TODO do the 1.0 custom networking changes Arch mentioned affect this? + === Content Tag Registry SML now offers a registry to assist mods with using @@ -73,6 +57,14 @@ Gameplay Tags are a useful way to introduce some cross-mod compatibility without Read the xref:Development/ModLoader/ContentTagRegistry.adoc[Content Tag Registry] page for more information. +[id="SMLNoLongerHardRequired"] +=== Mods No Longer Require a Dependency on SML + +Although 99% of mods should still depend on SML for its feature set, +Ficsit.app now supports uploading mods without an SML dependency. +If you think your mod is part of the 1%, +read more on the xref:Development/Satisfactory/ModsWithoutSML.adoc[Modding Without SML] page. + == Not Done Yet The following features are not quite ready to use yet. @@ -87,6 +79,8 @@ This should not affect the vast majority of mods. === Decal_Normal Broken on Modded Parts using Mesh Proxies +TODO did 1.0 fix? + Mesh proxies past the first instance may not render correctly. This is a UE5 issue that Coffee Stain is working with Epic Games to resolve. You can work around this for the time being by using a default masked material. @@ -103,6 +97,34 @@ Session Settings still function correctly - their values are saved. In addition to any specific-to-your-mod issues you may encounter, the changes described below _must_ be made in order for your mod to be updated. +=== Dependency Updates + +The following project dependencies have updated. +Install the updated versions as you follow the xref:Development/UpdatingToNewVersions.adoc[Updating your Mod] guide. + +==== Engine Update + +Satisfactory 1.0 brings the game to Unreal Engine 5.3. +Download and set up our custom release while following the +xref:Development/UpdatingToNewVersions.adoc[Updating your Mod guide]. + +==== Wwise Update + +With a new Unreal Engine version comes a new required Wwise update for your project. +The xref:Development/BeginnersGuide/dependencies.adoc#_wwise[Dependencies page Wwise instructions] +lists the new Wwise version and guides you through integrating it into your project as you follow the +xref:Development/UpdatingToNewVersions.adoc[Updating your Mod guide]. + +==== CLang Toolchain Update + +Working with the updated Unreal Engine version requires an updated CLang toolchain. +Insalling it is covered in the +xref:Development/BeginnersGuide/dependencies.adoc#ClangToolchain[Dependencies page CLang Toolchain instructions]. + +=== Understanding New Game Targets + +TODO how does the `FactoryGameSteam`/`FactoryGameEGS` split affect modders and the packaging process? + === Alpakit Changes Understanding the changes to Alpakit, and the new features added in this update, will help you work efficiently. diff --git a/modules/ROOT/pages/Development/UpdatingToNewVersions.adoc b/modules/ROOT/pages/Development/UpdatingToNewVersions.adoc index 24c88b1a..af45e659 100644 --- a/modules/ROOT/pages/Development/UpdatingToNewVersions.adoc +++ b/modules/ROOT/pages/Development/UpdatingToNewVersions.adoc @@ -107,7 +107,7 @@ but it's better to play it safe than regret not making a useful, time-saving bac Storage space is cheap, your time is not. -== Back Up Your Game +=== Back Up Your Game As described in the 'Keep an Old Game Version On Hand' bullet, by keeping an old install of the game on hand, @@ -134,7 +134,7 @@ page to launch this separate copy of the game while still having the new copy set up (even running at the same time) on Steam/Epic. -== Back Up Your Old Engine +=== Back Up Your Old Engine When Coffee Stain updates to a newer version of Unreal Engine, or in the occasion that the SML team patches the engine for various reasons, @@ -173,9 +173,24 @@ This should not be required for the new editor version. You may have to edit a registry key entry to fix this - ask on the Discord for help with this. ==== +== Updating Dependencies + +You may need to install updated project dependencies depending on what has changed in the update. +The version-specific upgrading guide page (check the sidebar) +will tell you where in the docs to find the new version numbers. + +- Engine version + - Updated by Coffee Stain, although sometimes the modding team will release custom engine edits. +- Wwise version + - Updated by Coffee Stain. +- CLang toolchain version + - Updated by Coffee Stain, usually when engine versions are updated. +- Starter Project contents + - This always changes with every SML version, since the Starter Project contains the SML source code. + == Install the New Engine -The new editor version can probably be downloaded from +New editor versions are usually be downloaded from https://github.com/satisfactorymodding/UnrealEngine/releases[the GitHub releases page], but you should keep your eyes on the Discord to see if a specific branch or download link is mentioned instead.