Updates and bug fixes

.gitignore

@@ -1,4 +1,6 @@
 Binary/
+build/
+dist/
 Elevation_data/
 Geotiffs/
 Masks/
@@ -9,9 +11,12 @@ Previews/
 Extents/Auto
 tmp/
 Tiles/
+venv/
 **/Ortho4XP.log
 **/__pycache__
 **/Thumbs.db
 **/*.bak
 **/*.swp
+*.spec
 .last_gui_params.txt
+.DS_Store

Licence/copyright.txt

@@ -56,24 +56,22 @@ http://dev.x-plane.com/cgit/cgit.cgi/xptools.git/
 
 ------------------------------------------------------------------------------
 7-Zip
-Igor Pavlov
-
+~~~~~
 License for use and distribution
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-7-Zip Copyright (C) 1999-2018 Igor Pavlov.
-
-Licenses for files are:
+7-Zip Copyright (C) 1999-2023 Igor Pavlov.
 
-  1) 7z.dll: GNU LGPL + unRAR restriction
-  2) All other files:  GNU LGPL
+The licenses for 7zz and 7zzs files are:
 
-The GNU LGPL + unRAR restriction means that you must follow both 
-GNU LGPL rules and unRAR restriction rules.
+        - The "GNU LGPL" as main license for most of the code
+        - The "GNU LGPL" with "unRAR license restriction" for some code
+        - The "BSD 3-clause License" for some code
 
+Redistributions in binary form must reproduce related license information from this file.
 
-Note: 
-  You can use 7-Zip on any computer, including a computer in a commercial 
+Note:
+  You can use 7-Zip on any computer, including a computer in a commercial
   organization. You don't need to register or pay for 7-Zip.
 
 
@@ -90,21 +88,48 @@ GNU LGPL information
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.
 
-  You can receive a copy of the GNU Lesser General Public License from 
+  You can receive a copy of the GNU Lesser General Public License from
   http://www.gnu.org/
 
+BSD 3-clause License
+--------------------
+
+  The "BSD 3-clause License" is used for the code in 7z.dll that implements LZFSE data decompression.
+  That code was derived from the code in the "LZFSE compression library" developed by Apple Inc,
+  that also uses the "BSD 3-clause License":
+
+  ----
+  Copyright (c) 2015-2016, Apple Inc. All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+  1.  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+  2.  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
+      in the documentation and/or other materials provided with the distribution.
+
+  3.  Neither the name of the copyright holder(s) nor the names of any contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  ----
 
-unRAR restriction
------------------
+unRAR license restriction
+-------------------------
 
-  The decompression engine for RAR archives was developed using source 
+  The decompression engine for RAR archives was developed using source
   code of unRAR program.
   All copyrights to original unRAR code are owned by Alexander Roshal.
 
   The license for original unRAR code has the following restriction:
 
-    The unRAR sources cannot be used to re-create the RAR compression algorithm, 
-    which is proprietary. Distribution of modified unRAR sources in separate form 
+    The unRAR sources cannot be used to re-create the RAR compression algorithm,
+    which is proprietary. Distribution of modified unRAR sources in separate form
     or as a part of other software is permitted, provided that it is clearly
     stated in the documentation and source comments that the code may
     not be used to develop a RAR (WinRAR) compatible archiver.

Ortho4XP.py

@@ -37,7 +37,6 @@
     IMG.initialize_combined_providers_dict()
     if len(sys.argv)==1: # switch to the graphical interface
         Ortho4XP = GUI.Ortho4XP_GUI()
-
         Ortho4XP.mainloop()	    
         print("Bon vol!")
     else: # sequel is only concerned with command line 

Providers/Global/EOX.lay

@@ -1,6 +1,5 @@
 request_type=tms
 grid_type=webmercator
-url_template=https://{switch:a,b,c,d}.s2maps-tiles.eu/wmts/?layer=s2cloudless_3857&style=default&tilematrixset=GoogleMapsCompatible&Service=WMTS&Request=GetTile&Version=1.0.0&Format=image%2Fjpeg&TileMatrix={zoom}&TileCol={x}&TileRow={y}
+url_template=https://{switch:a,b,c,d}.tiles.maps.eox.at/wmts/?layer=s2cloudless-2023_3857&style=default&tilematrixset=GoogleMapsCompatible&Service=WMTS&Request=GetTile&Version=1.0.0&Format=image%2Fjpeg&TileMatrix={zoom}&TileCol={x}&TileRow={y}
 max_zl=14
