mirror/Archipelago
1
0
Fork 1
mirror of https://github.com/ArchipelagoMW/Archipelago.git synced 2026-03-23 00:53:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update setup directions and info

Browse Source
This commit is contained in:
Rob B
2025-06-09 18:39:57 -04:00
parent 1b297820de
commit d44928c930
2 changed files with 38 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
worlds/satisfactory/docs/en_Satisfactory.md
View File

@@ -18,6 +18,7 @@ causing technologies to be obtained in a non-standard order.
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.
The materials required for constructing Assemblers and Foundries is altered to increase early game recipe variety.
## What is the goal of Satisfactory?
@@ -25,10 +26,15 @@ 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.
- Expect 1 package to take ~3 hours to finish, 2 packages to take ~8 hours, 3 packages to take ~2 days, and 4 packages to take ~1 week on default settings.
- 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.
- Time to finish this goal varies significantly depending on your goal level and Free Sample settings, and can technically be reached by AFKing at any point after you unlock the Sink.
- Supply items to the [AWESOME Sink](https://satisfactory.wiki.gg/wiki/AWESOME_Sink) **maintaining a configurable level of points per minute** to finish.
- This goal requires establishing a more robust factory since it can't be AFKed like the points total goal.
- Time to finish this goal varies significantly depending on your Space Elevator shipments in logic and the resource sink point improvement ratios of the recipes you have access to.
- **Explore the world to gather exotic items** and submit them in the HUB.
- Time to finish this goal varies significantly depending on your map knowledge, equipment, and movement skills.
You can select whether completing your slot requires one or all goals to be met.
You can select whether completing your slot requires *one* or *all* goals to be met.
## What Satisfactory items can appear in other players' worlds?
@@ -49,15 +55,17 @@ 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.
Certain recipes and items, like Somersloops, are always excluded from samples.
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.
A Resource Bundle is a package of items received as a check from another world.
All resource bundle type items are named either `Single: <item name>` or `Bundle: <item name>` to distinguish them from component recipes.
They must be collected by constructing an Archipelago Portal.
For example, `Bundle: Jetpack` would contain a single jetpack.
For example, `Single: Jetpack` would contain a single jetpack, and `Bundle: Biomass` would contain one stack of biomass.
## What is a Trap?
@@ -67,7 +75,7 @@ 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.
A complete list of traps and their effects is intentionally ommitted to keep some surprise and mystery.
A complete list of traps and their effects is intentionally omitted to keep some surprise and mystery.
In the current implementation, the most severe traps could temporarily lock you out of a small area until you have gas/radiation protection.
## What does another world's item look like in Satisfactory?
@@ -142,7 +150,7 @@ the rest are filler or useful.
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 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.
@@ -196,6 +204,7 @@ The following mods are known to work with Archipelago:
<!-- - [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. -->
The following mods have been used successfully by other players but have not been thorughly tested with Archipelago:
The following mods have been used successfully by other players but have not been thoroughly tested with Archipelago:
- [Resource Roulette](https://ficsit.app/mod/ResourceRoulette) - Randomize the location of resource nodes
- [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.

49
worlds/satisfactory/docs/setup_en.md
View File

@@ -53,7 +53,9 @@ The Player Settings page provides a few options for controlling what materials y
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.
If you don't wish to use these techniques, consider using Satisfactory's
[Advanced Game Settings](https://satisfactory.wiki.gg/wiki/Advanced_Game_Settings)
to spawn the items you desire.
### Advanced Configuration
@@ -80,7 +82,7 @@ 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 (game client or dedicated server) which will be used to host the game.
It must be supplied with the Archipelago Server connection details.
Any number of Satisfactory Clients may connect to this server.
*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.
@@ -130,48 +132,40 @@ You may also wish to install some of the suggested mods mentioned on the
> Use this link instead:
> <https://github.com/Jarno458/Archipelago/blob/Satisfactory/worlds/satisfactory/docs/en_Satisfactory.md#additional-mods>
### Entering Connection Details
### Creating a New World
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.
Once the game has launched, start creating a new game.
Select your starting location and Skip Intro if you wish to skip the tutorial sequence,
then click the "Mod Savegame Settings" button in the bottom right corner of the screen.
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.
- **Server URI**: Archipelago Server URI and port, for example, `archipelago.gg:49236`
- **User Name**: 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 Server/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,
to generate the required content at runtime.
> Note: Satisfactory dedicated servers do not currently have a user interface for the mod config system.
> If you are setting up a dedicated server as your Satisfactory Server, to work around this,
> first, enter the connection details in your Satisfactory Client, then locate the `Archipelago.cfg` file
> in the [mod config file directory on disk](https://docs.ficsit.app/satisfactory-modding/latest/faq.html#Files_ModConfig).
> Copy this file to the server's mod config directory.
### 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.
> Note: The [starting inventory feature does not currently work on dedicated servers](https://github.com/Jarno458/SatisfactoryArchipelagoMod/issues/105).
> To work around this, create the save file in your Satisfactory Client first, join it to receive the items,
> Note: Satisfactory dedicated servers do not currently have a user interface for the Mod Savegame Setting system.
> and [the starting inventory feature does not currently work on dedicated servers](https://github.com/Jarno458/SatisfactoryArchipelagoMod/issues/105).
> If you are setting up a dedicated server as your Satisfactory Server, to work around these limitations,
> create the save locally in your Satisfactory Client first,
> then upload the save file to your Satisfactory Server using the [Server Manager](https://satisfactory.wiki.gg/wiki/Dedicated_servers#Loading_a_save_file).
### 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`.
After you have created your new world,
you should see in-game chat messages confirming that you have connected to the Archipelago 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.
@@ -184,7 +178,8 @@ Check out the HUB to get started!
> ⚠ IMPORTANT: Check your HUB immediately upon joining to ensure your save file has been set up correctly!
> Make sure that you see multiple HUB milestones from Archipelago in Tier 1 and Tier 2.
> If you don't, create a new Satisfactory save file with the same connection settings and it should resolve itself.
> If you don't, ensure your connection details are correct.
> If that doesn't work, contact us on the Archipelago discord.
> See more information about this bug on the [GitHub issue tracker](https://github.com/Jarno458/SatisfactoryArchipelagoMod/issues/120).
<!-- ## Other Settings
@@ -197,7 +192,7 @@ TODO implement filter_item_sends and bridge_chat_out mentioned in the Factorio g
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.
access the save's settings via the Mod Savegame Settings button in the pause menu.
- 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: