Achievement file format

2017-08-12T02:37:56Z

Lexxy Fox: /* Achievement Types */

{{Languages}} [[Category:Technical]]
This is a technical description of the achievement file format, used by Factorio to store player's achievement progress in the files "achievements.dat" and "achievements-modded.dat".

Yes - this information can be used to "cheat" Factorio by simply writing to the achievement file(s) in such a way as if you had met all the achievement requirements, open up Factorio, and then suddenly have all achievements unlocked. If you've played Factorio at all you should know that this point is moot. The goal of this document is to share how to _read_ the achievement file(s) - so that third party applications can do do things with that information. Enjoy.

See the page on [[Data_Types|data types]] for an explanation of the different types of data used in this document.

== File Format ==

The overall file format is as follows. Note that in this file, [[Data_Types#array|array]] length is stored as a [[Data_Types#short|short]], not an [[Data_Types#int|int]]!

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#short|short]][4]
| The [[Version_String_Format|version string]] of Factorio that generated this file.
|-
| [[Data_Types#array|array]]<[[#Achievement Header Info|bytes]]>
| [[#Achievement Header Info|Achievement header info]]. Variable length. See the section for more information.
|-
| [[Data_Types#array|array]]<[[#Achievement Content Info|bytes]]>
| [[#Achievement Content Info|Achievement content info]]. Variable length. See the section for more information.
|-
| [[Data_Types#short|short]]
| Unknown. Always seems to equal zero. Perhaps padding?
|-
| [[Data_Types#short|short]][*]
| Currently tracked achievements, given as a series of [[Data_Types#short|shorts]] up until the end of the file, with each representing the index number of an achievement. The order of achievements in this series matches the order of which the player has them tracked in game.
|}
This format has been valid since at least version 0.14.x.

== Achievement Header Info ==

The header contains information about what type of data fields each achievement has.

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#string|string]]
| Achievement type. This determines what kind of data fields this achievement contains in the content array.
|-
| [[Data_Types#string|string]]
| Achievement string id - the one used internally by Factorio.
|-
| [[Data_Types#short|short]]
| Achievement index number. This number is used to map achievements between this header info array, the content info array, and the tracked achievements list in this file. These index numbers are non-normative, so they won't always match up with the same achievement. Note: the mapping of index numbers to achievement ids are continuous, but start at index 1 (there is no index 0).
|}

== Achievement Content Info ==

This contains the actual data of each achievement. It's important to note that not every achievement listed in the header has a matching content section here.

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#short|short]]
| Achievement index number. This matches up with the index number in the [[#Achievement Header Info|Achievement header info]].
|-
| byte[*]
| The achievement's progress information. The structure and length of this is determined by the [[#Achievement Types|achievement's type]]. See the table below for a list of achievement types.
|}

== Achievement Types ==

If new achievement types are added in the future, the achievement files will be unparse-able. Please add any new types you find here, thanks!

{| class="wikitable"
! Achievement Type !! Data Fields(s) !! Field(s) Description
|-
| build-entity-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| combat-robot-count
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| construct-with-robots-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| deconstruct-with-robots-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| deliver-by-robots-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| dont-use-entity-in-energy-production-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| group-attack-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| kill-achievement
|
* [[Data_Types#double|double]]
|
* The greatest number of an entity killed (e.g. trees, spawners).
|-
| player-damaged-achievement
|
* [[Data_Types#float|float]]
* [[Data_Types#bool|bool]]
|
* The Maximum amount of damage a player has taken in a single hit.
* True if the player survived that hit, False if they died.
|-
| produce-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| produce-per-hour-achievement
|
* [[Data_Types#double|double]]
|
* The maximum amount of the item produced per hour.
|-
| research-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| train-path-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|}

"combat-robot-count" is currently the only achievement type that doesn't end in "-achievement". This is not an error.

Achievement file format

2017-08-12T02:36:40Z

Lexxy Fox: /* Achievement Types */

{{Languages}} [[Category:Technical]]
This is a technical description of the achievement file format, used by Factorio to store player's achievement progress in the files "achievements.dat" and "achievements-modded.dat".

Yes - this information can be used to "cheat" Factorio by simply writing to the achievement file(s) in such a way as if you had met all the achievement requirements, open up Factorio, and then suddenly have all achievements unlocked. If you've played Factorio at all you should know that this point is moot. The goal of this document is to share how to _read_ the achievement file(s) - so that third party applications can do do things with that information. Enjoy.

See the page on [[Data_Types|data types]] for an explanation of the different types of data used in this document.

== File Format ==

The overall file format is as follows. Note that in this file, [[Data_Types#array|array]] length is stored as a [[Data_Types#short|short]], not an [[Data_Types#int|int]]!

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#short|short]][4]
| The [[Version_String_Format|version string]] of Factorio that generated this file.
|-
| [[Data_Types#array|array]]<[[#Achievement Header Info|bytes]]>
| [[#Achievement Header Info|Achievement header info]]. Variable length. See the section for more information.
|-
| [[Data_Types#array|array]]<[[#Achievement Content Info|bytes]]>
| [[#Achievement Content Info|Achievement content info]]. Variable length. See the section for more information.
|-
| [[Data_Types#short|short]]
| Unknown. Always seems to equal zero. Perhaps padding?
|-
| [[Data_Types#short|short]][*]
| Currently tracked achievements, given as a series of [[Data_Types#short|shorts]] up until the end of the file, with each representing the index number of an achievement. The order of achievements in this series matches the order of which the player has them tracked in game.
|}
This format has been valid since at least version 0.14.x.

== Achievement Header Info ==

The header contains information about what type of data fields each achievement has.

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#string|string]]
| Achievement type. This determines what kind of data fields this achievement contains in the content array.
|-
| [[Data_Types#string|string]]
| Achievement string id - the one used internally by Factorio.
|-
| [[Data_Types#short|short]]
| Achievement index number. This number is used to map achievements between this header info array, the content info array, and the tracked achievements list in this file. These index numbers are non-normative, so they won't always match up with the same achievement. Note: the mapping of index numbers to achievement ids are continuous, but start at index 1 (there is no index 0).
|}

== Achievement Content Info ==

This contains the actual data of each achievement. It's important to note that not every achievement listed in the header has a matching content section here.

{| class="wikitable"
! Type !! Description
|-
| [[Data_Types#short|short]]
| Achievement index number. This matches up with the index number in the [[#Achievement Header Info|Achievement header info]].
|-
| byte[*]
| The achievement's progress information. The structure and length of this is determined by the [[#Achievement Types|achievement's type]]. See the table below for a list of achievement types.
|}

== Achievement Types ==

If new achievement types are added in the future, the achievement files will be unparse-able. Please add any new types you find here, thanks!

{| class="wikitable"
! Achievement Type !! Data Fields(s) !! Field(s) Description
|-
| build-entity-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| combat-robot-count
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| construct-with-robots-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| deconstruct-with-robots-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| deliver-by-robots-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| dont-use-entity-in-energy-production-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| group-attack-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| kill-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| player-damaged-achievement
|
* [[Data_Types#float|float]]
* [[Data_Types#bool|bool]]
|
* The Maximum amount of damage a player has taken in a single hit.
* True if the player survived that hit, False if they died.
|-
| produce-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| produce-per-hour-achievement
|
* [[Data_Types#double|double]]
|
* The maximum amount of the item produced per hour.
|-
| research-achievement
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| train-path-achievement
|
* byte[8]
|
* Unknown format, 8 bytes long.
|}

"combat-robot-count" is currently the only achievement type that doesn't end in "-achievement". This is not an error.