Skip to content

Commit

Permalink
FAQ from the discord, plus a few items. For 179
Browse files Browse the repository at this point in the history
  • Loading branch information
budak7273 committed Mar 25, 2023
1 parent 6797a7c commit f725fe8
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 0 deletions.
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* xref:index.adoc[Introduction]
* xref:faq.adoc[FAQ - Frequently Asked Questions]
* xref:SMLConfiguration.adoc[SML Configuration]
* xref:SMLChatCommands.adoc[SML Commands]
* xref:ManualInstallDirections.adoc[Manual Installation]
Expand Down
177 changes: 177 additions & 0 deletions modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
= Frequently Asked Questions

You can find answers to frequently asked questions on the modding discord (and about modding in general) here.

Consider using your browser's Find on Page functionality (usually `Ctrl+F`)
to quickly search this page for key words in your question.

Is there a question you see asked a lot and would like to see it here?
Feel free to discuss them on the https://discord.gg/xkVJ73E[Discord Server],
or add them yourself via the 'Edit this Page' button in the top right.

== How do I install mods?

Please follow the instructions here:

image:https://cdn.discordapp.com/attachments/599990474668769290/721691062359425054/smminstall_03.png[SMM tutorial screenshot]

== The mod manager can't find my game!

You might see error messages like:
- `No Satisfactory Installs Found`

SMM queries the APIs of the Epic and Steam game store apps to determine where your game is.
If you moved its location after installation manually, your installer client will not know where it is.

You will need to reinstall your game through your store client so that it is in a known location.

This will not affect your saves.

== Can I add mods to a save I've already started?

It varies depending on the mod, but in general, yes, this is totally fine.
The mod should say on its mod page on ficsit.app if it can't be added to an in-progress game.

== Do mods work with multiplayer?

It is up to the mod developer to support multiplayer.
Check the mod's page on ficsit.app for information about multiplayer support.

If the mod page doesn't say, try it out yourself and see!

== Are Satisfactory mods safe?

_Or: 'Why does Satisfactory Mod Manager trigger my antivirus?'_

Using Satisfactory mods is safe, as long as you only download mods from ficsit.app and install them via the https://smm.ficsit.app/[Mod Manager].

All files uploaded to ficsit.app are tested for malware and such before they are approved for download.

Your computer may claim that the Mod Manager is unsafe when you try to open it.
This is because the mod manager does not have a
https://comodosslstore.com/resources/what-is-signing-certificate/[signing certificate].
The certificate costs hundreds per year.
It's completely unnecessary for normal operation, and not worth it to pay for it.

But rest assured, this community created Satisfactory Mod Manager from scratch.
We all use it. Provided you only get it via https://smm.ficsit.app/ we can assure you it is safe.
You can find the source code for it here: https://github.com/satisfactorymodding/SatisfactoryModManager

== How do I use <insert mod name here>?

It is up to the mod developer to inform you how to use their mod.
Check the mod's page on ficsit.app for documentation.

Generally, most mods will require you to unlock something in the HUB or MAM before you can use them.
Mods can be configured from the 'Mods' tab on the main menu,
or from in-game via the 'Mod Configs' tab on the pause menu.

== Do mods work with Experimental?

It is up to the mod developer to support Satisfactory's experimental branch.
Check the mod's page on ficsit.app for support.

== Satisfactory Mod Manager is open, but I can't see it's window!

The program's window somehow got offscreen.
We're still not sure what causes this.
To fix it you need to edit the `%appdata%\SatisfactoryModManager\settings.json` file
and within the `windowLocation` property, set the `x` and `y` to 0 to bring the window back on the screen.

Restart SMM after you do that.

== Where do I get help with a mod that is not in the mod portal?

We try to keep everything we work on organized through the ficsit.app mod portal.
If you need help with something that isn't there,
ask nicely in the `#help-using-mods` discord channel,
or message the developer directly.

== What happens if I open up a save without mods installed?

If you were to load up a save file without mods,
all of the content from those mods will simply vanish from the save,
and the game should load just fine with no modded content.

Keep in mind that after saving the game after loading it with no mods,
the modded content would be permanently gone from that point on.
So, if you want to keep modded content, don't play in that save without your mods installed!

If you ever load a save without mods by accident,
just quit the game without saving and launch the game with your mods, your content should still be there.

== How do I make my own mod?

If you're looking to write your own mods, we suggest you start with
making blueprint mods first rather than C++ mods.
Check out the xref:Development/BeginnersGuide/index.adoc[Getting Started Guide]
and consider picking up the `Aspiring Modder` role in our https://discord.gg/xkVJ73E[Discord]'s `#rules` channel.

== How do I share my mods with my friends for multiplayer?

You can use the Mod Manager's profile import/export functionality.

image:https://cdn.discordapp.com/attachments/555507339969560586/833748278456746014/unknown.png[SMM Import/Export screenshot]

== Where can I find the game's log files?

You can find various log files at different locations:

- In your game install folder, `pre-launch-debug.log` and `SatisfactoryModLoader.log`
- At `%localappdata%/FactoryGame/Saved/logs`, where FactoryGame.log is located

The easiest way to gather logs is the Mod Manager's "generate debug info" feature:

image:https://cdn.discordapp.com/attachments/719242895114108938/1089039840512852019/debuginfo.png[SMM Generate Debug Info screenshot]

== How do I verify my game files?

On Steam:

image:https://cdn.discordapp.com/attachments/719242895114108938/1089039933446037605/unknown.png[Steam screenshot]

On Epic:

image:https://cdn.discordapp.com/attachments/719242895114108938/1089039946263838751/unknown.png[Epic screenshot]

== Why is the mod manager downloading slowly?

You might see error messages like:
- `Unexpected error while downloading file: getaddrinfo ENOENT github.com`
- `Unexpected error while downloading file: read ECONNRESET`
- `Unexpected error while downloading file: unable to verify the first certificate`

Internet restrictions mess with our services.
To work around this, download the mod files mentioned in the error message from SMR manually.
If they are named [modname].zip rename them to [modname].smod, then place the file into
`%localappdata%\SatisfactoryModManager\downloadCache\smlVersions\[the SML version you need]` for SML and
`%localappdata%\SatisfactoryModManager\downloadCache\mods` for everything else.

== The mod manager can't download any mods

You might see messages like:
- `error while downloading file [...] Premature close`
- `Error 3 attempts to download <ModName> failed`
- `Error: Unexpected error while downloading file connect ETIMEDOUT`

Your internet speed is likely too slow and the download is being cut off early.
Try disabling the mod manager's timeout as shown below.

image:https://cdn.discordapp.com/attachments/719242895114108938/1089041903342862336/unknown.png[Timeout disable screenshot]


== How can I troubleshoot crash issues?

The easiest way to gather logs is the Mod Manager's "generate debug info" feature and send the file on the Modding Discord's `#help-using-mods` discord channel.

image:https://cdn.discordapp.com/attachments/719242895114108938/1089039840512852019/debuginfo.png[SMM Generate Debug Info screenshot]

You can also follow this process to track down which mod(s) you have installed are leading to a crash (or other undesired behavior):

image:https://cdn.discordapp.com/attachments/719242895114108938/1089043908174037023/Satisfactory_Troubleshooting_v2.png[Troubleshooting flowchart]

== How can I tell what mod added an item/milestone/recipe/thing?

Consider using https://ficsit.app/mod/TFIT[The Ficsit Information Tool]
and https://ficsit.app/mod/MAMTips[MAM Enhancer]
mods which add tools to help you identify content.

0 comments on commit f725fe8

Please sign in to comment.