libraries/kosmindoormap/README.md

0001 # KOSMIndoorMap
0002
0003 A library and QML component for rendering multi-level OSM indoor maps of for example
0004 a (large) train station.
0005
0006 ## Features
0007
0008 User facing:
0009 * Floor-level separation of OSM data and inter-floor navigation using stairs, escalators or elevators.
0010 * Information model for showing details about a selected amenity.
0011 * Support for identifying railway platforms or airport gates in the map data.
0012 * Integration with KPublicTransport line meta-data to show line icons for railway platforms.
0013 * Integration with KPublicTransport rental vehicle data to show availability of rental bikes.
0014 * Integration with KPublicTransport realtime equipment (elevators/escalators/etc) status information.
0015
0016 Technical:
0017 * QPainter and QML integration interface.
0018 * Declarative styling using MapCSS.
0019 * Picking support for implementing interaction with map elements.
0020 * Support for externally provided overlay elements.
0021 * Based on OSM raw data tiles from maps.kde.org.
0022 * Pre-loading and caching API for offline support in applications.
0023
0024 ## Development/Testing
0025
0026 There's two test applications included:
0027 - A fairly minimal widget-based one that can be launched via `$buildir/bin/indoormap -c <lat>,<lon>`
0028   (use e.g. `-c 52.52512,13.36966` for a good example).
0029 - A QML-based one that can be launched via `qmlscene src/app/indoormap.qml`. This one demos a number
0030   of additional features, such as element picking and the KPublicTransport integration.
0031
0032 The latter is also available as nightly build:
0033 * Flatpak:
0034 ```
0035 flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
0036 flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo
0037 flatpak install kdeapps org.kde.kosmindoormap
0038 ```
0039 * [KDE nightly F-Droid repository](https://community.kde.org/Android/FDroid)
0040 * [Raw APKs from binary factory](https://binary-factory.kde.org/view/Android/job/KOSMIndoorMap_android/)
0041
0042 ### Dynamic MapCSS
0043
0044 By default the compiled-in MapCSS files are used. If you put files with the same name into
0045 `$PREFIX/share/org.kde.kosmindoormap/assets/css` or `~/.local/share/org.kde.kosmindoormap/assets/css`
0046 those will be preferred. Symlinking the `src/map/assets` directory to any of those locations is therefore
0047 useful for style development. Styles are reevaluated when switching between them, so this allows testing
0048 style changes without restarting or recompiling the applications.