-imagery_dir=grouped
-
+imagery_dir=grouped

Providers/O4_Custom_URL.py

@@ -77,7 +77,7 @@ def get_Here_value():
         Here_value="loading"
         js_path=str(requests.get('https://wego.here.com').content).split('<script defer="defer" src="')[1][:100].split('"')[0]
         print("js_path: "+js_path)
-        Here_value=str(requests.get('https://wego.here.com'+js_path).content).split('APP_KEY:"')[1][:100].split('"')[0]
+        Here_value=str(requests.get('https://wego.here.com'+js_path).content).split('PLATFORM_API_KEY:"')[1][:100].split('"')[0]
         print("Here_value: "+Here_value)
         Here_time=time.time()
     return Here_value

README.md

@@ -1,32 +1,66 @@
 # Ortho4XP
-A scenery generator for the X-Plane flight simulator.
-
-NOTE 15/02/2024 : In transition to version 1.40.
-
-Version 1.40 is mostly a compatibility update for XP 12 water requirements.
-Some newer code related to 3D waterbed rendering is included, but one will have
-to wait for XP 12.1 to potentially revise it. The default setting is XP11 (i.e. 
-overlay based ) water rendering + bathymetry for 3D water and physics plane interaction. 
-The new Ortho4XP tiles also automatically bring the seasons, sounds, etc raster from the
-corresponding Global Scenery tiles.
-
-The code as been updated to work with recent versions of the python modules it
-depends on (you may have experienced some deprecation warnings or even some
-code break due to Numpy, Pyproj and Shapely, these should be fixed with this
-update). The only new python module used is skfmm (Fast Marching Method) and is only needed when using 
-the distance_masks_too option, the program will run even without it.
-
-
-TODO :
-- Update install instructions (after user first tests). The ones included have
-  not been updated at all, but the same list of decently recent python modules should 
-  work out of the box.
-- Check and update providers status.
-- Compile nvcompress for OSX ARM64 (the included version is the old one renamed without the
-  .app). A Linux version of nvcompress is included now because some distros are apparently 
-  no longer shipping it. Triangle4XP has been updated for all OS, including ARM based Mac.
-  I have not tested anything but Linux software.
-- Incorporate some code changes that were in the old "devel" version (the
-  present is an update from the v130 master branch only).
-- Do something about the 3rd party initiatives to provide some Docker or other 
-  Plug and Play versions.
+![example](https://github.com/shred86/Ortho4XP/assets/32663154/f06ebfe5-ba1d-4f05-9439-8e569bd99ef5)
+
+Ortho4XP is a scenery generation tool for [X-Plane](https://www.x-plane.com). It creates the scenery base mesh and texture layer using external data and orthophoto sources.
+
+This is a forked version of [Ortho4XP](https://github.com/oscarpilote/Ortho4XP) developed by [@oscarpilote](https://github.com/oscarpilote) which includes some updates, fixes and documentation. The official version is infrequently updated which is the reason I created this forked version to provide quicker updates and documentation.
+
+The specific changes in this forked version:
+
+#### General
+* Tile configurations are automatically loaded when the active tile is changed using the Tiles Collection and Management window. If a tile configuration doesn't exist, the global tile configuration settings are used. The tile configuration is not loaded if you manually type in coordinates to change the active tile.
+* Code changes to enable using [PyInstaller](https://pyinstaller.org/en/stable/) to bundle Ortho4XP and its dependencies into a single package.
+
+#### Tiles Collection and Management
+* Batch building process modified in regards to configuration files. If a tile configuration exists, it will be used. If a tile configuration does not exist, the global configuration will be used.
+* "Read per tile cfg" removed and a "Override tile cfg" option added. This override setting allows you to force using the global configuration setting on all tiles, overriding any existing tile configurations.
+* Erased cached data feature works like batch building tiles now, meaning Shift-Click (red rectangle) to select tiles, choose deletion options, and click "Batch Delete". The batch delete has no effect on the active tile selection (yellow rectangle).
+* Display asterisk next to each tile zoom level number in the Tiles and configuration window if custom zoom levels have been specified.
+* Added ability to create a symlink to the yOrtho4XP_Overlays folder by pressing the "O" key in the Tiles Collection and Management window.
+
+#### Config
+* Ortho4XP Config window is now separated into three tabs: Tile Config, Global Config, and Application Config. 
+* When a tile configuration doesn't exist, the Tile Tab fields will become read-only. Clicking "Save Tile Cfg" in this case will make the fields become editable again since a tile configuration now exists.
+* Text added at the top of the Tile Tab window which provides information on whether a tile configuration was loaded, or global defaults are being used.
+* "Apply" buttons removed since this occurs automatically when a tile is changed, and the configuration is loaded. It also occurs when you click "Save".
+* A "Reset to Global" button was added to the Tile Config tab which will reset the tile settings to the global tile config settings. If custom zones exist, a prompt asserts asking to save the zones. You still must select "Save Tile Config" if you want to save the changes. 
+* A "Reset to Defaults" button was added as a part of the Global Config and Application Config tabs which will reset the tile and application settings to the application defaults. You still must select "Save Tile Config" if you want to save the changes. These buttons are independent of each other so if you're on the Global Config tab, it will reset just the tile settings in your global config and if you're on the Application Config tab, it will reset just the application settings in your global config.
+* "Load Backup Cfg" buttons added to the Tile, Global, and Application Config tabs which loads settings from a backup config file (if available).
+* Added ability to set an alternate `custom_overlay_src` directory to resolve an issue for some users. The default X-Plane scenery files are split up between `/X-Plane 12/Global Scenery/X-Plane Global Scenery` and `/X-Plane 12/Global Scenery/X-Plane Demo Areas`. So if you set `custom_overlay_src` to the first directory and try to batch build a bunch of tiles, you might get an error that the .dsf file can't be found if it's a location where the .dsf files are located in the second directory.
+* The `custom_dem` and `fill_nodata` settings are now saved to the global configuration.
+* Prompt user if attempting to close the application or config window with unsaved changes.
+* Prompt user if attempting to change the active tile with unsaved changes on the Tile Tab in the config window.
+* Prompt user if attempting to build tiles with unsaved changes in the config window.
+* Backup of the tile configuration is created when using the "Save Tile Config" button (previously was only during a tile build process).
+
+#### Miscellaneous
+* Automatically saves the same data (active tile, default provider, default zoom level and base folder) that the power button icon does when you close the application using the operating system close button.
+* Additional console messages addeded to provide more feedback. These are categorized with a verbosity setting of 1 (default).
+* "Part of image could not be obtained" error will now show a summary message at the end of a batch build.
+* Minor visual tweaks which included moving the "Refresh" and "Exit" buttons to the bottom of the left side in the Tiles collection and management window to better illustrate the "Refresh" button is not tied to Batch Build only.
+* Includes Windows Python dependency wheel files for gdal and scikit-fmm.
+* Update and pin requirements to latest working versions.
+* Adds a bash script to automate the setup process for those that prefer not to use the packaged version.
+* Removed Maxar and Mapbox image providers which are no longer publically available.
+* Removed unavailable OSM FR and updated RU server with a working URL.
+* Include 7-zip executable for macOS.
+
+#### Bug Fixes
+* If one-click symlink feature is used, added removal of symlink when "Erase cached data" "Tile (whole)" option is used.
+* Fixed zones being saved to tile configuration that were outside of the tile location.
+* Fixed a bug where symlinks weren't automatically deleted if you used the Erased cached data - Tile (whole) option.
+* Fixed a bug if you created zones on a tile then clicked "Apply" (which no longer exists as a button) before saving the tile config, it would delete your zones.
+* Fixed Viewfinderpanorama elevation source for certain regions of the world.
+* Fixed Here (https://wego.here.com/) image provider API key.
+* Fixed issue in certain coastal regions where .dds files were being deleted with cleaning_level set to 2 or higher.
+* Corrected a few typos in setting descriptions.
+* Default `imprint_mask_to_dds` to `False` to prevent issues when using `water_tech=XP12`.
+
+
+## Installation
+
+For installation instructions, refer to the [Installation page](https://github.com/shred86/Ortho4XP/wiki/Installation) in the [Wiki](https://github.com/shred86/Ortho4XP/wiki).
+
+## Support
+
+Troubleshooting steps for some issues are provided in the [Wiki FAQ](https://github.com/shred86/Ortho4XP/wiki/FAQ). For additional support or questions, refer to the [Ortho4XP forum](https://forums.x-plane.org/index.php?/forums/forum/322-ortho4xp/) at [X-Plane.org](https://forums.x-plane.org).