PILOT PLUG REFERENCE MAP CREATOR v1.0.0
========================================

Creates offline geographic reference maps for Pilot Plug.

This tool is intended for users who want to create their own geographic
background map for an area without using QGIS.

It does NOT create navigation objects such as:
- buoys
- depths
- pilot boarding positions
- routes
- waypoints
- custom maritime marks

For those objects, use the separate Pilot Plug User Map Authoring Kit.

SYSTEM REQUIREMENTS
-------------------

- Windows 10 or Windows 11
- Internet connection while setting up the tools and downloading map data
- Sufficient free disk space for the selected area

QGIS is NOT required.
Python is NOT required.

FIRST-TIME SETUP
----------------

1. Extract the complete ZIP to a normal folder.

Example:

C:\PilotPlug\PilotPlug-Reference-Map-Creator-v1.0.0

2. Open PowerShell.

3. Run:

powershell -ExecutionPolicy Bypass -File ".\SETUP_REFERENCE_MAP_TOOLS.ps1"

The setup downloads and configures the required Java and Planetiler tools.

Wait until you see:

SETUP REFERENCE MAP TOOLS RESULT: PASS


CREATE A MAP
------------

From the same folder run:

powershell -ExecutionPolicy Bypass -File ".\CREATE_REFERENCE_MAP.ps1"

Enter the requested:

- Map ID
- Display name
- Country code
- Version
- West longitude
- South latitude
- East longitude
- North latitude
- Default latitude
- Default longitude
- Default zoom

The creator automatically selects an appropriate Geofabrik/OpenStreetMap
source covering the requested area.

When successful you will see:

CREATE REFERENCE MAP RESULT: PASS

The finished .ppmap file will be stored in:

output\


IMPORT INTO PILOT PLUG
----------------------

Copy or transfer the generated .ppmap file to the Android device.

In Pilot Plug open:

MAPS -> IMPORT

Select the generated .ppmap file.


IMPORTANT
---------

Large geographic areas may produce very large map files.

If a map is too large, create a smaller regional map instead of one very
large map.

The Reference Map Creator creates geographic background/reference maps.
It does not create or supply official nautical charts.

Pilot Plug maps are for situational awareness and reference purposes only.
They must not replace official navigational charts, ECDIS, approved
navigation equipment, bridge procedures, or professional judgement.

The Reference Map Creator contains no map publishing, server, VPS, or
Pilot Plug online-catalog capability.

Created maps remain local unless you choose to distribute them yourself.


MAP DATA AND ATTRIBUTION
------------------------

Generated maps use third-party open map data and software.

When displaying or redistributing generated maps, preserve all applicable
OpenStreetMap and other required attribution.

See:

THIRD_PARTY_NOTICES.txt


SUPPORT
-------

Pilot Plug:
https://pilotplug.app/

Facebook support:
https://www.facebook.com/pilotplug
