In other languages:

Achievement file format: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Created page with "{{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 "achi...")
 
m (→‎File Format: fix redirect)
 
(33 intermediate revisions by 4 users not shown)
Line 2: Line 2:
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".  
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.
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|data types]] for an explanation of the different types of data used in this document.
See the page on [[Data_Types|data types]] for an explanation of the different types of data used in this document.
Line 14: Line 14:
|-
|-
| [[Data_Types#short|short]][4]
| [[Data_Types#short|short]][4]
| The [[Version_String_Format|version string]] of Factorio that generated this string.
| The [[Version_string_format|version string]] of Factorio that generated this file.
|-
|-
| [[Data_Types#array|array]]<bytes>
| [[Data_Types#array|array]]<[[#Achievement Header Info|bytes]]>
| Achievement header info. Variable length. See the section for more information.
| [[#Achievement Header Info|Achievement header info]]. Variable length. See the section for more information.
|-
|-
| [[Data_Types#array|array]]<bytes>
| [[Data_Types#array|array]]<[[#Achievement Content Info|bytes]]>
| Achievement content info. Variable length. See the section for more information.
| [[#Achievement Content Info|Achievement content info]]. Variable length. See the section for more information.
|-
|-
| [[Data_Types#short|short]][*]
| [[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 id of an achievement, in the order of which the player has them tracked in game.
| 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 ==


This format has been valid since at least version 0.14.x.
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.<br> 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<br>Type !! Binary<br>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]]
|
''TODO''
|
''TODO''
|-
| [[Prototype/DontCraftManuallyAchievement|dont-craft-manually-achievement]]
|
''TODO''
|
''TODO''
|-
| [[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]]
|
''TODO''
|
''TODO''
|-
| [[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.

Latest revision as of 04:08, 29 April 2020

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.

File Format

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

Type Description
short[4] The version string of Factorio that generated this file.
array<bytes> Achievement header info. Variable length. See the section for more information.
array<bytes> Achievement content info. Variable length. See the section for more information.
short[*] Currently tracked achievements, given as a series of 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.

Type Description
string Achievement type. This determines what kind of data fields this achievement contains in the content array.
string Achievement string id - the one used internally by Factorio.
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.

Type Description
short Achievement index number. This matches up with the index number in the Achievement header info.
byte[*] The achievement's progress information. The structure and length of this is determined by the 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.

Achievement
Type
Binary
Fields(s)
Field(s) Description
build-entity-achievement
  • byte[4]
  • Unknown format, 4 bytes long.
combat-robot-count
  • The greatest number of combat robots you've had following you.
construct-with-robots-achievement
  • Total number of objects constructed using robots.
  • Unknown format, 4 bytes long.
deconstruct-with-robots-achievement
  • Total number of objects deconstructed using robots.
deliver-by-robots-achievement
  • byte[8]
  • Unknown format, 8 bytes long.
dont-build-entity-achievement

TODO

TODO

dont-craft-manually-achievement

TODO

TODO

dont-use-entity-in-energy-production-achievement
  • Maximum number of Joules produced per hour, only including power produced from entities listed under "included", and excluding those listed under "excluded".
finish-the-game-achievement

TODO

TODO

group-attack-achievement
  • byte[4]
  • Unknown format, 4 bytes long.
kill-achievement
  • The greatest number of an entity killed (e.g. trees, spawners).
player-damaged-achievement
  • The maximum amount of damage you've taken in a single hit.
  • True if the you survived that hit, False if you died.
produce-achievement
  • The total number of the item you've produced.
produce-per-hour-achievement
  • The maximum amount of the item produced per hour.
research-achievement
  • byte[4]
  • Unknown format, 4 bytes long.
train-path-achievement
  • 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.