Skip to content

Basic Setup

Jump to bottom
shred86 edited this page Jun 19, 2024 · 14 revisions

This page will explain some general setup procedures and considerations for getting started with Ortho4XP.

Orthophoto provider

Users can choose from a number of orthophoto providers and the quality of the imagery will largely vary depending on the area. For example, some orthophotos will have regions where the images include shadows from clouds or transition "lines" where imagery was used from different sources or taken on different days. The easiest method to determining what source to use is to providers website map to see the imagery. It's important to note that the quality of orthophotos can widely vary depending on the zoom level, so when using the providers website map, zooming in to load the different levels of orthophotos is necessary. Users should be aware that some providers may ban a user from their service if they are downloading a large amount of imagery. This is completely up to the providers. By default, Microsoft Bing (BI) imagery is used but this can be changed in the Ortho4XP main window using the "Imagery" dropdown.

Zoom level (ZL)

Which zoom level use is completely user preference as it's a balance between storage capacity, system performance and image quality. Orthophotos can quickly fill up hard drive space so many users will prefer to use external storage solutions for their X-Plane scenery, which is discussed further in the following paragraph. A comparison of zoom levels can be found on simHeaven's website. In general, ZL16 is commonly used as the default with ZL17 and ZL18 being only around airports or areas where lower altitude flying is expected. The default is set to ZL16 but this can be changed in the Ortho4XP main window using the "Zoomlevel" dropdown.

Storage

When creating tiles, Ortho4XP will download data from external providers and convert that data into tiles used by X-Plane. The largest amount of storage space used will be the latter, the tiles used by X-Plane. However, the orthophotos downloaded from external providers will also taken up a large amount of storage space. While these can be deleted after the tiles are built, users may want to keep them if planning on making changes to re-build the tiles without having to re-download the orthophotos. Orthophotos and tiles are stored in the "Orthophotos" and "Tiles" directory located in the main Ortho4XP folder.

The "Base Folder" setting in the Ortho4XP main window specifies where the tiles will be stored when they're built. As a reminder, these are the scenery files used by X-Plane. There are generally three ways a user might specify this setting:

  1. Store tiles in the default "Tiles" directory located in the main Ortho4XP directory. In this case, this field is left blank.
  2. Store tiles directly in the X-Plane Custom Scenery directory. Set this field to the X-Plane Custom Scenery directory.
  3. Store tiles in a separate location. Set this field to the directory where tiles will be stored.

X-Plane will search for scenery data in the Custom Scenery directory, so if the tiles are stored directly in the X-Plane Custom Scenery directory (option 2 above), then no further configuration is necessary. If tiles are stored in a location other than X-Plane's Custom Scenery directory (option 1 or 3 above), symbolic links (symlinks) will have to be created to the location of the tiles created by Ortho4XP. If tiles are stored

Ortho4XP has a built-in feature that allows users to quickly create symlinks from the user interface. To use this feature, the location of X-Plane's Custom Scenery directory has to be specified in the Ortho4XP Config window "custom_scenery_dir" field (e.g. /Users/pilot/X-Plane 12/Custom Scenery).

Once you have created tiles, they will appear in the Tiles collection and management window as black rectangles with the orthophoto provider and ZL used (BI 16 in the example screenshot below). By holding Control on the keyboard and mouse clicking (left) a tile, a symlink is created in the X-Plane Custom Scenery directory which is indicated by the text within the tile rectangle turning bold. To remove the link (use default X-Plane scenery for that tile), simply Control click the same tile.

Symlink Tiles

Overlays

Overlays are a type of tile that superimposes content over another tile, such as adding buildings or other structures. Ortho4XP will need to extract the existing overlays as a part of the tile building process, so the "custom_overlay_src" in the Ortho4XP Config window must be specified. In most installations, this is set to the "X-Plane 12 Global Scenery" directory located in "X-Plane 12/Global Scenery" (e.g., /Users/pilot/X-Plane 12/Global Scenery/X-Plane 12 Global Scenery).

Building tiles can be accomplished individually or as a batch. For first time users, consider creating an individual tile first to make sure everything is functioning as expected before creating a large batch of tiles.

Building a single tile

  1. Specify the region for building a tile by opening the Tiles collection and management window and double-clicking the desired area to set that as the active tile indicated by a yellow box. The latitude and longitude in the top left corner of the Tiles collection and management window should match the latitude and longitude in the top left corner of the main window.

  2. Modify settings as desired on the Tiles Configuration tab in the Ortho4XP Config window and click "Save Tile Config". Specify the imagery source and zoom level on the top of the Ortho4XP main window.

  3. Build the tile by clicking "All in one" in the main window at which point you should see text in the output window as the tile is built.

Building multiple tiles

  1. Specify the regions for building tiles in the Tiles collection and management window by holding Shift and clicking (left) the desired areas which will be indicated by a red box.

  2. Modify settings as desired on the Tiles Configuration tab in the Ortho4XP Config window and click "Save Tile Config". Specify the imagery source and zoom level on the top of the Ortho4XP main window. These are the settings that will be used for all tiles.

  3. On the left side of the same window under "Batch build tiles", select the top five options, "Assemble vector data", "Triangulate 3D mesh", "Draw water masks", "Build imagery/DSF" and "Extract overlays". Select "Batch Build" and text in the main window output section should start appearing as the tiles are being built.

  4. The "Read per tile cfg" option can be used if any tiles have their own unique configuration file. This is applicable to both the settings on the Tiles Tab and any custom zones (zoom levels) that have been built. In other words, if this option is not selected during a batch build, any custom zones created for a tile will be lost.

Setting up X-Plane

There's a couple steps that need to be accomplished to make everything work correctly with X-Plane.

  1. When Ortho4XP creates tiles, the extracted overlays are folder titled "yOrtho4XP_Overlays" is built which is located in the base Ortho4XP directory (located in _internal/Ortho4XP_Data/ for users running the pre-packaged version of Ortho4XP). Move or copy the "yOrtho4XP_Overlays" folder to X-Plane's Custom Scenery directory (e.g. /Users/pilot/X-Plane 12/Custom Scenery).

  2. When X-Plane is launched, the "Custom Scenery" directory is searched and if new scenery files are detected, they are added to the scenery.ini file located in that same directory. This file determines the order in which scenery is loaded/prioritized and will need to be adjusted for everything to load correctly. Launch X-Plane and after getting to the main menu, quit X-Plane and open the scenery.ini file located in X-Plane Custom Scenery directory. Several entries will be present but the ones that need to be moved are those the Ortho4XP produced overlay and tiles folders. Move the SCENERY_PACK Custom Scenery/yOrtho4XP_Overlays/ and SCENERY_PACK Custom Scenery/zOrtho4XP_+33-112/ to the bottom. For an X-Plane install with only the default U.S. scenery and no other scenery add-ons, the file should look like the picture below:

scenery file

If multiple tiles were built, then multiple lines for each tile will be present (zOrtho4XP_+xx-xxx).

For more information on organizing the scenery.ini file, refer to the explanation on the simHeaven FAQ.

Clone this wiki locally