Update Setup guide and info page

This commit is contained in:
Rob B
2025-01-19 17:09:06 -05:00
parent f02176037f
commit e6a4f893ea
2 changed files with 42 additions and 44 deletions
+23 -26
View File
@@ -15,29 +15,22 @@ contains all the options you need to configure and export a config file.
In Satisfactory, the HUB Milestones and MAM Research Nodes are shuffled, In Satisfactory, the HUB Milestones and MAM Research Nodes are shuffled,
causing technologies to be obtained in a non-standard order. causing technologies to be obtained in a non-standard order.
The costs of unlocking these technologies are also shuffled. Hard Drive scanning results also contain Archipelago items,
meaning alternate recipes could now become part of your required progression path.
There are also a few new purchases in the AWESOME Shop. 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? ## What is the goal of Satisfactory?
The player can choose from a number of goals using their YAML settings: 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 - 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. - 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 You can select whether completing your slot requires one or all goals to be met.
requires completion of any one goal to complete the slot.
## What Satisfactory items can appear in other players' worlds? ## 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. Satisfactory's technologies are removed from the HUB, MAM, and Hard Drives and placed into other players' worlds.
When those technologies are found, they are sent back to Satisfactory When those technologies are found, they are sent back to Satisfactory
along with, optionally, free samples of those technologies. along with, optionally, free samples of those technologies.
@@ -64,6 +57,14 @@ A resource bundle is a package of items received as a check from another world.
They must be collected by constructing an Archipelago Portal. They must be collected by constructing an Archipelago Portal.
For example, `Bundle: Jetpack` would contain a single jetpack. For example, `Bundle: Jetpack` would contain a single jetpack.
## What is a Trap?
Traps are items intended to disrupt the player that replace non-progression filler items.
Satisfactory's traps currently include spawning disruptive creatures or sending inconvenient items to your Archipelago Portal.
The player settings page gives full control over which traps are enabled,
how many traps replace filler items,
as well as some pre-selected groups of themed traps.
## What does another world's item look like in Satisfactory? ## 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 Satisfactory, items which need to be sent to other worlds appear in the HUB and MAM as info cards
@@ -91,8 +92,8 @@ In Satisfactory, if enabled in the player settings, all base-game Power Storage
They will deposit surplus produced energy and draw energy from the shared storage when needed. 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, 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. and each Power Storage provides 100 MW of charging throughput.
The shared storage has unlimited capacity, but TODO% of energy is lost during depositing. The shared storage has unlimited capacity, and no energy is lost during depositing.
The amount of energy currently in the shared storage is displayed in the Archipelago client The amount of energy currently in the shared storage is displayed in the Archipelago client
and appears in the Power Storage building UI. and appears in the Power Storage building UI.
@@ -110,13 +111,6 @@ You can build multiple portals or use faster belts to increase their bandwith.
However, they currently have no filtering capabilities, However, they currently have no filtering capabilities,
so you must deal with this problem when handling their output items. 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? ## Where do I run Archipelago commands?
You can use the game's build-in chat menu. You can use the game's build-in chat menu.
@@ -130,14 +124,17 @@ You may wish to launch the Archipelago Text Client and use it to run commands in
## Multiplayer and Dedicated Servers ## 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. It is possible to host a Satisfactory Archipelago Slot using the game's built in multiplayer,
This experience is wonderfull - but there are few things not yet properly working for multiplayer allowing other Satisfactory players to join in constructing your factory.
* Death-links do not kill clients This experience is wonderful - but there are few things not yet properly working for multiplayer:
* Starting inventory for clients is missing
- 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, 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. however, they do not need to configure Archipelago connection settings.
Dedicated server support is only working for windows at the moment. Dedicated server support is only working for Windows at the moment.
## Additional Mods ## Additional Mods
@@ -167,7 +164,7 @@ The following mods are known to work with Archipelago:
<!-- Nog's Chat currently broken --> <!-- 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. --> <!-- - [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. - [TFIT - 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. - [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 --> <!-- 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. --> <!-- - [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. -->
+19 -18
View File
@@ -49,8 +49,11 @@ YAML Validator page: [Yaml Validation Page](/mysterycheck)
### Starting Inventory ### Starting Inventory
TODO talk about how you can use the Plando? Weighted Options? Manual yaml editing? page to edit your starting inventory, The Player Settings page provides a few options for controlling what materials you start with
giving yourself specific technologies (ex. splitters/mergers) and item bundles (ex. start with extra ) out of the gates. and when certain key technologies are unlocked.
Advanced users can use Plando, Weighted Options, and manual yaml editing to further configure the starting inventory.
If you don't wish to use these techniques, consider using a Satisfactory's Advanced Game Settings to spawn the items you desire.
### Advanced Configuration ### Advanced Configuration
@@ -70,28 +73,26 @@ to futher customize their experience.
### Defining Some Terms ### Defining Some Terms
In Archipelago, multiple Satisfactory worlds may be played simultaneously. 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. Each of these worlds must be hosted by a Satisfactory Server which is connected to the Archipelago Server via the Archipelago mod.
<!-- 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: This guide uses the following terms to refer to the software:
- **Archipelago Server** - The central Archipelago server, which connects all games to each other. - **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 Server** - The Satisfactory instance (game client or dedicated server) which will be used to host the game.
<!-- - **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. --> It must be supplied with the Archipelago Server connection details.
- **Satisfactory Client** - The Satisfactory instance which will be used to host, and play, the game. Any number of Satisfactory Clients may connect to this server.
- **Satisfactory Client** - The Satisfactory instance (game client) 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.
It is important to note that the Satisfactory Archipelago mod It is important to note that the Satisfactory Archipelago mod
is not yet compatible with dedicated servers or in-game multiplayer. is not yet compatible with Linux dedicated servers - only Windows dedicated servers are supported.
Each Satisfactory world must be hosted and played by an individual player.
### Installing Satisfactory ### Installing Satisfactory
Purchase and install Satisfactory via one the sources linked [above](#required-software). 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. 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. Make sure that you are running the correct branch of the game (Release or Experimental) that Archipelago supports.
Learn how to switch branches here: 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) [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)
@@ -116,7 +117,9 @@ 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. 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. 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 ### Installing Additional Mods
@@ -142,7 +145,7 @@ You can hover over the fields in the menu for more information and example value
- **Debug Mode**: Don't enable it unless the developers ask you to when reporting problems. - **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. - **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. Note that the Satisfactory Server/Client does _not_ need a copy of your Archipelago config file.
The mod communicates with the Archipelago Server, which already has your config file, The mod communicates with the Archipelago Server, which already has your config file,
to generate the required content at runtime. to generate the required content at runtime.
@@ -173,8 +176,6 @@ TODO implement filter_item_sends and bridge_chat_out mentioned in the Factorio g
## Troubleshooting ## 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, - If you are having trouble connecting to the Archipelago server,
make sure you have entered the correct server address and port. make sure you have entered the correct server address and port.
The server port may have changed if the room went to sleep. The server port may have changed if the room went to sleep.
@@ -184,10 +185,10 @@ TODO what is the scope of this section? How much do we help with vs. sending peo
- If you encounter a game crash, please report it to us via the [Satisfactory Modding Discord](https://discord.ficsit.app). - 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: Please include the following information:
- What you were doing when the crash occurred. - 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. --> - 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. - 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) [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. - Attach your Archipelago config file and spoiler to your report.
## Additional Resources ## Additional Resources