Flight Tutorial: Create a custom OBX scenery addon

This will go over some of the basic steps to create a custom scenery addon that has new object placements. Many of the steps as similar for other types of scenery, but since this is the easiest one I am starting with this.

Overview:
- Create a new Flight addon in the Addon Builder
- Create a subdirectory for the scenery files
- Create placement xml files. These are basically the same format as FSX placement xml files, but have a few limitations and new additions
- Put the placement xml files in the scenery directory of the new add and name them as ".placements"
- Create a new scenery.cfg with the proper settings
- Create a scenery.cfg.meta with the proper settings
- Export the addon
- Install and test the addon

Step 1 - Create a new addon:
- Open Addon Builder
- Click File->New
- Create a folder for the new addon (ex. SceneryTutorial1), and then select that folder

Step 2 - Create the scenery directory:
- Open Windows Explorer and navigate to the folder for the new addon
- Add a subfolder with the same name as the addon (ex. SceneryTutorial1)
- Under that folder, add a subfolder called "scenery"
- Under that folder, add a subfolder with the same name as the addon or the area the placements are in (ex. SceneryTutorial1, or LasVegas)
- You should now have a directory path something like "SceneryTutorial1\SceneryTutorial1\scenery\LasVegas"

Step 3 - Create a placement xml file:
- Open a text editor and create placements for the objects you want in your addon. Alternatively you can use other programs like SBuilderX to create a placement file.
- For the most part the format is the same as FSX with some limitations:
- Only LibraryObjects are supported at the first level. Effects can exist as attached objects. All other types such as Beacons, Windsocks, etc are removed.
- LibraryObjects must use a scale of 1
- A new type called ProceduralBuilding has been added.​

Step 4 - Save the .placements file:
- Save the placements xml from the previous step to the directory created in step 2 ("SceneryTutorial1\SceneryTutorial1\scenery\LasVegas") with the extension ".placements"

Step 5 - Create the scenery.cfg:
- In the "scenery" folder ("SceneryTutorial1\SceneryTutorial1\scenery") create a text file with the name "scenery.cfg"
- This file needs to list the other scenery.cfgs it depends on, as well as the list of subdirectories containing placements. Here is an example assuming your addon only depends on Core and the FSX conversion:
Code:
[Product]
DependsOn={C9BF8C37-3A8F-4f55-B141-CDFF7BE74A43} ; Core
DependsOn.1={5AC19A2A-BB35-46B8-B90F-D8F1C119DCF8} ; FSX World
[Area.0]
Path=LasVegas
Step 6 - Create the scenery.cfg.meta:
- In the "scenery" folder ("SceneryTutorial1\SceneryTutorial1\scenery") create a text file with the name "scenery.cfg.meta"
- Use the following text, but replace the UNIQUE_GUID_HERE with a new unique GUID. You can get one by going here: http://createguid.com
Code:
<?xml version="1.0" encoding="utf-8"?>
<SimBase.Document version="2,0">
  <Asset.Metadata id="{UNIQUE_GUID_HERE}">
  <Type>{C5354E13-3570-4414-B7E7-5EE1FF032FF4}</Type>
  <Tag>SceneryConfiguration</Tag>
  </Asset.Metadata>
</SimBase.Document>
Step 7 - Export the addon:
- In Addon Builder click the "Refresh" button next to where it says "Add Content" near the bottom and wait for the progress bar to complete. You should see scenery.cfg in the list afterwards
- Click File->Export, and choose a name for the .flightAddon file.

Step 8 - Install the addon and test:
- Close Addon Builder
- Open Addon Manager
- Click File->Install and select the .flightAddon file you just saved during the export
- Once it installs enable the addon
- Run Flight and load the area where your placements are and make sure your objects show up.
 
Last edited:
Top