Addon: Difference between revisions

Jump to navigation Jump to search
2,102 bytes removed ,  8 December 2017
m
→‎config.xml: obsolete, implemented by rominet
m (→‎config.xml: obsolete, implemented by rominet)
Line 144: Line 144:
   }}</ref>
   }}</ref>


== config.xml ==
{{Out of date}}
Ideally, a minimal config.xml should look like this:
<syntaxhighlight lang="xml">
<?xml version="1.0"?>
<!--
This file is part of FlightGear.
FlightGear is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
FlightGear is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with FlightGear.  If not, see <http://www.gnu.org/licenses/>.
-->
<PropertyList>
  <!-- FIXME: this should probably be using conditions -->
  <require>
  <min-flightgear-version></min-flightgear-version>
  <addon-api-version></adddon-api-version>
  </require>
  <name></name>
  <!-- addon version -->
  <version type="double">1.0</version>
  <authors>list of contributors</authors>
  <description>short text describing the addon</description>
  <changelog>list of recent improvements/changes (e.g. to be shown when updating an addon)</changelog>
</PropertyList>
</syntaxhighlight>
For the time being the {{tag|version}}, {{tag|authors}} and {{tag|description}} are strictly optional. However, addon developers are strongly encouraged to provide such meta information, which is entirely in line with the existing practice in [[Aircraft-set.xml]] files, and doing so will make it much easier in the future to extend/improve on the addon framework, e.g. by making breaking changes, provided that addons specify the proper {{tag|version}} tag.
Furthermore, agreeing early on to provide, require and use such meta-information, will make it increasingly easy to also use the scenery/aircraft management back-ends implemented on top of the [[Catalog metadata]] and [[Package manager]] systems to also use these for installing, managing/updating, and removing addons in the future.


==  main.nas ==
==  main.nas ==

Navigation menu