Skip to content
Ted N. Greene edited this page Apr 18, 2016 · 2 revisions

Welcome to the X-Plane Scenery Development Tools wiki!

Introduction

The X-Plane scenery development tools are used for developing in game scenery for the flight simulator X-Plane (made and sold by Laminar Research). Scenery tools include

  • AC3D Export Plugin - Import and export .OBJ models between AC3D and X-Plane.
  • Command-Line Tools - A suite of DSF, PNG/DDS, and OBJ file manipulators. Also includes XGrinder, for drag and drop action.
  • DataRefEditor - Change X-Plane's built in DataRefs, very useful for plugin developers.
  • MeshTool - A command-line tool to build base meshes from raw data.
  • WorldEditor - A graphical scenery editor. It can create overlay scenery and build and customize airports. It also is the primary interface with the X-Plane Scenery Gateway.

More information and details about file formats and third party tools can be found on the development blog.

Installing and Compiling

For those looking for pre-built binaries, look in the tool links above. Otherwise, checkout the git repo, run git submodule update --init and read the instructions for your OS.

Mac OS X

Prerequisites: cmake command line tools, and X-Code Version 7 or higher

Download the git repo, cmake the X-Code project, cd into libs and run make, and open the X-Code project ./SceneryTool_xcode6.xcodeproj/project.pbxproj

Compilation should be easy from there.

Windows

Prerequisites: Microsoft Visual Studio 2010.

Open up the solution ./msvc/XPTools.sln in the IDE and compile. Load and unload projects as you please. Dependent libraries are precompiled for you in the msvc_libs folder.

If you prefer, you can use the interface of MSVC 201X and (required) compiler of 2010 by opening the .sln in your version and making sure it doesn't automatically convert a project's code or settings. Especially check that each project's Platform Toolset option is still set to v100. Compilation is easy from there.

Linux

Prerequisites: GCC 4.2.x - 4.5.x, gnu make, gnu coreutils, binutils, binutils-devel (if applicable for libbfd.a), libmpfr-devel, qt4-devel, mesa-libGL-devel, mesa-libGLU-devel (or the proprietary variants from ATI or NVidia)

Download the repo, cd into libs, run make, cd .., run make.

Contributing

Reporting Bugs

We use a JIRA bug database, GatewayBugs to handle all our bug tracking. DO NOT report bugs on the github bug page. Remember to be clear, concise, and well-organized in your thoughts. Describe the problem like we can't see your screen (because we can't.)

Also, these tools are open source for a reason! Check the bug base for feature or bug to work on, check the developer blog to see what current priorities are, or e-mail Ben for more help. Pull requests are done with the github pull requests page.

Scenery Development tools do not currently support C++11. Commit only UNIX (LF) line endings.