Template Plugin Manual

Author

Plugin created by ©Kupofty 2026

Manual Version

This manual applies to version x.y.z.

See what’s changed in the CHANGELOG.

Overview

Template_pi is an OpenCPN plugin.

It is a template for quickly developing your own OpenCPN plugin.

It provides a basic starting point for developing and coding a new OpenCPN plugin.

Links

Sources:

Discussions:

Installation

Method 1: Plugin Manager (Recommended)

  1. Open OpenCPN

  2. Go to Options → Plugins

  3. Update catalog and search for the YOUR_PLUGIN_NAME plugin

  4. Click Install then Enable

Method 2: Manual Install (Cloudsmith)

  1. Go to Cloudsmith

  2. Select the correct tarball for your OS

  3. Download the .tar.gz archive (not the .xml)

  4. Click on Options → Plugins → Import plugin…​

  5. Enable plugin in Options → Plugins

Method 3: Build from Source (Github)

Clone the repository:

git clone --recurse-submodules https://github.com/Kupofty/Template_pi

Create the build directory:

mkdir build
cd build
Linux
cmake ..
make tarball
Windows
cmake .. -A Win32
cmake --build . --config Release --target tarball

Import the tarball in OpenCPN via Options → Plugins → Import plugin…​ and enable it.
For more information, see the INSTALL.md file in the GitHub repository.

User Interface

TODO

Right-click menu

TODO

Settings

TODO

Notes

TODO