User Tools

Site Tools

Trace:
simulator:text_files

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
simulator:text_files [2017/01/17 21:18] – ↷ Page moved from aircraft:text_files to simulator:text_files jhsimulator:text_files [2020/05/10 20:00] (current) – ↷ Links adapted because of a move operation jh
Line 6: Line 6:
   * [[aircraft:tmd|TMD]] - aircraft definition files   * [[aircraft:tmd|TMD]] - aircraft definition files
   * [[aircraft:tmc|TMC]] - aircraft description files   * [[aircraft:tmc|TMC]] - aircraft description files
-  * [[aircraft:tmr|TMR]] - aircraft repaint files +  * [[sdk:scenery_tsc|TSC]] - scenery and object description files
-  * [[scenery:tsc|TSC]] - scenery and object description files+
   * [[simulator:mcf|MCF]] - main simulator configuration files   * [[simulator:mcf|MCF]] - main simulator configuration files
-  * [[simulator:log|LOG]] - simulator log-files+  * [[simulator:log|LOG]] - simulator text output file (is generated)
  
 ===== Recommended Text Editors ===== ===== Recommended Text Editors =====
Line 15: Line 14:
 For editing all Aerofly FS 2 text files the IPACS development team recommends using one of the following UNICODE capable text editors. For editing all Aerofly FS 2 text files the IPACS development team recommends using one of the following UNICODE capable text editors.
  
-   * EditPad Pro +   * Visual Studio 2019 
-   * UltraEdit +   * [[https://www.editpadlite.com|EditPad Lite/Pro]] 
-   * [[http://notepad-plus-plus.org/|Notepad++]]+   * [[https://www.ultraedit.com|UltraEdit]] 
 +   * [[https://notepad-plus-plus.org/|Notepad++]]
    * Windows Wordpad    * Windows Wordpad
  
Line 23: Line 23:
  
 Throughout all files of the Aerofly FS 2 English is the language of choice. Descriptive names that are usually separated by white spaces in the common language or hyphens are usually written in CamelCase in the Aerofly FS 2 files. This means that the spaces and hyphens are left away and the following letter after the separation is turned into an upper case letter instead. Throughout all files of the Aerofly FS 2 English is the language of choice. Descriptive names that are usually separated by white spaces in the common language or hyphens are usually written in CamelCase in the Aerofly FS 2 files. This means that the spaces and hyphens are left away and the following letter after the separation is turned into an upper case letter instead.
 +
 +===== Units and Coordinate Systems =====
 +
 +Aerofly FS 2 uses the international system of units (SI) exclusively. This means that all lengths and dimensions are meters, masses are in kilograms, forces are in Newtons, power values are in Watts, speeds are in meters per second.
 +Any rotation uses the positive mathematical direction (anti-clockwise), and all angles are measured in radians (1 rad = 180/pi degrees = 57.3°).
 +Fractions are used instead of percentages (20% would be written as 0.2).
 +
 +The coordinate system the entire aircraft is defined in the 3D model of the aircraft. The origin is usually placed close to the center of gravity but does not have to be. The forward flight direction defines the x-axis of the aircraft's coordinate system.
 +The y-axis points towards the left of the aircraft, the z-axis points straight up. One unit in the coordinate system represents a real world length of one meter. The 3D model may use a scale factor which is removed when the aircraft is exported.
  
 ===== Character Set ===== ===== Character Set =====
  
-Except in the description text in the specific languages in aircraft [[sdk:aircraft:tmc|TMC]]-files and other descriptive files only the following characters are to be used in any of the above mentioned text files. Only by strictly maintaining only a certain character set it can be assured that all content can be loaded without any issues across different platforms.+Except in the description text in the specific languages in aircraft [[aircraft:tmc|TMC]]-files and other descriptive files only the following characters are to be used in any of the above mentioned text files. Only by strictly maintaining only a certain character set it can be assured that all content can be loaded without any issues across different platforms.
  
   * ''<'',''>'',''['','']'', ''('', '')'' to define the tree structure   * ''<'',''>'',''['','']'', ''('', '')'' to define the tree structure
-  * white spaces for separation of lists+  * white spaces for separation of lists, indentations and additional spacing
   * digits from ''0 - 9'' with a dot ''.'' as decimal separator, minus ''-'' and plus ''+'' as signs   * digits from ''0 - 9'' with a dot ''.'' as decimal separator, minus ''-'' and plus ''+'' as signs
   * English-alphabet from ''A - z''   * English-alphabet from ''A - z''
Line 37: Line 46:
   * \r\n as line endings (carriage return and line-feed)   * \r\n as line endings (carriage return and line-feed)
  
-Especially forbidden is the usage of tab indentation or separation. Instead four white spaces are used for indentation and multiple white spaces for separation.+Especially forbidden is the usage of **tab** indentation or separation. Instead four white spaces are used for indentation and multiple white spaces for separation.
  
 ===== Syntax ===== ===== Syntax =====
Line 46: Line 55:
 A single opening pointy bracket ''<'' opens a new section and a ''>'' closes it. After each opening bracket three blocks in pairs of ''['' and '']'' follow. These define three parameters. A single opening pointy bracket ''<'' opens a new section and a ''>'' closes it. After each opening bracket three blocks in pairs of ''['' and '']'' follow. These define three parameters.
  
-<code><[type][classname][value]></code>+<code><[type][name][value]></code>
  
 The first parameter is a definition of the type for the following variable or content. This could be a ''file'', a class-name or object/attribute name as text (''string8''), a double number (''float64'') and so on. The first parameter is a definition of the type for the following variable or content. This could be a ''file'', a class-name or object/attribute name as text (''string8''), a double number (''float64'') and so on.
Line 56: Line 65:
  
 Here is an example code of an typical nested parameter inside an object: Here is an example code of an typical nested parameter inside an object:
-<code><[string8][object][class_name] +<code><[servoclassic][ServoElevator][] 
-    <[string8][Name][ObjectNameA]>+    <[string8][Input][ElevatorInput.Output]>
 ></code> ></code>
  
Line 64: Line 73:
  
 Spaces and empty lines can be used throughout the entire file, for example to indent the parameters better: Spaces and empty lines can be used throughout the entire file, for example to indent the parameters better:
-<code><[string8][object][class_name] +<code><[class_name][ObjectName][]
-    <[string8][Name][ObjectNameA]>+
     <[float64][VeryLongAttributeNameThatWontEnd][1.0]>     <[float64][VeryLongAttributeNameThatWontEnd][1.0]>
     <[float64][SimilarAttribute]                [1.0]>     <[float64][SimilarAttribute]                [1.0]>
Line 78: Line 86:
 A comment is started by a double slash ''%%//%%'' and spans the entire line. Comments within a parameter (before a closing ']') are not allowed. All text inside a comment is ignored by the Aerofly FS 2 engine. A comment is started by a double slash ''%%//%%'' and spans the entire line. Comments within a parameter (before a closing ']') are not allowed. All text inside a comment is ignored by the Aerofly FS 2 engine.
  
-> ''/*'' and ''*/'' do not work as comment markings+> ''/*'' and ''*/'' do not work for commenting.
  
  
simulator/text_files.1484684337.txt.gz · Last modified: 2017/01/17 21:18 by jh