In other languages: Deutsch Polska Русский Turkish 中文

Application directory: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
No edit summary
(→‎Changing the user data directory: - Update with instructions for recent versions of factorio and macOS.)
 
(62 intermediate revisions by 18 users not shown)
Line 1: Line 1:
The application directory stores
{{Languages}}
* the saves (every save is a zip-file)
== Overview ==
* the [[Mods]]
Depending on your installation method and OS, you will have one or two directories that contain Factorio assets, and one that contains user data, such as saves and mods.
* scenarios
* configuration.


The directory structure is self-explaining.
== User data directory ==
The user data directory is where personal files are stored:
* Save files <code>./saves</code>
* Mods <code>./mods</code>
* Script-output, e.g. from /screenshot <code>./script-output</code>
* Local [[scenario system|scenarios]] <code>./scenarios</code>
* Local settings <code>./config/config.ini</code>
* [[log file]]s <code>factorio-*.log</code>
* Crash dump files <code>factorio-dump-*.dmp</code>


You can delete for example the configuration-file, it will be generated new with the defaults. It is recommended to create backups from this directory, before you install a new version.
=== Locations ===
Search your computer for the directory location, or type the path into your file manager address bar.


== Windows ==
Windows:
=== Installer ===


Installation package needs to follow the rights rules, so it works with UAC. In that case the factorio directory is where you install it (Program files by default) and the user data (saves, player data etc) are stored in the
%appdata%\Factorio


C:\Users\<user>\AppData\Roaming\Factorio
:The <code>%appdata%</code> shorthand translates to your local version of <code>C:\Users\[user name]\AppData\Roaming</code>


=== Zip-package ===
MacOSX:
Zip package is just one Factorio directory that doesn't need to be installed, all the saves are there locally easy to find.


== MacOSx ==
  ~/Library/Application Support/factorio
  ~/Library/Application Support/factorio


== Linux ==
Linux distributions:
 
  ~/.factorio
  ~/.factorio
When using Steam on Windows, the config.ini, achievements.dat, modded-achievements.dat and player-data.json can also be found in
C:\Program Files (x86)\Steam\userdata\[user number]\427520\remote
== Application directory ==
The application directory stores three things:
* Factorio executables <code>./bin</code>
* Data for vanilla Factorio <code>./data</code>
* API documentation <code>./doc-html</code>
=== Locations ===
Windows:
C:\Program Files (x86)\Steam\steamapps\common\Factorio
C:\Program Files\Factorio
MacOSX:
~/Library/Application Support/Steam/steamapps/common/Factorio/factorio.app/Contents
/Applications/factorio.app/Contents
Linux:
~/.factorio
== Changing the user data directory ==
You can create a file <code>config-path.cfg</code> to configure Factorio to any directory.
In order to change the user data directory, user must edit the location of the "write-data" entry in the file <code>(Game install directory)/config/config.ini</code>. This affects the location of mods, scenario and temp.
====macOS====
Create <code>factorio.app/config-path.cfg</code> with the following contents:
config-path=__PATH__executable__/../config
use-system-read-write-data-directories=false
Update <code>factorio.app/Contents/config/config.ini</code>
[path]
read-data=__PATH__executable__/../data
write-data=__PATH__executable__/..
'''[http://www.factorioforums.com/forum/viewtopic.php?f=49&t=12819&p=87281#p87281 Please see this discussion]''' (for older versions of macOS, but may work on any other OS).
====Linux====
Update <code>__Game_Install_directory/config-path.cfg</code>
use-system-read-write-data-directories=true
Update <code>__Game_Install_directory/config/config.ini</code>
[path]
read-data=__PATH__executable__/../../data
write-data=.local/share/factorio
You could set the <code>write-data</code> value to '''<code>.factorio</code>''' if you prefer.
Once you have done this, you can remove write permissions to the entire game installation directory '''except''' for <code>config/config.ini</code>, which '''must''' be writable by all people who wish to play the game.
Note that if someone changes any options, in-game, those option changes will apply to everyone who plays on the same computer.
== Installation from Zip File ==
The unzipped Factorio directory.
A list of all things found here:
* Save games (as zip files)
* User-installed/created [[Mods]].
* User-installed/created scenarios.
* User configuration and settings storage
* [[Log file]] (factorio-*.log)
* Player data (player-data.json)
Note: Deleting the configuration file will result in a default replacement being generated upon the next Factorio launch.
It is recommended to create backups from this directory (of saves, config, etc) before installing a new version.
== See also ==
* [[Install guide]]
* [[Installing Mods]]
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=8294 Linux Version - Save games in $HOME somewhere]

Latest revision as of 15:25, 17 January 2022

Overview

Depending on your installation method and OS, you will have one or two directories that contain Factorio assets, and one that contains user data, such as saves and mods.

User data directory

The user data directory is where personal files are stored:

  • Save files ./saves
  • Mods ./mods
  • Script-output, e.g. from /screenshot ./script-output
  • Local scenarios ./scenarios
  • Local settings ./config/config.ini
  • log files factorio-*.log
  • Crash dump files factorio-dump-*.dmp

Locations

Search your computer for the directory location, or type the path into your file manager address bar.

Windows:

%appdata%\Factorio
The %appdata% shorthand translates to your local version of C:\Users\[user name]\AppData\Roaming

MacOSX:

~/Library/Application Support/factorio

Linux distributions:

~/.factorio

When using Steam on Windows, the config.ini, achievements.dat, modded-achievements.dat and player-data.json can also be found in

C:\Program Files (x86)\Steam\userdata\[user number]\427520\remote

Application directory

The application directory stores three things:

  • Factorio executables ./bin
  • Data for vanilla Factorio ./data
  • API documentation ./doc-html

Locations

Windows:

C:\Program Files (x86)\Steam\steamapps\common\Factorio
C:\Program Files\Factorio

MacOSX:

~/Library/Application Support/Steam/steamapps/common/Factorio/factorio.app/Contents
/Applications/factorio.app/Contents

Linux:

~/.factorio

Changing the user data directory

You can create a file config-path.cfg to configure Factorio to any directory.

In order to change the user data directory, user must edit the location of the "write-data" entry in the file (Game install directory)/config/config.ini. This affects the location of mods, scenario and temp.

macOS

Create factorio.app/config-path.cfg with the following contents:

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

Update factorio.app/Contents/config/config.ini

[path]
read-data=__PATH__executable__/../data
write-data=__PATH__executable__/.. 

Please see this discussion (for older versions of macOS, but may work on any other OS).

Linux

Update __Game_Install_directory/config-path.cfg

use-system-read-write-data-directories=true

Update __Game_Install_directory/config/config.ini

[path]
read-data=__PATH__executable__/../../data
write-data=.local/share/factorio

You could set the write-data value to .factorio if you prefer.

Once you have done this, you can remove write permissions to the entire game installation directory except for config/config.ini, which must be writable by all people who wish to play the game.

Note that if someone changes any options, in-game, those option changes will apply to everyone who plays on the same computer.

Installation from Zip File

The unzipped Factorio directory.

A list of all things found here:

  • Save games (as zip files)
  • User-installed/created Mods.
  • User-installed/created scenarios.
  • User configuration and settings storage
  • Log file (factorio-*.log)
  • Player data (player-data.json)

Note: Deleting the configuration file will result in a default replacement being generated upon the next Factorio launch.

It is recommended to create backups from this directory (of saves, config, etc) before installing a new version.

See also