Sceneryconfigeditor: V. 1.1.9 User Guide
Sceneryconfigeditor: V. 1.1.9 User Guide
SceneryConfigEditor
v. 1.1.9
User Guide
......................................................................................................................................
Andrew Thornton 2017-06-11
Table of Contents i
Table of Contents
.......................................................................................................................................
1. Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
2. About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
3. Initial Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
4. Introductory Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5. The List View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
6. The Text Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7. Group View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8. Actions Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
9. Restore Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
10. Localization and Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
11. Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
12. Version History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1 About
.......................................................................................................................................
1.2 Why is this better than using the FSX editor or other editors?
There are multiple new additional features included in this program, including the ability to create
groups, automatic detection of some errors, automatic fixing of other errors, abilities to add areas in
bulk, drag-and-drop functionality... and many more. Further, it's open source.
1.5 I really like this and want to give you some money
Really?! Thanks, you can donate some British Pounds or US Dollars to my paypal account here:
Donate
2 Initial Setup
.......................................................................................................................................
It is probably advisable to make back-ups of your scenery.cfg files before using this tool. We believe
that this tool is safe and we have been using this tool ourselves, however, we make no claim that it is
perfect and accept no responsibility for damage to your FlightSimulator installation. Usual Warranty
disclaimers apply; see the Licence. (The “Save As” functionality can be used for backing up scenery
files.)
On first loading you should get the startup screen with warning box, as shown, press OK
Startup Screen
This will take you to the preferences dialogue where you should either select the the button
corresponding to required FSim (9/10) or browse to find the required directory.
Preferences Dialog
If you use ORBX or FTXCentral - I would recommend you set the Automatically restore groups from
backup option.
There are a number of other options on this screen and if you are using a networked system you may
wish to set the filesystem aliases now. See the technical notes below. Otherwise leave them blank, and
keep the “Follow the NewScenery convention” option set.
When you then press OK on the preferences, the default scenery file will be loaded. The program will
load this file by default from now on.
All users must do the above procedure, after which you should be presented with a view similar to list
view shown below.
List View
Assuming all appears as in the list view, if you're non-technical please go to the Introductory
Use section below.
3 Introductory Use
.......................................................................................................................................
Before you proceed, you should select the tab Group View which should appear similar to below.
This will contain a box titled Ungrouped and in brackets the number of Areas which have not been
allocated to groups and/or activated. It is now you will have to determine what methodology you are
going to use to define your groups, i.e. countries, continents, hemispheres or flight plans etc. If you
then select any number of these areas and click the “Add to group” button in the right-hand pane. You
will get a pop-up box with an editable drop-down box containing all previous groups and the option to
name a new group. (You can select multiple areas using ctrl-clicking, or shift-clicking.)
Ideally one should create a group containing all of the default scenery that is included in the basic
installation of FS (see the Group View section below on how to create the zzzbasic group.) This basic
group should then always be enabled. As you add more and more scenery, you should place these
in other groups, so that if the proverbial ctd occurs and you suspect scenery files are the culprit; All
you need to do is turn off all the groups except zzzbasic and reboot FS. If FS comes back, then start
reselecting groups until the CTD happens again. You then know which group of areas is at fault; so
turn off all but 1 area within that group restart FS and progressively re-enable areas until the fault
happens again.
Once you have selected which groups and scenery layers are enabled you can save your scenery.cfg
using the save option of the file menu or by pressing CTRL-S. Your FS scenery.cfg will then be
modified to reflect the changes you have made. That the changes have become operative, should be
reflected in that on boot-up FS will generate new scenery indexes. Verification can be checked by
selecting to view the scenery library on start up.
Remember no changes will take place irrespective of what you do in this program, until you click
Save on the file menu or press CTRL-S. So if you get in a tangle/ lose direction etc, just close the
program and then reboot it and start again.
On Installation of new Scenery, just install as per software instructions, then run this program and
it should show the new scenery at the top of the list in the list view. You can then manipulate it as
above. You can also use the Add Area button on the list view to add the scenery directly. (Please note,
however, some installers do not use the NewScenery.cfg convention, it would be best to run Flight
Simulator before any installation to get Flight Simulator to recognise your latest changes.)
This view is set up so as to mirror the functionality of the FS9 scenery library editor. It has the same
tools as the editor, with the addition of the “Set Priority” button and double-click to edit functionality.
(Which both should have fairly obvious semantics!)
This view also has Drag & Drop functionality, sort by table column name functions, and multiple
selection functionality. Drag & Drop of a number of areas will set the priority of the dragged areas to
that of the dropped area using the same functionality as the “Set Priority” button; be warned that when
the table is not sorted by priority this will have a non-obvious result. “Set Priority” of multiple areas
will 'bunch' the areas up and gives them consecutive priority numbers. “Raise” and “Lower” will not
do this bunching but will raise/lower their priorities by one individually.
“Find” (from the Edit menu or CTRL-F) will highlight all found areas in red and report the total
number of found areas. “Find again” ( F3) will find the next found area.
You can add a coloured marker to an areas, using the marker colour on the Add/Edit Area dialog box.
These are just visual markers to help identify sceneries, and cannot currently be sorted on.
Finally, Areas are automatically checked for a number of possible errors. If there are any errors,
this will get shown to you by a red cross in the information section below the buttons. Should an
area have an error, a red warning triangle will appear in the column which where there is a problem,
and information explaining the error will be placed in the Errors column. The main errors that get
shown like this include: Areas which have non-unique titles, (Triangle appears in the title column),
Areas which have non-unique paths, (Triangle appears in the path column), and if you have the check
scenery directories exist option set, Areas where the directory the path relates to cannot be found.
(Triangle appears in the path column.)
If you wish to find the ares which have errors quickly, you can scroll across to the Errors column and
click it. This will re-sort the table and move them to the top. (Clicking it a second time will send them
to the bottom.) You can also click the red cross icon in the information section, this will select all the
areas that have errors.
Remember: No action is saved until you save using the CTRL-S or choose the save option of the file
menu. If you are editing the default scenery scenery.cfg this save action will save as NewScenery.cfg
rather than scenery.cfg.
If there is an error in the structure of your scenery file, or you just like seeing the raw insides of things
this is a syntax highlighted view of your scenery file.
Structural errors are highlighted in red. On the right pane there will be a go to next button which will
take you to the next structural error to fix.
Areas with duplicate Area numbers will have their number highlighted in bold red. Again a go to next
error button will show.
Similarly for Areas with duplicate Layer Numbers.
The minimum free area and layer numbers are listed in the right hand pane to help assist hand editing
of the file.
6 Group View
.......................................................................................................................................
7 Actions Menu
.......................................................................................................................................
On the actions menu there are a few bulk functions.
The first of these is Generate from directory. This allows one to choose a directory and scan
it looking for scenery directories. If any are found, and they are not currently listed within your
scenery.cfg file they will be added at priority 1 within a new group. You should use this functionality
to search a common library directory for subdirectories containing sceneries. For example; if you
store your scenery within separate folders within the Addon Scenery folder this tool allows you search
for these. You can also use this to search the flight simulator folder itself.
Please note this will take a long time on large directory structures. Don't do this on the root folder of
C: !
Another action is the Normalize local paths action. This removes any reference to your flight
simulator directory within scenery config file. This is important if you are using a networked
setup with certain utilities. For example, if you have a scenery listed with the path “ C:\Flight
Simulator 9\Rabbits” and “ C:\Flight Simulator 9” is the flight sim directory this will be
normalized to just “ Rabbits”. (This has been a repeating issue...)
Expand Paths prefixes the flight simulator directory to all relative paths within the scenery
config file. In some ways it can be thought of as the reverse of normalize, however aliases are kept
unchanged.
Fix duplicate area numbers is a more technical action and one I would only recommend you use if
you delete SCENERY.DAT files too. I have provided this action to help fix very confused scenery.cfg
files where multiple areas have been given the same area number. It's not something that happens
often, but the clean up is complex enough that this is required.
Add defaults to areas – Only relevant for the Text editor. The list view and group view do this
automatically.
Delete DAT files Flight Simulator caches the contents of the scenery directories using these files.
Sometimes these caches become out-of-date and cause errors. It is unknown, but suspected, that these
files are somehow related to the Area Number in the scenery.cfg and it is recommended that if you
start changing area numbers you should delete these files. (Flight Simulator will rebuild deleted files
on start-up.)
Reset Area and Layer numbers and Reorder the file Some users have requested this function in
order to rebuild the .cfg so that Area and Layer Numbers match and are ordered in ascending order
within the file. Be aware that this function can have drastic effects if Flight Simulator is caching it's
indexes, and it is suspected that you should delete the SCENERY.DAT files if you run this. If at this
point, things do not turn out as expected, you will have to seek advice from other quarters. We cannot
offer technical support for an MSFS initiated routine. (In much earlier versions of this editor a similar
function was implemented, FS9 did not like that version at all. There were other bugs in that version
but, it made the programmer extremely cautious about changing area numbers. Please, please backup
your files if you want to use this! Until we know this is safe we cannot guarantee that FS will not
barf on this and replace your scenery.cfg with a blank default.)
8 Restore Menu
.......................................................................................................................................
The restore menu is a new addition to editor. Early in the design of the editor it was decided to use
the scenery.cfg file to contain all the additional information about groups and color markers that
the editor generates. This was because there was no evidence that this harmed the flight simulator and
seemed to be the intention of the key=value scheme of the file, and because there was no evidence
that removing disabled sceneries from the file is an effective optimisation. All was well, however,
there are some popular for-profit tools and sceneries available that are removing keys that it doesn't
understand. I have tried to contact the developers of these tools to talk to them about this problem but
they have not responded. I have therefore decided to work around them.
There are number of functions provided on the restore menu, however it is worth noting what the
backup file is, and when it is created and updated. The backup is simply a copy of your last saved
scenery.cfg, however it will only be updated if you have saved and, either closed the editor, or opened
or reloaded the scenery file. This should prevent accidentally losing the backup information when you
are editing, but you should be aware that once you have reloaded or closed the editor you will lose
that old information.
The restore functions available are:
Restore Groups from Backup recovers the groups information from the backup file, which was the
initial requirement for this functionality. There are a number of options: Restore groups only for areas
that don't have groups listed, Restore the missing groups from the backup or simply overwrite the
groups data with that in the backup. You can also restrict the functionality to work on the selected
areas only.
Restore Deleted Areas from Backup will restore areas that are present in the backup but not in the
main file.
Overwrite Scenery from Backup will simply copy the backup back over the main file.
10 Preferences
.......................................................................................................................................
Preferences Dialog
The Preferences dialog allows the user to edit settings related to the behaviour of the editor.
1. The first setting is that of the Flight Simulator Directory. This can either be set by
typing in the path into the input box, using the browse button to find the directory
or using any of the buttons to look up the directory in the registry.
2. The location of the scenery.cfg file can be set by choosing a preset mode or
by selecting the User defined mode and manually setting this. The pre-defined
modes should be correct for most use-cases of this editor - if they are not please
get in contact with me regarding it.
3. The NewScenery convention option allows you to decide whether you wish
to save changes to the default scenery.cfg as NewScenery.cfg. This is a
controversial issue. If you use multiple installers for scenery you will find that
many installers will follow this convention and if you do not follow this convention
you risk corrupting your scenery.cfg.
If you do not use the pre-defined modes for the location of scenery.cfg you may find that
NewScenery does not work for you. In this case ensure you have the correct location for your
scenery.cfg, and if you are sure that this is the case - please get in touch with me - I would
appreciate understanding the situations when this convention does not work.
4. Keep FSX-SE scenery.cfg in sync with FSX scenery.cfg is disabled unless FSX-
SE is installed in coExistence mode and the editor is in FSX or User Defined
mode. When this option is selected, the default scenery.cfg will replicated to the
FSX-SE scenery.cfg - with the addition that paths relative to the FSX directory
will be expanded making them make sense for FSX-SE. This will follow the
NewScenery convention if you have this set.
5. The option to check scenery directories exist will allow the editor to check that
directories referred to in the scenery.cfg exist. This may slow down the editor in
some situations and can therefore be turned off if unwanted.
6. Use last accepted path as default means that the editor will remember the last
directory you selected when using Browse or Add, and will present that as the
next default. You almost always want this option selected.
7. Save path across instances will allow the editor to remember the above path
when you reopen it after closing the editor, and if you have two instances of the
editor open they will share the same last default path.
8. Automatically restore groups from backup will allow the editor to restore
groups automatically if they have disappeared for whatever reason. If you use
FTXCentral or ORBX you will want to set this option.
9. Adjusting the maximum number of undos is possible with this setting.
10.Filesystem Aliases are helpful if you are using a networked system. If you have
C:\A\Mapped\Folder mapped as the network drive Y: then you should use this.
11 Version History
.......................................................................................................................................
V1.1.9
• Charset detection was too aggresive in P3Dv4 mode - and was assuming
UTF16 incorrectly too much of the time.
V1.1.8
• Add support for Prepar3D v4 - including the change of file-encoding.
V1.1.7
• Fix auto restore groups so that the restore is not immediately undone.
V1.1.6
• Ensure that last run version is saved in the preferences, so that welcome screen
only runs once per version.
• Add support for Prepar3D v3.
• Fix bug in set priority code found Alhard Horstmann.
V1.1.5
• Change restore from backup preference to make this the default
• Remove terminal newlines and add a single paragraph between areas on
reorder.
• Fix problem with restore groups whereby terminal slashes are not matched.
• Ensure installer checks for administrator status.
V1.1.4
• Ensure that you cannot create a group with an empty name and ensure they are
always trimmed.
• Bug fix to recognise non-canonically titled area blocks; eg. [aReA.xxx] instead of
[Area.xxx].
• Added option to turn off automatic checking of the existence of scenery
directories as can be quite slow.
• Move to SWT 3.7 because SWT 3.5.2 is at least two years out-of-date.
V1.0.7
• Initial release.
12 Acknowledgements
.......................................................................................................................................
With many thanks to: