FSX KML

1st Oct 2006 - Please note: The software described in this manual has not yet been released. I will continue to update this manual over the next couple of weeks to coincide with the release of the FSX KML alpha.

Introduction

Before and after screenshot

FSX KML is a freeware scenery design tool for Microsoft Flight Simulator X (FSX).

It converts KML (Keyhole Markup Language) files generated by Google Earth into FSX scenery.

Using Google Earth to draw polygons and polylines you can accurately and easily create the following types of "vector" based scenery:-

• Water polygons include oceans, rivers, lakes, canals.
• Islands inside water features
• Irregular shaped landclass polygons for cities, parks, beaches, forrest, golf courses etc
• Airport polygons
• Flatten polygons
• Shore lines
• Roads (including roads with moving traffic)
• Utility lines (including power and telephone)
• Exclusions

Additionally, FSX_KML can also:-

• Place scenery objects (from the FSX library) along a polyline
• Create a FSX flight plan along a polyline
• Create landclass “tiles” (1.2km sq)

Before you start

To use FSX KML you will need the following:-

• FSX SDK. If you purchased the deluxe version of FSX then you already have the SDK. Otherwise you must download the SDK from the Microsoft FSX website

Downloading FSX KML

The latest version of FSX KML can be downloaded from the following sites:-

to be completed

Installation

Unzipping and running FSX KML

FSX KML can be installed in a folder of your choice. Simply unzip the FSX KML installation zip file into the desired folder.

After unzipping the installation file you should have the following files:-

• FSX_KML.exe
• ShapeLib129.dll
• FSX_KML_Lookup.XML
• FSX_KML_Options.XML
• Tutorial.KML

Configuration options

Before you begin building FSX scenery you will need to set a few configuration options.

• Run FSX_KML.exe and click on the options tab
• Specify the location FSX using the "FSX folder option". This will usually be C:\Program Files\Microsoft Games\Flight Simulator X
• Select the "Copy to FSX Addon Scenery Folder" if you want your scenery to be automatically copied to the FSX add on scenery folder after it is built.

The Tutorial

FSX KML includes a simple tutorial. This tutorial demonstrates the creation of a coastline (with beaches), a river and islands, a town and forest, plus a road with moving traffic.

• Open Tutorial.KML in Google Earth. An easy way to do this is to double click on Tutorial.KML in windows explorer.
• Investigate the various polygons and polylines that have been "traced" over the real scenery features displayed in Google Earth. The important thing to notice is the use of the "Description" field for each polygon or polyline. The description field is used to tell FSX KML what type of scenery feature the polygon/poyline represents.
• If you open the FSX_KML_Lookup.XML file you will see how these description "tags" are translated into FSX scenery features.
• To make scenery from the Tutorial.KML file, run FSX KML, click the Project tab and open Tutorial.KML. You will see KML structure displayed in FSX KML.
• Click the Build tab and then the Build button and FSX KML will create a FSX scenery file called Tutorial.BGL. The file will be copied automatically to the FSX addon scenery directory.
• Run FSX. You can easily goto the scenery area by opening the saved flight called FSX_KML.

Building Scenery

Building your own scenery with FSX KML is easy.

Step 1 - Creating a KML file with Google Earth

The first step in creating your FSX scenery is to create a KML file by using Google Earth to "trace" scenery features.

Creating polygons and polylines

Although you can use the free version of Google Earth (GE), by far the easiest way to create polygons and polylines is by using the $20 plus version of GE.

Using GE Plus create a polygon using the "Add Poly" function or create a polyline using the "Add Path" function, and then trace the scenery feature (for example a lake or road).

"Tagging" the scenery features

File:Fix me.png

This screenshot gives an example of how to use tags. Notice how the coastline polygon was tagged individually but the beach polygons were all tagged collectively by placing them in a sub folder and just tagging the subfolder.

To describe what scenery feature your polygon or polyline represents it needs to be "tagged". FSX_KML_Lookup.XML contains a list the tags you can use.

There are two ways to tag a polygon or polyline:-

• Place the name of the tag in the description field of the polygon or polyline
• Place the name of the tag in the description field of the parent folder that contains the polygon or polyline. If a polygon/polyline has no tag then it will inherit its tag from the parent folder.

Step 2 - Processing the KML file with FSX KML

• Run FSX_KML
• On the project tab, click the "Select KML file" button and choose the KML file you wish to process. The contents of the KML file will be displayed in FSX_KML
• On the build tab, click the "Build" button. The build progress will be displayed in the log window.
• FSX_KML will write the appropriate "ShapeFile" as required by the FSX Shp2Vec utility
• Shp2Vec will then be run to convert the shape files into FSX BGL format
• The BGL will be copied to the FSX addon scenery directory, ready for your testing

Step 3 - Testing the scenery

• For your convenience FSX_KML creates a FSX flight called "FSX_KML" which positions the Cessena 172 at 3000 ft AGL over the center of your scenery. Open the flight in FSX to goto your newly created scenery.

Scenery Design Tips

Creating a coastline with beaches

File:Fix me.png

Creating a coastline and beach

• Draw a polygon representing the ocean. "Tag" it with a ocean tag
• Draw a polygon representing the beach. "Tag" it with a beach tag

Creating a road with moving traffic

File:Fix me.png

Creating a road with moving traffic

• Draw a polyline to represent the road. If your road is going to have "one way" traffic then the traffic will travel from the start of the line (1st point you draw) to the end of the line (last point you draw)
• "Tag" the polyline with a road tag
• "Tag" the polyline with a traffic tag

Creating a river with islands

File:Todo.png

Creating a river with islands

• Create a folder in your KML to hold the river and its islands
• Draw a polygon representing the river. "Tag" it with a river tag
• Draw polygons for each island in the river. "Tag" each island with the special "ISLAND" tag.

FSX_KML_Lookup.XML

File:Fix me.png

Browsing scenery "tags" on the FSX KML Options tab

This file holds the "tags" that are used in the KML file to describe FSX scenery features. You can customise this file to add more tags or change existing ones.

An easy way to browse this file is by clicking on the "Options" tab in FSX KML.

This XML contains the following attributes for each "tag":-

• Tag - The unique identifier for this scenery feature. This tag is what you uses to "tag" your polygons/polylines in your Google Earth KML file
• Description - A description of the scenery feature
• Feature Type - The type of scenery feature. Types include:-
  • Water poly - coastline, rivers, lakes, canals etc
  • Landclass poly - irregular shaped polygons for towns, forest, beaches, park etc
  • Flatten polygons - flatten areas
  • Airport polygons - define airport boundries
  • Exclusion polygons - exclude default scenery
  • Stream polylines
  • Shoreline polylines - shore lines with animated waves
  • Road polylines (with moving traffic)
  • Utility polylines - power lines, telegraph lines, fences etc
  • Library Object - place a library object at each point along a polyline. To place a single object use a polyline that is only 1 point in size
  • to be completed
• GUID - The FSX GUID for the scenery feature. Refer to the FSX terrain.cfg file and terrain SDK documentation for futher information

Google Earth

The free version Google Earth may be downloaded from the Google Earth home page

I strongly recommend you purchase the $20 “Plus” version of Google Earth because it makes creating polygons and polylines very easy.

End User Licence

Copyright © 2006 Innova Software ALL RIGHTS RESERVED

This software program is distributed without charge to other scenery designers, redistribution of the original ZIP file is allowed. You are NOT allowed to sell this software or ask money for its distribution. The use of the software is only allowed for the production of freeware sceneries, if you want to use it for commercial scenery please contact the author at fsx_kml@innovasoftware.com

The copyright and any intellectual property relating to this program remain the property of the author.

The software distributed in this way may represent work in progress, and bears no warranty, either expressed or implied.

Release History

This software has not yet been released.

Feedback

Discuss FSX KML at the fsdeveloper.com FSX KML forum post

You can email the author directly at fsx_kml@innovasoftware.com