mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-05-26 21:19:55 -07:00
Added Satisfactory to latest master
This commit is contained in:
Jarno Westhof
@@ -0,0 +1,174 @@
|
||||
# Satisfactory
|
||||
|
||||
<!-- Spellchecker config - cspell:ignore FICSIT Nobelisk Zoop -->
|
||||
|
||||
## Where is the settings page?
|
||||
|
||||
The [player settings page for this game](../player-settings)
|
||||
contains all the options you need to configure and export a config file.
|
||||
|
||||
> ⚠ 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>
|
||||
|
||||
## What does randomization do to this game?
|
||||
|
||||
In Satisfactory, the HUB Milestones and MAM Research Nodes are shuffled,
|
||||
causing technologies to be obtained in a non-standard order.
|
||||
The costs of unlocking these technologies are also shuffled.
|
||||
There are also a few new purchases in the AWESOME Shop.
|
||||
An alternate recipe you've never used before may end up required to progress, for example.
|
||||
|
||||
<!-- TODO
|
||||
Hard Drive scanning results are also optionally shuffled,
|
||||
meaning that scanning a Hard Drive will result in a selection between 3 random items.
|
||||
-->
|
||||
|
||||
## What is the goal of Satisfactory?
|
||||
|
||||
The player can choose from a number of goals using their YAML settings:
|
||||
|
||||
- Complete a certain [Space Elevator](https://satisfactory.wiki.gg/wiki/Space_Elevator) tier
|
||||
<!-- TODO with optionally randomized required items -->
|
||||
- Supply items to the [AWESOME Sink](https://satisfactory.wiki.gg/wiki/AWESOME_Sink) totalling a configurable amount of points to finish.
|
||||
|
||||
In the current implementation, selecting multiple goals
|
||||
requires completion of any one goal to complete the slot.
|
||||
|
||||
## What Satisfactory items can appear in other players' worlds?
|
||||
|
||||
Satisfactory's technologies are removed from the HUB and MAM and placed into other players' worlds.
|
||||
When those technologies are found, they are sent back to Satisfactory
|
||||
along with, optionally, free samples of those technologies.
|
||||
|
||||
Other players' worlds may have Resource Bundles of building materials, equipment, ammunition, or FICSIT Coupons.
|
||||
They may also contain Traps.
|
||||
|
||||
## What is a Free Sample?
|
||||
|
||||
A free sample is a package of items in Satisfactory granted in addition to a technology received from another world.
|
||||
For equipment and component crafting recipes, this is the output product.
|
||||
For buildings, this is the ingredients for the building.
|
||||
For example, receiving the [Nobelisk Detonator MAM Node](https://satisfactory.wiki.gg/wiki/Nobelisk_Detonator#Unlocking)
|
||||
would give you one Nobelisk Detonator and 50 Nobelisk,
|
||||
receiving the [Jump Pads Milestone](https://satisfactory.wiki.gg/wiki/Milestones#Tier_2)
|
||||
would give you the ingredients to construct 5 Jump Pads and 5 U-Jelly Landing Pads, etc.
|
||||
In Satisfactory multiplayer, each Satisfactory player gets a copy of the sample.
|
||||
|
||||
You can separately configure how many samples to receive for buildings, equipment, and crafting components
|
||||
in your player settings.
|
||||
|
||||
## What is a Resource Bundle?
|
||||
|
||||
A resource bundle is a package of items received as a check from another world.
|
||||
They must be collected by constructing an Archipelago Portal.
|
||||
For example, `Bundle: Jetpack` would contain a single jetpack.
|
||||
|
||||
## What does another world's item look like in Satisfactory?
|
||||
|
||||
In Satisfactory, items which need to be sent to other worlds appear in the HUB and MAM as info cards
|
||||
in a similar manner to the base game's building and recipe unlocks.
|
||||
Info cards have the Archipelago icon
|
||||
and are color coded to indicate what Archipelago progression type they are.
|
||||
|
||||
Hover over them to read a description, since many Satisfactory UIs (such as the MAM) cut this information off.
|
||||
|
||||
|
||||
|
||||
Upon successful unlock of the technology, the item will be sent to its home world.
|
||||
|
||||
## When the pioneer receives an item, what happens?
|
||||
|
||||
When the player receives a technology, it is instantly unlocked and able to be crafted or constructed.
|
||||
A message will appear in the chat to notify the player,
|
||||
and if free samples are enabled the player may also receive some items delivered directly to their inventory.
|
||||
Bundles will instantly be added to the Archipelago Portal network and can be collected at any Archipelago Portal.
|
||||
|
||||
## What is EnergyLink?
|
||||
|
||||
EnergyLink is an energy storage supported by certain games that is shared across all worlds in a multiworld.
|
||||
In Satisfactory, if enabled in the player settings, all base-game Power Storage buildings will act as Energy Link interfaces.
|
||||
They will deposit surplus produced energy and draw energy from the shared storage when needed.
|
||||
|
||||
Just like the base game, there is no limit to the discharge/draw rate of one building,
|
||||
and each Power Storage provides TODO MW of charging throughput.
|
||||
The shared storage has unlimited capacity, but TODO% of energy is lost during depositing.
|
||||
The amount of energy currently in the shared storage is displayed in the Archipelago client
|
||||
and appears in the Power Storage building UI.
|
||||
|
||||
## What is the Archipelago Portal?
|
||||
|
||||
The Archipelago Portal is a building that serves multiple purposes:
|
||||
|
||||
- Collecting received "Resource Bundle"-type items.
|
||||
- Transfering items within your Satisfactory world
|
||||
- Transfering items between multiple Satisfactory worlds
|
||||
- Gifting items to other games that support the Archipelago Gifting system.
|
||||
|
||||
The building requires power to operate.
|
||||
You can build multiple portals or use faster belts to increase their bandwith.
|
||||
However, they currently have no filtering capabilities,
|
||||
so you must deal with this problem when handling their output items.
|
||||
|
||||
## What is a Trap?
|
||||
|
||||
You can optionally enable that some Traps be mixed into the item pool.
|
||||
Traps are items that will instantly trigger some sort of surprise on the player when received.
|
||||
Their severity varies from annoyance to killing the player.
|
||||
A few traps are included in the default options.
|
||||
|
||||
## Where do I run Archipelago commands?
|
||||
|
||||
You can use the game's build-in chat menu.
|
||||
Check the game's keybinding options to see how to open it.
|
||||
Run the `/help` command to list all available commands.
|
||||
Note that Archipelago commands are _not_ prefixed with `!` inside of Satisfactory.
|
||||
|
||||
Note that multiple base-game bugs affect the chat menu's functionality
|
||||
and Archipelago can put a lot of info into the chat.
|
||||
You may wish to launch the Archipelago Text Client and use it to run commands instead of the game's chat.
|
||||
|
||||
## Multiplayer and Dedicated Servers
|
||||
|
||||
It is possible to host a Satisfactory Archipelago Slot using the game's built in host-and-play multiplayer, allowing other Satisfactory players to join in constructing your factory.
|
||||
This experience is wonderfull - but there are few things not yet properly working for multiplayer
|
||||
* Death-links do not kill clients
|
||||
* Starting inventory for clients is missing
|
||||
Remember that client players must have the same mods installed as the host player to join,
|
||||
however, they do not need to configure Archipelago connection settings.
|
||||
|
||||
Dedicated server support is only working for windows at the moment.
|
||||
|
||||
## Additional Mods
|
||||
|
||||
It is possible to load other Satisfactory mods in tandem with the Archipelago Satisfactory mod.
|
||||
However, no guarantee is made that any mods except the "Certified Compatible Mods" listed below will work correctly,
|
||||
especially if they affect game progression, recipes, or add unlocks to base-game technologies.
|
||||
|
||||
Content added by unaffiliated mods may end up inaccessible based on your chosen slot settings,
|
||||
for example, its milestones could be in a tier that is after your goal.
|
||||
You may be able to write patches using [ContentLib](https://ficsit.app/mod/ContentLib)
|
||||
to adjust other mods to work with your slot settings,
|
||||
but doing so is out of the scope of this guide.
|
||||
|
||||
Use unaffiliated mods at your own risk, support will not be offered.
|
||||
|
||||
The following mods are **required dependencies** of the Archipelago mod and **will automatically be installed for you**
|
||||
when you install it using the Satisfactory Mod Manager:
|
||||
|
||||
- [ContentLib](https://ficsit.app/mod/ContentLib) - Runtime content generation.
|
||||
- [Free Samples](https://ficsit.app/mod/FreeSamples) - Used to implement the Free Samples options. Even if you don't have this game option enabled, the mod will still be present, but its functionality will be disabled.
|
||||
- [MAM Enhancer](https://ficsit.app/mod/MAMTips) - Allows viewing MAM research nodes in detail. Enables you to hover over the items/unlocks of a node to see more info, especially important when their names get long.
|
||||
- [FixClientResourceSinkPoints](https://ficsit.app/mod/FixClientResourceSinkPoints) - Fixes a bug where AWESOME Sink points values aren't loaded properly on multiplayer clients.
|
||||
|
||||
### Certified Compatible Mods
|
||||
|
||||
The following mods are known to work with Archipelago:
|
||||
|
||||
<!-- Nog's Chat currently broken -->
|
||||
<!-- - [Nog's Chat](https://ficsit.app/mod/NogsChat) - Easily repeat past chat messages, improving the user experience of running Archipelago commands in the game's chat window. -->
|
||||
- [The FICSIT Information Tool](https://ficsit.app/mod/TFIT) - View how many Sink Points items are worth and how points-profitable recipes are. Helpful for the AWESOME Points goal.
|
||||
- [Faster Manual Crafting Redux](https://ficsit.app/mod/FasterManualCraftingRedux) - Reduce the early game manual crafting grind with a manual crafting speed that ramps up as you craft larger batches at once.
|
||||
<!-- TODO Test these -->
|
||||
<!-- - [Infinite Zoop](https://ficsit.app/mod/InfiniteZoop) - Adds a research tree in the MAM where you can improve your Zoop capacity. Also enables multi-row & column Wall and Foundation construction. -->
|
||||
<!-- - [Nog's Research](https://ficsit.app/mod/NogsResearch/) - Queue Milestones and MAM Nodes for automatic research in the style of Factorio's research queue. Queue type might need to be changed to soft class reference to save CL schematics. -->
|
||||
@@ -0,0 +1,196 @@
|
||||
# Satisfactory Setup Guide
|
||||
|
||||
<!-- Spellchecker config - cspell:ignore FICSIT Randomizer Plando -->
|
||||
|
||||
## Required Software
|
||||
|
||||
- Satisfactory, either
|
||||
- Steam [Satisfactory (Steam)](https://store.steampowered.com/app/526870/Satisfactory/)
|
||||
- Epic [Satisfactory (Epic)](https://www.epicgames.com/store/en-US/product/satisfactory/home)
|
||||
- Satisfactory Mod Manager, either
|
||||
- Automatically via [smm.ficsit.app](https://smm.ficsit.app/) or
|
||||
- Manually via [latest stable release on GitHub](https://github.com/satisfactorymodding/SatisfactoryModManager/releases/latest/)
|
||||
|
||||
## 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](/games/Satisfactory/player-settings)
|
||||
|
||||
> ⚠ 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](/mysterycheck)
|
||||
|
||||
> ⚠ 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](/weighted-options)
|
||||
and [Plando](/tutorial/Archipelago/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:
|
||||
>
|
||||
> - <https://archipelago.gg/tutorial/Archipelago/advanced_settings/en>
|
||||
> - <https://archipelago.gg/tutorial/Archipelago/plando/en>
|
||||
|
||||
## 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.
|
||||
|
||||
<!-- In Archipelago, multiple Satisfactory worlds may be played simultaneously.
|
||||
Each of these worlds must be hosted by a Satisfactory Server which is connected to the Archipelago Server via the Archipelago mod. -->
|
||||
|
||||
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 Server** - The Satisfactory instance which will be used to host, and potentially also play, the game. It must be supplied with the Archipelago Server connection details. Any number of Satisfactory Clients may connect to this server. -->
|
||||
<!-- - **Satisfactory Client** - The Satisfactory instance with which additional players can use to connect to the same Satisfactory world. They must also have the Archipelago mod installed, but require no configuration. -->
|
||||
- **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](#required-software).
|
||||
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](https://docs.ficsit.app/satisfactory-modding/latest/faq.html#_how_do_i_get_the_experimental_or_early_access_branch_of_the_game)
|
||||
|
||||
### 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](https://smm.ficsit.app/)
|
||||
|
||||
Directions for setting and using up the Mod Manager can be found here:
|
||||
[Satisfactory Modding Documentation FAQ: Installing the Mod Manager](https://docs.ficsit.app/satisfactory-modding/latest/ForUsers/SatisfactoryModManager.html)
|
||||
|
||||
### 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](https://ficsit.app/mod/Archipelago).
|
||||
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](/games/Satisfactory/info/en#additional-mods).
|
||||
|
||||
> ⚠ 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](/tutorial/Archipelago/commands/en).
|
||||
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>
|
||||
|
||||
<!-- ## Other Settings
|
||||
|
||||
TODO implement filter_item_sends and bridge_chat_out mentioned in the Factorio guide? -->
|
||||
|
||||
## 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](https://discord.ficsit.app) for support.
|
||||
- If you encounter a game crash, please report it to us via the [Satisfactory Modding Discord](https://discord.ficsit.app).
|
||||
Please include the following information:
|
||||
- What you were doing when the crash occurred.
|
||||
<!-- - If you were a Satisfactory multiplayer host or client, and if you were playing on a dedicated server. -->
|
||||
- Use the Mod Manager to generate a debug zip and attach that file.
|
||||
[Satisfactory Modding Documentation FAQ: Generating a debug zip](https://docs.ficsit.app/satisfactory-modding/latest/faq.html#_where_can_i_find_the_games_log_files)
|
||||
- Attach your Archipelago config file to your report.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- Satisfactory Wiki: [Satisfactory Official Wiki](https://satisfactory.wiki.gg/wiki/)
|
||||
- Satisfactory Modding FAQ page: [Satisfactory Modding Documentation FAQ](https://docs.ficsit.app/satisfactory-modding/latest/faq.html)
|
||||
- Satisfactory Archipelago Item names (for hints/starting inventory/etc.) can be found [on the mod's github](https://github.com/Jarno458/Archipelago/blob/Satisfactory/worlds/satisfactory/Items.py)
|
||||
Reference in New Issue
Block a user