dockipelago/WebHostLib/static/assets/tutorial/factorio/setup_en.md

Factorio Randomizer Setup Guide

Required Software

Server Host

• Factorio
• Archipelago

Players

• Factorio

General Concept

One Server Host exists per Factorio World in an Archipelago Multiworld, any number of modded Factorio players can then connect to that world. From the view of Archipelago, this Factorio host is a client.

The final state you're looking for to play is:

• The generated Factorio Mod (part of Generate's output)
• An Archipelago Server.
• An (or multiple for multiworld) ArchipelagoFactorioClient, that is connected to that Archipelago Server.
• A Factorio Server that is started by the ArchipelagoFactorioClient automatically.
  • Installed and enabled to this server is an AP_* mod that got generated alongside the generation.
• A Factorio Game (or multiple for coop) that then connect to that embedded Factorio Server.
  • Installed and enabled to these games is an AP_* mod that got generated alongside the generation.

Note: There is an Archipelago mod on the Factorio Mod Portal, this mod is mostly for developers, not for play.

Installation Procedures

Dedicated Server Setup

You need a dedicated isolated Factorio installation that the FactorioClient can take control over. If you intend to both host a world and play on the same device, you will need two separate Factorio installations; one for the FactorioClient to hook into and control, and one for you to play on. The easiest and cheapest way to do so is to either buy or register a Factorio key on factorio.com, which allows you to download as many Factorio games as you want. If you own a steam copy already you can link your account on the website.

1. Download the latest Factorio from https://factorio.com/download for your system, for Windows the recommendation is "win64-manual".

2. Make sure the Factorio you play and the Factorio you use for hosting do not share paths. If you downloaded the "manual" version, this is already the case, otherwise, go into the hosting Factorio's folder and put the following text into its config-path.cfg:

config-path=__PATH__executable__/../../config
use-system-read-write-data-directories=false

3. In this same folder if there are shortcuts named "mods" and "saves" delete these and replace with folders with the same names.
4. Navigate to where you installed Archipelago and open the host.yaml file as text. Find the entry executable under factorio_options and set it to point to your hosting Factorio.exe. If you put Factorio into your Archipelago folder, this would already match.
   ex.

factorio_options:
  executable:  C:\\Program Files\\factorio\\bin\\x64\\factorio"

Player Setup

• Manually install the AP mod for the correct world you want to join, then use Factorio's built-in multiplayer. If you're connecting to a FactorioClient on the same system you will connect to localhost

Joining a MultiWorld Game

1. Install the generated Factorio AP Mod (would be in /Mods after step 2 of Setup)

2. Run FactorioClient, it should launch a Factorio server, which you can control with /factorio ,

   • It should start up, create a world and become ready for Factorio connections.

3. In FactorioClient, do /connect to join that multiworld. You can find further commands with /help as well as !help once connected.

   • / commands are run on your local client, ! commands are requests for the AP server

   • Players should be able to connect to your Factorio Server and begin playing.

4. You can join yourself by connecting to address localhost, other people will need to connect to your IP and you may need to port forward for the Factorio Server for those connections.

Problems

FactorioClient will create a FactorioClient.txt in /logs, contents of this logfile may help you troubleshoot an issue on your own and is vital for us to help you with issues.