Official Factorio Wiki - User contributions [en]

Download API

2024-10-29T15:01:07Z

Chaoswolf: Add new `expansion` string for `build` parameter

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

This API allows you to download official releases of stand-alone Factorio from the Factorio servers. It's not so much of an API as it is web scraping, but it's documented here for completeness. Please update this page if you utilize it and the information becomes outdated. Also note that's there's a separate, (semi)official API for upgrading between releases, which should be used when possible to lighten the load on the Factorio servers. (I'll document that later, promise!)

== Authenticating ==

Downloading Factorio requires an authenticated session with the web server, which is different than the typical API authentication mechanism. Authentication uses the HTML endpoint at

<code>https://www.factorio.com/login</code>

Login in procedure:

# Create an HTTP session and send a GET request. You'll get some HTML in return.<br>There's a [[:Wikipedia:Cross-site_request_forgery#Synchronizer_token_pattern|CSRF token]] you'll need to grab which can be found using one of the following selectors:
#* CSS1: <code>input[name=csrf_token]</code> (and then take the "value" attribute).
#* XPATH1: <code>//input[@name="csrf_token"]/@value</code>
# Then send a POST request with the following parameters:
#* <code>csrf_token</code>: the CSRF token you grabbed earlier.
#* <code>username_or_email</code>: your username or email address.
#* <code>password</code>: your password.

== Downloading ==

Download Factorio releases at

<code>https://www.factorio.com/get-download/{version}/{build}/{distro}</code>

* Where {version} is the version string of the release you wish to grab - e.g. "0.15.31". Use "latest" instead to default to the latest version for that build.
* {build} is the release build, which currently comprises of:
** <code>alpha</code> - the current standard full-featured build without the space age expansion.
** <code>expansion</code> - the current standard full-featured build with the space age expansion.
** <code>demo</code> - the free, publicly accessible demo versions.
** <code>headless</code> - for running servers on machines without graphical interface.
* and {distro} is the os / type of release you wish to download, currently:
** <code>win64</code> - EXE installer for 64 bit Windows.
** <code>win64-manual</code> - ZIP package for 64 bit Windows.
** <code>win32</code> - EXE installer for 32 bit Windows. ''No longer supported.''
** <code>win32-manual</code> - ZIP package for 32 bit Windows. ''No longer supported.''
** <code>osx</code> - DMG package for 64 bit Mac OS.
** <code>linux64</code> - tar.gz or tar.xz package for 64 bit Linux.
** <code>linux32</code> - tar.gz or tar.xz package for 32 bit Linux. ''No longer supported.''

Factorio servers will correctly respond with a 404 if the requested download isn't available. Experimental builds are taken down quickly after they become obsolete, so it's best to check what versions are available before hand (documented below).

Note: Windows 32 bit and 64 bit installers are [https://en.wikipedia.org/wiki/Inno_Setup Inno Setup] formatted packages (I'll document that somewhere someday).

=== Using cURL to download Factorio ===

Another way to download factorio is by sending a HTTP GET request with <code>username</code> and <code>token</code> parameters to the download URL.
The authentication token can be found on the factorio website after logging into your account.
Note that the authentication token is a sensitive piece of information and should be kept secret.

The cURL command would look like:

<code>curl https://www.factorio.com/get-download/{version}/{build}/{distro}?username={username}&token={token} -L --output /path/to/output/directory/factorio.tar.xz</code>

And here is a filled in example:

<code>curl https://www.factorio.com/get-download/0.15.31/alpha/linux64?username=exampleUser&token=0123456789abcdef -L --output /tmp/factorio.tar.xz</code>

== Version Listings ==
There is an API endpoint to find the latest version number at <code>https://factorio.com/api/latest-releases</code>. This can be polled to automatically detect when a new update was released.

Due to changes in the Factorio website, all Factorio versions are now available on the HTML page at this location:

<code>https://www.factorio.com/download/archive</code>

Note: This endpoint require an authenticated session as mentioned above.

You could the grab all the informations you need by parsing the HTML using selectors but I would recommend only searching for the pattern <code>href="/get-download/*"</code> and then parse the relative link according to the <code>/get-download/{version}/{build}/{distro}</code> structure described in the section above. The second method has a clear advantage of reliability through potential HTML structure changes and simplicity.

It is also better to rely on the <code>https://factorio.com/api/latest-releases</code> endpoint and version number comparisons to distinguish between stable and experimental versions than to extract that information from the download HTML page with selectors.

The previous endpoints for experimental and headless releases <code>https://www.factorio.com/download/experimental</code> and <code>https://www.factorio.com/download-headless</code> now both redirect to this page containing only the latest releases:

<code>https://www.factorio.com/download</code>

The selectors used to retrieve version numbers and build combinations are presented below, but they are probably obsolete. I will check them later and update this section accordingly.
* CSS1: <code>h3</code>
* XPATH1: <code>//h3</code>

A list of available update packages is provided at <code>https://updater.factorio.com/get-available-versions</code>.

[[Category:Technical]]

Download API

2024-09-11T19:30:00Z

Chaoswolf: Add cURL download example using the authentication token

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

This API allows you to download official releases of stand-alone Factorio from the Factorio servers. It's not so much of an API as it is web scraping, but it's documented here for completeness. Please update this page if you utilize it and the information becomes outdated. Also note that's there's a separate, (semi)official API for upgrading between releases, which should be used when possible to lighten the load on the Factorio servers. (I'll document that later, promise!)

== Authenticating ==

Downloading Factorio requires an authenticated session with the web server, which is different than the typical API authentication mechanism. Authentication uses the HTML endpoint at

<code>https://www.factorio.com/login</code>

Login in procedure:

# Create an HTTP session and send a GET request. You'll get some HTML in return.<br>There's a [[:Wikipedia:Cross-site_request_forgery#Synchronizer_token_pattern|CSRF token]] you'll need to grab which can be found using one of the following selectors:
#* CSS1: <code>input[name=csrf_token]</code> (and then take the "value" attribute).
#* XPATH1: <code>//input[@name="csrf_token"]/@value</code>
# Then send a POST request with the following parameters:
#* <code>csrf_token</code>: the CSRF token you grabbed earlier.
#* <code>username_or_email</code>: your username or email address.
#* <code>password</code>: your password.

== Downloading ==

Download Factorio releases at

<code>https://www.factorio.com/get-download/{version}/{build}/{distro}</code>

* Where {version} is the version string of the release you wish to grab - e.g. "0.15.31". Use "latest" instead to default to the latest version for that build.
* {build} is the release build, which currently comprises of:
** <code>alpha</code> - the current standard full-featured build.
** <code>demo</code> - the free, publicly accessible demo versions.
** <code>headless</code> - for running servers on machines without graphical interface.
* and {distro} is the os / type of release you wish to download, currently:
** <code>win64</code> - EXE installer for 64 bit Windows.
** <code>win64-manual</code> - ZIP package for 64 bit Windows.
** <code>win32</code> - EXE installer for 32 bit Windows. ''No longer supported.''
** <code>win32-manual</code> - ZIP package for 32 bit Windows. ''No longer supported.''
** <code>osx</code> - DMG package for 64 bit Mac OS.
** <code>linux64</code> - tar.gz or tar.xz package for 64 bit Linux.
** <code>linux32</code> - tar.gz or tar.xz package for 32 bit Linux. ''No longer supported.''

Factorio servers will correctly respond with a 404 if the requested download isn't available. Experimental builds are taken down quickly after they become obsolete, so it's best to check what versions are available before hand (documented below).

Note: Windows 32 bit and 64 bit installers are [https://en.wikipedia.org/wiki/Inno_Setup Inno Setup] formatted packages (I'll document that somewhere someday).

=== Using cURL to download Factorio ===

Another way to download factorio is by sending a HTTP GET request with <code>username</code> and <code>token</code> parameters to the download URL.
The authentication token can be found on the factorio website after logging into your account.
Note that the authentication token is a sensitive piece of information and should be kept secret.

The cURL command would look like:

<code>curl https://www.factorio.com/get-download/{version}/{build}/{distro}?username={username}&token={token} -L --output /path/to/output/directory/factorio.tar.xz</code>

And here is a filled in example:

<code>curl https://www.factorio.com/get-download/0.15.31/alpha/linux64?username=exampleUser&token=0123456789abcdef -L --output /tmp/factorio.tar.xz</code>

== Version Listings ==
There is an API endpoint to find the latest version number at <code>https://factorio.com/api/latest-releases</code>. This can be polled to automatically detect when a new update was released.

Due to changes in the Factorio website, all Factorio versions are now available on the HTML page at this location:

<code>https://www.factorio.com/download/archive</code>

Note: This endpoint require an authenticated session as mentioned above.

You could the grab all the informations you need by parsing the HTML using selectors but I would recommend only searching for the pattern <code>href="/get-download/*"</code> and then parse the relative link according to the <code>/get-download/{version}/{build}/{distro}</code> structure described in the section above. The second method has a clear advantage of reliability through potential HTML structure changes and simplicity.

It is also better to rely on the <code>https://factorio.com/api/latest-releases</code> endpoint and version number comparisons to distinguish between stable and experimental versions than to extract that information from the download HTML page with selectors.

The previous endpoints for experimental and headless releases <code>https://www.factorio.com/download/experimental</code> and <code>https://www.factorio.com/download-headless</code> now both redirect to this page containing only the latest releases:

<code>https://www.factorio.com/download</code>

The selectors used to retrieve version numbers and build combinations are presented below, but they are probably obsolete. I will check them later and update this section accordingly.
* CSS1: <code>h3</code>
* XPATH1: <code>//h3</code>

A list of available update packages is provided at <code>https://updater.factorio.com/get-available-versions</code>.

[[Category:Technical]]

Replay system

2024-01-15T15:07:12Z

Chaoswolf: Move sentences describing the GUI back to the replay GUI section

{{Languages}}
== Overview ==

A replay is a file stored within the game save, containing any information needed to repeat (replay) a game from start, in a movie-like fashion. This feature is to allow players to view how their world came to be.

== Creating & playing a replay ==

Replays can be automatically generated as the map is played, behind the scenes. To enable this, the "Record replay" option needs to be checked when starting a new game. This setting is in the top right when selecting game modes (freeplay, scenarioes, etc.) before map settings. Replays have rather strong limitations, see below.

Playing a replay will play back in chronological order the actions taken in the world, as if the player was recording. The speed of playback can be increased or decreased to fine-tune the viewing experience.

To view a replay, from the main menu go to Single player → Load game, then find the ▶ Start replay button in the upper right.

=== The replay GUI ===

A simple control GUI is available to control replay playback:

[[File:replay GUI.png]]

The top bar shows the position in the replay out of the total time of the replay. The buttons allow to:
* Pause/play the replay
* Slow down playback
* Speed up playback

In multiplayer replays it is also possible to change the viewpoint player via the dropdown. Furthermore, {{Keybinding|F10}} can be used to switch to the next viewpoint player in the list.

=== Multiplayer ===

Creating a save with replay enabled must be done within the GUI.
Not choosing freeplay in step 1 or changing certain map settings in step 2 [[Achievements#Disabling_achievements|disables achievements]].

# Main menu → Single player → New game → Select the game mode → Check "Record replay" in the top right → Next
# Change map settings if desired → Play
# Enter the Game menu instantly → Save game → Quit game
# Copy the created save game to the headless game server directory
# Launch the server with the copied file

== Limitations ==

* Replays for worlds created in older versions cannot be played. Downgrading is needed to view the replay.
* Adding/removing mods to the save will also break the replay.
* Playback view is locked to the character in singleplayer.
* There is no way to skip ahead, the entire replay must be watched up until the point of interest.
* Re-winding (A.K.A. Going backwards in time ) is not possible.
* The save file needs to be created within the GUI. The headless version cannot enable replay.

== Advanced features ==

* The game can be saved at any time during playback, thus it is possible to play again from any time during the replay.
** This also allows to inspect the state at that point in time without zoom or movement limitations.
* Changing the script files inside the save will not invalidate the replay. This can be used to add scripts that do not affect the game state, such as taking screenshots in the background as the replay runs. Scripts that affect the game state (e.g. creating entities) will break the replay.
* Converting a save to a scenario and then starting a new game from that scenario restarts the replay at that point. This can be used to begin recording from a point after initial save creation, e.g. after mod or version changes have invalidated the previous replay. These are the steps to convert a save to a scenario and then start a new save game with replay enable:
** Main menu → Map editor → Convert save → Select the save file → Convert
** Main menu → Single player → New game → Select the scenario with the save name in the "User scenarios" → Check "Record replay" in the top right → Play

== See also ==

* [[Multiplayer]]
* [[Application directory]]

{{C|Main}}

Replay system

2024-01-15T15:02:02Z

Chaoswolf: Add step by step instructions for creating a multiplayer server with replay enabled

{{Languages}}
== Overview ==

A replay is a file stored within the game save, containing any information needed to repeat (replay) a game from start, in a movie-like fashion. This feature is to allow players to view how their world came to be.

== Creating & playing a replay ==

Replays can be automatically generated as the map is played, behind the scenes. To enable this, the "Record replay" option needs to be checked when starting a new game. This setting is in the top right when selecting game modes (freeplay, scenarioes, etc.) before map settings. Replays have rather strong limitations, see below.

Playing a replay will play back in chronological order the actions taken in the world, as if the player was recording. The speed of playback can be increased or decreased to fine-tune the viewing experience.

To view a replay, from the main menu go to Single player → Load game, then find the ▶ Start replay button in the upper right.

=== The replay GUI ===

A simple control GUI is available to control replay playback:

[[File:replay GUI.png]]

The top bar shows the position in the replay out of the total time of the replay. The buttons allow to:
* Pause/play the replay
* Slow down playback
* Speed up playback

=== Multiplayer ===

Creating a save with replay enabled must be done within the GUI.
Not choosing freeplay in step 1 or changing certain map settings in step 2 [[Achievements#Disabling_achievements|disables achievements]].

# Main menu → Single player → New game → Select the game mode → Check "Record replay" in the top right → Next
# Change map settings if desired → Play
# Enter the Game menu instantly → Save game → Quit game
# Copy the created save game to the headless game server directory
# Launch the server with the copied file

In multiplayer replays it is also possible to change the viewpoint player via the dropdown. Furthermore, {{Keybinding|F10}} can be used to switch to the next viewpoint player in the list.

== Limitations ==

* Replays for worlds created in older versions cannot be played. Downgrading is needed to view the replay.
* Adding/removing mods to the save will also break the replay.
* Playback view is locked to the character in singleplayer.
* There is no way to skip ahead, the entire replay must be watched up until the point of interest.
* Re-winding (A.K.A. Going backwards in time ) is not possible.
* The save file needs to be created within the GUI. The headless version cannot enable replay.

== Advanced features ==

* The game can be saved at any time during playback, thus it is possible to play again from any time during the replay.
** This also allows to inspect the state at that point in time without zoom or movement limitations.
* Changing the script files inside the save will not invalidate the replay. This can be used to add scripts that do not affect the game state, such as taking screenshots in the background as the replay runs. Scripts that affect the game state (e.g. creating entities) will break the replay.
* Converting a save to a scenario and then starting a new game from that scenario restarts the replay at that point. This can be used to begin recording from a point after initial save creation, e.g. after mod or version changes have invalidated the previous replay. These are the steps to convert a save to a scenario and then start a new save game with replay enable:
** Main menu → Map editor → Convert save → Select the save file → Convert
** Main menu → Single player → New game → Select the scenario with the save name in the "User scenarios" → Check "Record replay" in the top right → Play

== See also ==

* [[Multiplayer]]
* [[Application directory]]

{{C|Main}}