From e90d8b416934246ff4dd232b6395674e496ad19b Mon Sep 17 00:00:00 2001 From: Rob B Date: Tue, 9 Apr 2024 13:53:47 -0400 Subject: [PATCH] Address comments from code review --- .../BeginnersGuide/CreateGitRepo.adoc | 5 +-- .../pages/ForUsers/DedicatedServerSetup.adoc | 42 +++++++++---------- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/modules/ROOT/pages/Development/BeginnersGuide/CreateGitRepo.adoc b/modules/ROOT/pages/Development/BeginnersGuide/CreateGitRepo.adoc index 63284aa4..186ee9d8 100644 --- a/modules/ROOT/pages/Development/BeginnersGuide/CreateGitRepo.adoc +++ b/modules/ROOT/pages/Development/BeginnersGuide/CreateGitRepo.adoc @@ -269,9 +269,8 @@ You'll have to resolve conflicts and compile errors on the {cpp} side first to build a working Development Editor copy to open, and the editor could get confused if information from {cpp} parent classes change. -Panakotta has directions on using UE as diff tool separate from a project(?) -https://gist.github.com/Panakotta00/c90d1017b89b4853e8b97d13501b2e62[here], -but it's best to avoid merge conflicts where possible. +Panakotta has directions on setting up UE to launch in diff mode as a git diff/merge tool +https://gist.github.com/Panakotta00/c90d1017b89b4853e8b97d13501b2e62[here]. ## UE4GitDiff diff --git a/modules/ROOT/pages/ForUsers/DedicatedServerSetup.adoc b/modules/ROOT/pages/ForUsers/DedicatedServerSetup.adoc index 0e63ad63..c8a405d3 100644 --- a/modules/ROOT/pages/ForUsers/DedicatedServerSetup.adoc +++ b/modules/ROOT/pages/ForUsers/DedicatedServerSetup.adoc @@ -62,17 +62,6 @@ You could also install ficsit-cli on the server and interact with its file syste [id="GetModManager_SMM"] === Satisfactory Mod Manager -// cspell:ignore CIFS -[IMPORTANT] -==== -SMM cannot currently connect to servers by filesystem path. -This includes local servers (on your computer) and SMB/CIFS or network mounts. - -If you want to manage a server whose files **live on your own computer** -or **you access to the server's files with Windows network file share**, -you must use ficsit-cli instead of SMM until this feature is implemented. -==== - [IMPORTANT] ==== Since dedicated Server support is still a work in progress, @@ -93,6 +82,7 @@ If using the Mod Manager to manage your server: . Open the Mod Manager. . In the left panel, under Other, select "Manage Servers". * Don't see this option? Follow the steps in the "Important" box above to get the right version of Satisfactory Mod Manager. + * Note that if your server is locally installed through Steam or Epic, the mod manager may automatically detect it, allowing you to skip the below step of manually adding it. . Enter server connection details in the popup window. * Decide what method to select and what to enter by reading the link:#FileTransferMethods[File Transfer Methods] section, @@ -172,6 +162,7 @@ image::DedicatedServers/SMM_FTP.png[Satisfactory Mod Manager Example] .Ficsit-CLI FTP Example image::DedicatedServers/CLI_FTP.png[Ficsit-CLI Example] +//cspell:ignore CIFS [id="FileTransferMethods_SMB"] === Filepath or SMB/CIFS @@ -183,17 +174,24 @@ The examples below are for a self-hosted dedicated server. * The authenticating user requires Read/Write/Delete or Read/Modify permissions. * The path should follow this format: -** If using a Windows ficsit-cli install: +** If running your chosen mod management tool on a Windows computer: *** If the server is installed on your local computer, use the file path, for example `C:\EpicGamesGames\SatisfactoryDSExperiment` *** If the server is on a network location: `\\ServerNameOrIP\ShareName\Path` or `//ServerNameOrIP/ShareName/Path` -** If using a Linux ficsit-cli install: -+ -link:https://github.com/satisfactorymodding/ficsit-cli/issues/57[(A bug is currently preventing this from working)] - -** Satisfactory Mod Manager does not currently support SMB connections. - A future release (soon(TM)) will add support for this. - -.Ficsit-CLI Example +** If running your chosen mod management tool on a Linux computer: +*** Neither SMM nor ficsit-cli can connect to SMB/CIFS paths directly, +since they are not a real path that Linux can read. +Instead, they need to be mounted to a local path. +How this is done will vary significantly depending on your setup. +A good starting point is to search `mount cifs to path linux` on your favorite search engine. +* Note that locally installed dedicated servers set up through Steam or Epic +will likely be automatically detected by Satisfactory Mod Manager and appear with the "DS" note in the dropdown. + +// TODO get screenshot +// .Windows Satisfactory Mod Manager Example +// image::DedicatedServers/SMM_SMB.png[Satisfactory Mod Manager Example] +There is not currently an example screenshot for using this approach on the Mod Manager. + +.Windows Ficsit-CLI Example image::DedicatedServers/CLI_SMB.png[Ficsit-CLI Example] [id="Troubleshooting"] @@ -220,8 +218,10 @@ if you see a table with a "Server" column, and a checkmark is present on your se the mod is compatible with dedicated servers. If you see an X or the table is absent, the mod does not yet support dedicated servers. -Satisfactory Mod Manager and ficsit-cli offer a "compatible" filtering mode which, +Satisfactory Mod Manager offers a "compatible" filtering mode which, while managing a server install, causes only server-compatible mods to be displayed. + +Ficsit-cli does not currently have a way to filter mods for dedicated server support. ==== [id="ServerClientConsistency"]