Skip to content

Commit

Permalink
more order in distributables, more structure in readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
u-an-i committed Oct 8, 2023
1 parent a6ef5cf commit 626a66b
Show file tree
Hide file tree
Showing 6 changed files with 378 additions and 20 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Globe
raster tiles maps on sphere renderer
raster tiles maps on sphere renderer

# libraries utilised
SDL, libjpeg-turbo, c-hashmap
SDL, libjpeg-turbo, c-hashmap, miniLZO

- https://github.com/libsdl-org/SDL/tree/SDL2
(clone and follow docs/README-...)
Expand All @@ -14,14 +14,22 @@ SDL, libjpeg-turbo, c-hashmap
with https://github.com/Mashpoe/c-hashmap/pull/6
(copy files to this project)
(compiled as DLL in distributables,
DLL header named "c-hashmap.h")
DLL source header named "c-hashmap.h")
- http://www.oberhumer.com/opensource/lzo/
in form of miniLZO
(copy files to this project)
(compiled as DLL in distributables,
DLL source header named "miniLZO.h")

(versions as of writing these lines)

# Windows application
distributables compiled in
Visual Studio 2022 17.7.4 with Intel C++ Compiler 2023.2.1
distributables built
in
Visual Studio 2022 17.7.4
with
Intel C++ Compiler 2023.2.1

see
https://www.intel.com/content/www/us/en/docs/cpp-compiler/developer-guide-reference/2021-10/use-the-intel-c-compiler-classic-math-library.html
for compiler options regarding long double usage
for compiler options regarding long double utilisation
39 changes: 25 additions & 14 deletions distributables/Readme.txt
Original file line number Diff line number Diff line change
@@ -1,36 +1,47 @@
requires an online connection
requires an online connection*

defaults to mapbox satellite maps requiring an access token
(free as of writing this line: https://account.mapbox.com/auth/signup)

put access token / api key (=: key) into file mapservice-key.txt
on first line, save as UTF-8 encoded Unicode text

keys of length up to and including 4096 bytes
(around 4096 latin characters) are supported,
key may not contain a % character
keys of length up to and including 4096 bytes (around 4096 latin characters)
are supported, key may not contain a % character

raster tile maps of any service are supported when
service delivers 256x256 sized JPEGs
service url identifies map tiles by a z/x/y scheme
service url does not contain a % character
service url is below or equal 4096 bytes in size
- service delivers 256x256 sized JPEGs
- service url identifies map tiles by a z/x/y scheme
- service url does not contain a % character
- service url is below or equal 4096 bytes in size
- service map tile identified by 0/0/0 's map spans longitudes
from -180° at the left to +180° at the right and latitudes
from +90° at the top to -90° at the bottom

put service url in file mapservice-url.txt on first line,
do not include protocol and ://, so no https://,
replace z/x/y map tile identifying url part by ^^,
if required, replace key url part by <<,
save as UTF-8 encoded Unicode text

control globe by W, A, S, D and arrow keys on keyboard and your mouse
control globe by W, A, S, D and arrow keys on keyboard,
control globe by your mouse

if zooming closer results in a black image the map service
does not support that zoom level
if zooming closer results in a black image, the map service does not support
that zoom level, the application supports zoom level from including 0 to
including 30

the application not informs about failed retrieval of map tiles
eg when the key is invalid, the window remains black in such case
the application not informs about failed retrieval of map tiles, e.g. when
the key is invalid nothing gets rastered, and the window remains black

if the application does not start, you might need the Visual Studio 2022
X64 Visual C(++) Redistributable you can find at
https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist
as of writing this line
as of writing this line

elevation data averaged from https://ngdc.noaa.gov/mgg/topo/globe.html

*you can download raster tile maps and setup a server for them locally
and put the url to them into the mapservice-url.txt file like described
in this Readme.txt file, describing setting up a server for them is out
of scope of this project
File renamed without changes.
Binary file added distributables/data/elevation.lzo
Binary file not shown.
Loading

0 comments on commit 626a66b

Please sign in to comment.