FGFS-4.1/fgmeta
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0ddf75b382
fgmeta/catalog
History
James Turner 14ee759409 Fix Python3 compatability
2020-03-24 14:27:27 +00:00
..
fgaddon-catalog Catalogs: Expansion of the zip archive exclusion file. 2019-11-13 22:18:43 +01:00
fgaddon-catalog-ukmirror Add Mespieler aircraft mirror 2020-03-21 18:41:45 +00:00
legacy-catalog Catalog configs from UKmirror 2018-10-23 12:01:58 +00:00
single-craft-catalog-test Catalogs: Addition of example configuration files for testing a single craft. 2019-11-14 12:00:02 +01:00
stable-2018-catalog Add Mespieler aircraft mirror 2020-03-21 18:41:45 +00:00
testData Catalogs: Rewrite of the craft zip creation using the Python zipfile module. 2019-11-13 22:25:49 +01:00
catalog.py Catalogs: Python3 does not have a 'long' integer type. 2019-11-18 10:10:22 +01:00
catalogTags.py Add more catalog tags based on what’s used 2020-03-24 14:24:29 +00:00
check_aircraft.py Check-aircraft helper script 2018-07-25 13:42:13 +01:00
README.md Catalogs: Addition of an initial README.md file. 2019-11-18 11:23:27 +01:00
sgprops.py Fix Python3 compatability 2020-03-24 14:27:27 +00:00
test_catalog.py Catalogs: Rewrite of the craft zip creation using the Python zipfile module. 2019-11-13 22:25:49 +01:00
test_sgprops.py Fix catalog parsing, add unit-tests 2017-02-10 11:55:30 +00:00
update-catalog.py Catalogs: Python 3 compatibility for reading binary data. 2019-11-18 10:26:40 +01:00

README.md

Introduction

This is the directory containing the script for updating aircraft, or other craft, catalogs. It will create the catalog.xml file used to add a hangar to FlightGear, as well as the zip archives of each craft in the hangar and the md5sums, thumbnails, and previews of these. It consists of the script:

  • update-catalog.py

And its Python modules:

  • catalog.py
  • catalogTags.py
  • sgprogs.py

Usage

The script can be run directly from this directory, or the script and its modules can be copied together and run from any location. The steps to use these are:

  • Create an output directory where the catalog and zip files will be located.
  • Copy the configuration files catalog.config.xml, template.xml, and zip-excludes.lst from one of the *catalog* example directories into the output directory.
  • Modify these files as required.

Then run the script with:

$ $FGMETA/catalog/update-catalog.py dir

where dir is the output directory. The script will create the following files:

  • md5sum.xml: A file containing checksums of all craft zip archives in the base output directory.
  • ftp/catalog.xml: The XML catalog to upload to a server and advertise to FlightGear users.
  • ftp/*.zip: The zip archives of each craft in the hangar.
  • ftp/previews/*_Splashs/: A directory per craft containing the splash screen graphics.
  • ftp/thumbnails/: The collection of thumbnail graphics for the hangar.

The ftp directory is to be uploaded to a server which can be configured via the catalog.config.xml file.

Examples

A number of example configuration files are located in this directory. These include:

  • fgaddon-catalog/: The configuration files used for the official FGAddon hangar.
  • `stable-2018-catalog/': The configuration files used for the 2018 long term stability release.
  • single-craft-catalog-test/: Configuration files used for testing the catalog and zip archive creation for a single craft. These are for content developers to test their craft.