11 KiB
Satisfactory Setup Guide
Required Software
- Satisfactory, either
- Steam Satisfactory (Steam)
- Epic Satisfactory (Epic)
- Satisfactory Mod Manager, either
- Automatically via smm.ficsit.app or
- Manually via latest stable release on GitHub
Overview
This guide will walk you through installing the Satisfactory Archipelago mod via the Mod Manager and entering Archipelago server connection details in the mod configuration options. The server will send the required data to the game client and create the content required by the seed at runtime.
Create a Config (.yaml) File
What is a config file and why do I need one?
Your config file contains a set of configuration options which provide the generator with information about how it should generate your game. Each player of a multiworld will provide their own config file. This setup allows each player to enjoy an experience customized for their taste, and different players in the same multiworld can all have different options.
Where do I get a config file?
The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Satisfactory player settings page: Satisfactory Settings Page
⚠ Pre-Release Note: The above link does not work because it would go to the live Archipelago site. Manually construct a yaml yourself from the one pinned in the Discord: https://discord.com/channels/731205301247803413/1018853131859267656
Verifying Your Config File
If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page. YAML Validator page: Yaml Validation Page
⚠ Pre-Release Note: The above link does not work because it would go to the live Archipelago site. Manually construct a yaml yourself from the one pinned in the Discord: https://discord.com/channels/731205301247803413/1018853131859267656
Starting Inventory
TODO talk about how you can use the Plando? Weighted Options? Manual yaml editing? page to edit your starting inventory, giving yourself specific technologies (ex. splitters/mergers) and item bundles (ex. start with extra ) out of the gates.
Advanced Configuration
Advanced users can utilize the Weighted Options Page and Plando to futher customize their experience.
⚠ Pre-Release Note: The above links do not work because it would go to the live Archipelago site. See these links instead:
Prepare to Host Your Own Satisfactory Game
Defining Some Terms
In Archipelago, multiple Satisfactory worlds may be played simultaneously. Each of these worlds must be hosted by a Satisfactory game client, each of which is connected to the Archipelago Server.
This guide uses the following terms to refer to the software:
- Archipelago Server - The central Archipelago server, which connects all games to each other.
- Satisfactory Client - The Satisfactory instance which will be used to host, and play, the game.
It is important to note that the Satisfactory Archipelago mod is not yet compatible with dedicated servers or in-game multiplayer. Each Satisfactory world must be hosted and played by an individual player.
Installing Satisfactory
Purchase and install Satisfactory via one the sources linked above. Launch the game at least once to ensure that the Mod Manager can detect the game's install location.
Make sure that you are running the correct branch of the game (Early Access or Experimental) that Archipelago supports. Learn how to switch branches here: Satisfactory Modding Documentation FAQ: Switching Branches
Installing Satisfactory Mod Manager
The Mod Manager is used to install and manage mods for Satisfactory. It automatically detects your game install location and automatically handles mod dependencies for you.
Download the Mod Manager here: Satisfactory Mod Manager automatic download via ficsit.app
Directions for setting and using up the Mod Manager can be found here: Satisfactory Modding Documentation FAQ: Installing the Mod Manager
Installing the Archipelago Mod
Once the Mod Manager is installed you can install mods directly in the manager or via the Satisfactory Mod Repository website.
Inside the Mod Manager, search for and install the "Archipelago Randomizer". Alternatively, visit the mod page: Archipelago Randomizer mod on ficsit.app. Once on the mod page, click the "Install" link in the Latest Versions card.
The Mod Manager will install all required dependency mods for you with no additional action required.
As soon as you have the relevant mods installed, you do not need to launch the game through the Mod Manager - desktop shortcuts, Steam, Epic. etc. will all launch the game with mods still loaded.
Installing Additional Mods
You may also wish to install some of the suggested mods mentioned on the Archipelago Info page for Satisfactory.
⚠ Pre-Release Note: The above link does not work because it would go to the live Archipelago site. Use this link instead: https://github.com/Jarno458/Archipelago/blob/Satisfactory/worlds/satisfactory/docs/en_Satisfactory.md#additional-mods
Entering Connection Details
After you have installed the mods, launch the game via the Mod Manager or via your preferred method. Once the game has launched, click on the 'Mods' button on the main menu and open the Archipelago entry.
Next, enter the connection details in the relevant fields. You can hover over the fields in the menu for more information and example values.
- URI: Archipelago Server URI and port, for example,
archipelago.gg:49236 - Username: The name you entered as your Player Name when you created your config file. It's also listed in the Name column of your room page.
- Password: The password for your slot, blank if you did not assign one.
- Archipelago Enabled: Make sure this is checked, otherwise no server connection will be attempted.
- Debug Mode: Don't enable it unless the developers ask you to when reporting problems.
- Force override settings in save: Leave false for now. It is useful when the server changed ports. Read its tooltip for more info.
Note that the Satisfactory Client does not need a copy of your Archipelago config file. The mod communicates with the Archipelago Server, which already has your config file, to generate the required content at runtime.
Creating a New World
Once you have entered connection details, create a new world using the game's New Game menu. Make sure to check 'Skip Intro' if you don't want to deal with the game's tutorial sequence. Consider enabling Advanced Game Settings to allow dealing with bugs that may arise. Within the Advanced Game Settings menus, you may wish to switch the "Keep Inventory" setting to "Keep Everything" to avoid dropping items on death, although this will never lock you out of progression.
Verifying Connection Success
Once connected to the AP server,
you can issue the /help command in the game's chat to list available commands, such as /hint.
For more information about the commands you can use, see the Commands Guide.
Note that Archipelago commands are not prefixed with ! inside of Satisfactory.
You may wish to use the Text Client to run commands since Satisfactory's in game chat is not very user friendly.
⚠ Pre-Release Note: The above link does not work because it would go to the live Archipelago site. Use this link instead: https://archipelago.gg/tutorial/Archipelago/commands/en
Troubleshooting
TODO what is the scope of this section? How much do we help with vs. sending people somewhere else
- If you are having trouble connecting to the Archipelago server, make sure you have entered the correct server address and port. The server port may have changed if the room went to sleep. If you need to enter a new port, use the "Force override settings in save" option on the mod options menu before loading into a save.
- If you are having trouble using the Satisfactory Mod Manager, join the Satisfactory Modding Discord for support.
- If you encounter a game crash, please report it to us via the Satisfactory Modding Discord.
Please include the following information:
- What you were doing when the crash occurred.
- Use the Mod Manager to generate a debug zip and attach that file. Satisfactory Modding Documentation FAQ: Generating a debug zip
- Attach your Archipelago config file to your report.
Additional Resources
- Satisfactory Wiki: Satisfactory Official Wiki
- Satisfactory Modding FAQ page: Satisfactory Modding Documentation FAQ
- Satisfactory Archipelago Item names (for hints/starting inventory/etc.) can be found on the mod's github