Home | Contribute | Information Files

Every item in the OpenSceneryX library has an information file, which is called info.txt and sits alongside the item. The information file contains additional stuff about the item, for example details about the author and a description of the item.

If you are planning on contributing to the library, it would be very helpful if you could supply an info.txt file for every item you contribute. This is not essential but would save us time and effort.

Contents

The info.txt file starts with ‘Title:’ followed by the title of the item on the first line, then a separator consisting of a row of ‘=’ signs, followed by some additional fields, followed by another separator and finally a textual description of the item.

For example:

Title: Austin's Red House
=====================
Author: Austin Goudge
URL: http://forums.x-plane.org/index.php?showuser=2431
Email: [email protected]
Author, texture: A. Photographer
URL, texture: http://www.photographerswebsite.com
Email, texture: [email protected]
Author, conversion: A. Convertor
URL, conversion: http://www.convertorswebsite.com
Email, conversion: [email protected]
=====================
Description: An animated *red* house with a *purple* roof that swivels to face the wind direction _except_ on Tuesdays. Based on my own house with subtle differences to do with the animation and colour.

The set of allowed fields are:

Field Name	Required	Allows Duplicates	Description
Title	yes	no	The title of the item. This appears in the documentation.
Author	yes	yes	The name of the original author and copyright holder of this item. This appears in the documentation.
URL	no	yes	The URL for the original author and copyright holder. If present, the author’s name in the documentation becomes a hyperlink pointing to this URL.
Email	no	yes	The email address of the original author and copyright holder. If present and there is no URL, the author’s name in the documentation becomes a hyperlink pointing to this email address.
Author, texture	no	yes	The name of the author and copyright holder on the texture. This appears in the documentation.
URL, texture	no	yes	The URL of the author and copyright holder on the texture. If present, the name in the documentation becomes a hyperlink pointing to this URL.
Email, texture	no	yes	The email address of the author and copyright holder on the texture. If present and there is no URL, the name in the documentation becomes a hyperlink pointing to this email address.
Author, conversion	no	yes	If different to the original author, the name of the person who has converted this item. For example, this may be a conversion from an X-Plane aircraft or from a 3rd party 3D object. This appears in the documentation.
URL, conversion	no	yes	The URL of the conversion author. If present, the name in the documentation becomes a hyperlink pointing to this URL.
Email, conversion	no	yes	The email address of the conversion author. If present and there is no URL, the name in the documentation becomes a hyperlink pointing to this email address.
Author, modification	no	yes	If different to the original author, the name of a person who has modified this item. This appears in the documentation.
URL, modification	no	yes	The URL of the modification author. If present, the name in the documentation becomes a hyperlink pointing to this URL.
Email, modification	no	yes	The email address of the modification author. If present and there is no URL, the name in the documentation becomes a hyperlink pointing to this email address.
Description	yes	no	A description of the item. This can include background information or usage information, and formatting can be included if desired using Markdown.
Note	no	no	An important note regarding this item. This is shown in the documentation with a red warning highlight, and should be used to let the user know about any important pre-requisites, for example if a third party plugin is required to make animation work with the item. Formatting can be included if desired using Markdown.

Template File

Here is a template info.txt file you can download and use as a starting point.