Guidelines For Working With Text-Based .Acf File Formats - X-Plane Developer

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 2

7/7/23, 23:52 Guidelines for Working with Text-Based .

acf File Formats - X-Plane Developer

Guidelines for Working with


Text-Based .acf File Formats
Last updated January 29, 2015

The .acf format in X-Plane up to and including version 9 is a binary format; X-Plane 10
switches to a text-based .acf format. This was done for two reasons:

1. To reduce the maintenance cost to LR, particularly when adding new features to aircraft.
(It helps that the text file can be inspected by hand when debugging.)

2. To allow authors to do some very basic editing using tools other than Plane-Maker.

This note describes what kinds of operations on the text file are safe and what are not.

Things you can safely do:

– Cut and paste blocks of ACF file between aircraft. You can do this to move a section of
information (e.g. all of the /engine/ fields) from one file to another.

– Apply some simple processing (e.g. search and replace) to parameters, e.g. change all OBJ
names within an ACF.

– Apply some simple changes to the .ACF from a 3-d export script (e.g. add attached objects
directly to the .acf from the OBJ exporter).

– Manage the .acf file with source control.

Things you should not do:

– Write utilities that edit the .acf as part of an X-Plane add-on. The format will change over
time, so it is important not to leave code in the field that assumes that the .acf format is
unchanged. Pre-process your .acf files “in the studio” but then ship the final .acf files.

https://developer.x-plane.com/article/guidelines-for-working-with-text-based-acf-file-formats/ 1/2
7/7/23, 23:52 Guidelines for Working with Text-Based .acf File Formats - X-Plane Developer

– Merge .acf files in source control. There are some cases where merging will work, but there
are also cases where merging can fail. Be very careful with merging and check the results
of the merge! Some merges will complete successfully (to the source control application)
but cause Plane-Maker to not open the file.

Developer resources for the X-Plane flight simulator

Never miss an update


Sign up for email updates below to get the latest X‑Plane news in your inbox.

you@domain.com

SIGN UP

We will never sell or share your email address; we’ll only use it to send you X‑Plane-related emails.
(More info in our privacy policy.)
You’ll receive about one email a month, and you can unsubscribe at any time.

© X-Plane 2023
Privacy Policy

https://developer.x-plane.com/article/guidelines-for-working-with-text-based-acf-file-formats/ 2/2

You might also like