Official Factorio Wiki - User contributions [en]

Talk:Achievement file format

2024-08-02T04:44:00Z

O2theC:

* I have fully mapped out the achievements-modded.dat file and updated the page to reflect, i split the page into a achievements.dat and achievement-modded.dat sections, there are some odditys but they seem to be consistent, it is confirmed that for both files, tracked achievements are stored as shorts to refrence the index of the achievement set earlyer in the file, for some reason there can be shorts with value 0, not sure why, best guess is old achievements that were tracked but were completed, while i tried my best to stay with the theme and wording of the wiki and the content that was there before, i feel that what i have added may not be clear, having someone else do a look over (peer review?) to make sure it's as clear as it can be would be useful, also it should be looked into whether the 2 sections can be condensed back into 1 since there is some redundant information [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 04:43, 2 August 2024 (UTC)
* so i went into the modded formated and my god is it different, the normal header and all before is the same , seems like the same index values as the normal one (for my copys of the files), but after it goes weird, first it has an array which uses an int rather than short for length like previous arrays and then it goes SO String (ach type), SO String (ach name), then bytes[*], which is varible length based on ach type, what is weirder is that the research-achievement type has no data bytes, it does in the normal format but in the modded one is has no data bytes, and i had 2 achs with it and it was consistent , so weird , there also seems to be 4 bytes at the end of the file , not sure what they do yet [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) who knows when i made this, i forgot to add the ~s
* i think i have the correct format now and the page is updated to reflect it, during some testing it looks like the modded file almost seems to repeat some things and the repeated part uses a format that looks similar to what this page showed before, gonna check it out more tomorrow [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 01:27, 1 August 2024 (UTC)
* the starting format is not complete, similar to [[Mod_settings_file_format|mod settings format]], there is a bool set to false right after the version string, the page has been adjusted to reflect this [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 19:56, 31 July 2024 (UTC)

Achievement file format

2024-08-02T04:33:27Z

O2theC: Due to achievements.data and achievements-modded.dat having slightly different formats, they have been split up into 2 things, 1 for normal and 1 for modded, due to how similar they are, it should be looked into if condensing them back down to 1 with the differences marked is a better way of conveying the information

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. The goal of this document is to share how to ''read'' the achievement file(s) - so that third party applications can do new and interesting things with that information. Enjoy!

See the page on [[data types]] for an explanation of the different types of data used in this document.
= achievements.dat=
== 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#bool|bool]]
| A bool that is always false
|-
| [[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]][*]
| 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. Some shorts may have a value of 0, it is unknown currently why, but they don't seem to store meaningful data
|}
This format has been valid since at least version 1.1.0.

== Achievement Header Info ==

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

{| class="wikitable"
! Type !! Description
|-
| [[Data_types#Space_Optimized|Space optimized]] [[Data_types#string|string]]
| Achievement type. This determines what kind of data fields this achievement contains in the content array.
|-
| [[Data_types#array|array]]<Header Subobject>
| An array of achievements that use this achievement type
|}

=== Header Subobject ===
{| class="wikitable"
! Type !! Description
|-
| [[Data_types#Space_Optimized|Space optimized]] [[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) - because LUA tables start at 1.
|}

== 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.

Also note that this array always ends with an index number of 0. When reading, either ignore this, or manually add in a blank achievement into your meta table at index zero with no fields.

{| 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!

See the [[Prototype/Achievement]] base prototype page for more information about achievement structure.

{| class="wikitable"
! Achievement Type !! Binary Fields(s) !! Field(s) Description

|-
| [[Prototype/BuildEntityAchievement|build-entity-achievement]]
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| [[Prototype/CombatRobotCountAchievement|combat-robot-count]]
|
* [[Data_types#int|int]]
|
* The greatest number of combat robots you've had following you.
|-
| [[Prototype/ConstructWithRobotsAchievement|construct-with-robots-achievement]]
|
* [[Data_types#int|int]]
* byte[4]
|
* Total number of objects constructed using robots.
* Unknown format, 4 bytes long.
|-
| [[Prototype/DeconstructWithRobotsAchievement|deconstruct-with-robots-achievement]]
|
* [[Data_types#int|int]]
|
* Total number of objects deconstructed using robots.
|-
| [[Prototype/DeliverByRobotsAchievement|deliver-by-robots-achievement]]
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| [[Prototype/DontBuildEntityAchievement|dont-build-entity-achievement]]
|
* byte[4]
|
* Null bytes, 4 bytes long.
|-
| [[Prototype/DontCraftManuallyAchievement|dont-craft-manually-achievement]]
|
* byte[8]
|
* Null bytes, 8 bytes long.
|-
| [[Prototype/DontUseEntityInEnergyProductionAchievement|dont-use-entity-in-energy-production-achievement]]
|
* [[Data_types#double|double]]
|
* Maximum number of Joules produced per hour, only including power produced from entities listed under "[[Prototype/DontUseEntityInEnergyProductionAchievement#included|included]]", and excluding those listed under "[[Prototype/DontUseEntityInEnergyProductionAchievement#excluded|excluded]]".
|-
| [[Prototype/FinishTheGameAchievement|finish-the-game-achievement]]
|
* byte[4]
|
* Null bytes, 4 bytes long.
|-
| [[Prototype/GroupAttackAchievement|group-attack-achievement]]
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| [[Prototype/KillAchievement|kill-achievement]]
|
* [[Data_types#double|double]]
|
* The greatest number of an entity killed (e.g. trees, spawners).
|-
| [[Prototype/PlayerDamagedAchievement|player-damaged-achievement]]
|
* [[Data_types#float|float]]
* [[Data_types#bool|bool]]
|
* The maximum amount of damage you've taken in a single hit.
* True if the you survived that hit, False if you died.
|-
| [[Prototype/ProduceAchievement|produce-achievement]]
|
* [[Data_types#double|double]]
|
* The total number of the item you've produced.
|-
| [[Prototype/ProducePerHourAchievement|produce-per-hour-achievement]]
|
* [[Data_types#double|double]]
|
* The maximum amount of the item produced per hour.
|-
| [[Prototype/ResearchAchievement|research-achievement]]
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| [[Prototype/TrainPathAchievement|train-path-achievement]]
|
* [[Data_types#double|double]]
|
* The longest path (in tiles) planned by a train.
|}

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

= achievements-modded.dat =
== File Format ==
The overall file format is simular to the non modded version but slightly different.
Note some arrays here will use an int and others a short for storing their length, assume they use an int unless referred to as short arrays, in which they will use shorts for their length

{| class="wikitable"
! Type !! Description
|-
| [[Data_types#short|short]][4]
| The [[Version_string_format|version string]] of Factorio that generated this file.
|-
| [[Data_types#bool|bool]]
| A bool that is always false
|-
| short [[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]][*]
| 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. Some shorts may have a value of 0, it is unknown currently why, but they don't seem to store meaningful data
|}
This format has been valid since at least version 1.1.0.

== Achievement Header Info ==

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

{| class="wikitable"
! Type !! Description
|-
| [[Data_types#Space_Optimized|Space optimized]] [[Data_types#string|string]]
| Achievement type. This determines what kind of data fields this achievement contains in the content array.
|-
| short [[Data_types#array|array]]<Header Subobject>
| An array of achievements that use this achievement type
|}

=== Header Suboject ===
{| class="wikitable"
! Type !! Description
|-
| [[Data_types#Space_Optimized|Space optimized]] [[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) - because LUA tables start at 1.
|}

== Achievement Content Info ==

This a object representing achievements, their type and their data

{| class="wikitable"
! Type !! Description
|-
| [[Data_types#Space_Optimized|Space optimized]] [[Data_types#string|string]]
| Achievement Type
|-
| [[Data_types#Space_Optimized|Space optimized]] [[Data_types#string|string]]
| Achievement string id - the one used internally by Factorio.
|-
| byte[*]
| The achievement's progress information. The structure and length of this is determined by the [[#Achievement Types_2|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!

See the [[Prototype/Achievement]] base prototype page for more information about achievement structure.

{| class="wikitable"
! Achievement Type !! Binary Fields(s) !! Field(s) Description

|-
| [[Prototype/BuildEntityAchievement|build-entity-achievement]]
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| [[Prototype/CombatRobotCountAchievement|combat-robot-count]]
|
* [[Data_types#int|int]]
|
* The greatest number of combat robots you've had following you.
|-
| [[Prototype/ConstructWithRobotsAchievement|construct-with-robots-achievement]]
|
* [[Data_types#int|int]]
* byte[4]
|
* Total number of objects constructed using robots.
* Unknown format, 4 bytes long.
|-
| [[Prototype/DeconstructWithRobotsAchievement|deconstruct-with-robots-achievement]]
|
* [[Data_types#int|int]]
|
* Total number of objects deconstructed using robots.
|-
| [[Prototype/DeliverByRobotsAchievement|deliver-by-robots-achievement]]
|
* byte[8]
|
* Unknown format, 8 bytes long.
|-
| [[Prototype/DontBuildEntityAchievement|dont-build-entity-achievement]]
|
* byte[4]
|
* Null bytes, 4 bytes long.
|-
| [[Prototype/DontCraftManuallyAchievement|dont-craft-manually-achievement]]
|
* byte[8]
|
* Null bytes, 8 bytes long.
|-
| [[Prototype/DontUseEntityInEnergyProductionAchievement|dont-use-entity-in-energy-production-achievement]]
|
* [[Data_types#double|double]]
|
* Maximum number of Joules produced per hour, only including power produced from entities listed under "[[Prototype/DontUseEntityInEnergyProductionAchievement#included|included]]", and excluding those listed under "[[Prototype/DontUseEntityInEnergyProductionAchievement#excluded|excluded]]".
|-
| [[Prototype/FinishTheGameAchievement|finish-the-game-achievement]]
|
* byte[4]
|
* Null bytes, 4 bytes long.
|-
| [[Prototype/GroupAttackAchievement|group-attack-achievement]]
|
* byte[4]
|
* Unknown format, 4 bytes long.
|-
| [[Prototype/KillAchievement|kill-achievement]]
|
* [[Data_types#double|double]]
|
* The greatest number of an entity killed (e.g. trees, spawners).
|-
| [[Prototype/PlayerDamagedAchievement|player-damaged-achievement]]
|
* [[Data_types#float|float]]
* [[Data_types#bool|bool]]
|
* The maximum amount of damage you've taken in a single hit.
* True if the you survived that hit, False if you died.
|-
| [[Prototype/ProduceAchievement|produce-achievement]]
|
* [[Data_types#double|double]]
|
* The total number of the item you've produced.
|-
| [[Prototype/ProducePerHourAchievement|produce-per-hour-achievement]]
|
* [[Data_types#double|double]]
|
* The maximum amount of the item produced per hour.
|-
| [[Prototype/ResearchAchievement|research-achievement]]
|
* byte[0]
|
* Unknown format, 0 bytes long.
|-
| [[Prototype/TrainPathAchievement|train-path-achievement]]
|
* [[Data_types#double|double]]
|
* The longest path (in tiles) planned by a train.
|-
| [[Prototype/Achievement|achievement]]
|
* byte[0]
|
* Unknown format, 0 bytes long.
|}

"combat-robot-count" is currently the only achievement type that doesn't end in "-achievement". This is not an error. 
Also for some reason, in the 2nd Header the research-achievement type has no data bytes
[[Category:Technical]]

Talk:Achievement file format

2024-08-02T01:54:14Z

O2theC:

* so i went into the modded formated and my god is it different, the normal header and all before is the same , seems like the same index values as the normal one (for my copys of the files), but after it goes weird, first it has an array which uses an int rather than short for length like previous arrays and then it goes SO String (ach type), SO String (ach name), then bytes[*], which is varible length based on ach type, what is weirder is that the research-achievement type has no data bytes, it does in the normal format but in the modded one is has no data bytes, and i had 2 achs with it and it was consistent , so weird , there also seems to be 4 bytes at the end of the file , not sure what they do yet
* i think i have the correct format now and the page is updated to reflect it, during some testing it looks like the modded file almost seems to repeat some things and the repeated part uses a format that looks similar to what this page showed before, gonna check it out more tomorrow [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 01:27, 1 August 2024 (UTC)
* the starting format is not complete, similar to [[Mod_settings_file_format|mod settings format]], there is a bool set to false right after the version string, the page has been adjusted to reflect this [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 19:56, 31 July 2024 (UTC)

Talk:Achievement file format

2024-08-01T01:27:57Z

O2theC:

* the starting format is not complete, similar to [[Mod_settings_file_format|mod settings format]], there is a bool set to false right after the version string, the page has been adjusted to reflect this [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 19:56, 31 July 2024 (UTC)
** i think i have the correct format now and the page is updated to reflect it, during some testing it looks like the modded file almost seems to repeat some things and the repeated part uses a format that looks similar to what this page showed before, gonna check it out more tomorrow [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 01:27, 1 August 2024 (UTC)

Achievement file format

2024-07-31T22:03:35Z

O2theC: the format seems to have changed in some ways since this was last updated, i changed according to my findings, will see if the content section has also changed, also made it more clear that the strings are stored with the space optimized uint length

Talk:Achievement file format

2024-07-31T19:56:32Z

O2theC: Created page with "* the starting format is not complete, similar to mod settings format, there is a bool set to false right after the version string, the page has been adjusted to reflect this ~~~~"

Talk:Property tree

2024-07-31T18:41:55Z

O2theC:

changed from string to PT string for the Dictionary type, since it uses the string with the bool and space optimized start byte

also making it clearer that for a list the string key does not exist, when reading i was confused whether it was not there or if it was a PT string with a true start bool

by PT String i mean the string type used for Property trees

i also got no clue how this talk page works, i hope i am doing it right 
- O2theC
 
ug, now i worry about PT string being interpreted as it being a property tree of string type
i could use some help figuring out how to make this as clear as possible, since it seems i am bad with words and everything in this wiki is just so well made and i don't want to ruin it

- O2theC

* I think i got it to an ok point, help to make sure it flows and looks good would be nice -- [[User:O2theC|O2theC]] ([[User talk:O2theC|talk]]) 02:39 PM, 31 July 2024 (EDT)

Property tree

2024-07-31T18:35:04Z

O2theC:

A PropertyTree (the Factorio class name) is a recursive variant format that holds a key <> value pair where the key may be empty and the value may be only one of the following types:

{| class="wikitable"
|+PropertyTreeType ([[Data_types#unsigned byte|unsigned byte]])
|-
! Value !! Name
|-
| 0 || [[Property_tree#None|none]]
|-
| 1 || [[Property_tree#Bool|bool]]
|-
| 2 || [[Property_tree#Number|number]]
|-
| 3 || [[Property_tree#String|string]]
|-
| 4 || [[Property_tree#List|list]]
|-
| 5 || [[Property_tree#Dictionary|dictionary]]
|}

== The file format ==

1 [[Data_types#unsigned byte|unsigned byte]] representing the PropertyTreeType.

1 [[Data_types#bool|bool]] the any-type flag (currently not important outside of Factorio internals; default value is false)

== Property Tree Type ==

=== None ===
Nothing

=== Bool ===
1 [[Data_types#bool|bool]]

=== Number ===
1 [[Data_types#double|double]]

=== String ===
1 [[Data_types#bool|bool]] if there is no string - then, if there is a string:

1 [[Data_types#Space optimized|Space optimized]] [[Data_types#unsigned int|unsigned int]] the size of the string

N [[Data_types#byte|byte]] the string contents

=== List ===
Identical to Dictionary

=== Dictionary ===
1 [[Data_types#unsigned int|unsigned int]] the number of PropertyTree elements

For each element:

1 '''string''' (See string type above) the dictionary element name or it can be empty if loading a list

1 [[Property_tree]]

[[Category:Technical]]

Talk:Property tree

2024-07-31T14:34:13Z

O2theC:

changed from string to PT string for the Dictionary type, since it uses the string with the bool and space optimized start byte

also making it clearer that for a list the string key does not exist, when reading i was confused whether it was not there or if it was a PT string with a true start bool

by PT String i mean the string type used for Property trees

i also got no clue how this talk page works, i hope i am doing it right 
- Cat Lord
 
ug, now i worry about PT string being interpreted as it being a property tree of string type
i could use some help figuring out how to make this as clear as possible, since it seems i am bad with words and everything in this wiki is just so well made and i don't want to ruin it

- Cat Lord

Talk:Property tree

2024-07-31T14:30:51Z

O2theC: Created page with "changed from string to PT string for the Dictionary type, since it uses the string with the bool and space optimized start byte also making it clearer that for a list the string key does not exist, when reading i was confused whether it was not there or if it was a PT string with a true start bool by PT String i mean the string type used for Property trees i also got no clue how this talk page works, i hope i am doing it right - Cat Lord"

Property tree

2024-07-31T14:26:22Z

O2theC:

A PropertyTree (the Factorio class name) is a recursive variant format that holds a key <> value pair where the key may be empty and the value may be only one of the following types:

{| class="wikitable"
|+PropertyTreeType ([[Data_types#unsigned byte|unsigned byte]])
|-
! Value !! Name
|-
| 0 || [[Property_tree#None|none]]
|-
| 1 || [[Property_tree#Bool|bool]]
|-
| 2 || [[Property_tree#Number|number]]
|-
| 3 || [[Property_tree#String|string]]
|-
| 4 || [[Property_tree#List|list]]
|-
| 5 || [[Property_tree#Dictionary|dictionary]]
|}

== The file format ==

1 [[Data_types#unsigned byte|unsigned byte]] representing the PropertyTreeType.

1 [[Data_types#bool|bool]] the any-type flag (currently not important outside of Factorio internals; default value is false)

== Property Tree Type ==

=== None ===
Nothing

=== Bool ===
1 [[Data_types#bool|bool]]

=== Number ===
1 [[Data_types#double|double]]

=== String ===
1 [[Data_types#bool|bool]] if there is no string - then, if there is a string:

1 [[Data_types#Space optimized|Space optimized]] [[Data_types#unsigned int|unsigned int]] the size of the string

N [[Data_types#byte|byte]] the string contents

=== List ===
Identical to Dictionary

=== Dictionary ===
1 [[Data_types#unsigned int|unsigned int]] the number of PropertyTree elements

For each element:

1 [[Property_tree#String|PT string]] the dictionary element name or it can be empty if loading a list

1 [[Property_tree]]

[[Category:Technical]]