PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Add info about devtools and testing builds
All checks were successful
Build and Deploy MkDocs / build-next (push) Successful in 49s
Details

Browse Source
This commit is contained in:
Skylar Ittner 2026-02-14 01:01:30 -07:00
parent fb6a2a8af9
commit 5f103b6102
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/index.md
View File

@ -14,6 +14,21 @@ PostalPoint® supports JavaScript plugin extensions. Plugins can hook into Posta
* Display interactive HTML5 content on the customer-facing screen * Display interactive HTML5 content on the customer-facing screen
* Run both Node.JS and browser code. * Run both Node.JS and browser code.
## PostalPoint DevTools and Testing Builds
The [PostalPoint build server](https://build.netsyms.net/job/PostalPoint_Retail/)
creates installers from the latest prerelease changes. It is not recommended to use these
builds for production purposes, but they contain the latest changes to plugin APIs.
For Windows developers, you'll want to download a "postalpoint-retail-sdk_x.xx.exe" installer,
as it contains the Chromium DevTools.
To enable DevTools on Linux, simply run `sudo apt install nw.js-sdk` and restart PostalPoint.
To access the DevTools, press F12 or right-click anywhere inside PostalPoint and click Inspect.
Depending on various factors, some plugin console output may go to the "background page";
right-click and click "Inspect background page" to view that console.
## Plugin Package Structure ## Plugin Package Structure
A plugin is distributed as a simple ZIP file, containing a folder. The folder then has at least one file, named `plugin.js`. A plugin is distributed as a simple ZIP file, containing a folder. The folder then has at least one file, named `plugin.js`.