Postals

This plugin utilizes API endpoints that require the standard version of Sonoran CAD or higher. For more information, view our pricing page.
Looking for VPS, web, or dedicated hosting? Check out our official server hosting!
Installation Video
Click to view our locations and postal install video.
Be sure you have already installed our plugin framework!
Installation Guide
1. Download and Install the Framework
If you haven't already, be sure to install and configure the plugin framework first.
2. Download the Plugin and Dependencies
1.Click HERE to download the postals plugin .zip file.
2.Download and install the locations plugin.
3. Install the Plugin and Dependencies
1.Follow the standard plugin installation guide for the postals and locations plugin.
4. Configure Postal Script and Exports
1.If you're using the publicly available nearest postals script, you will need to follow the steps in the usage section below.
2.If you're using a custom postal script, you can learn more about the exports provided in the usage section below.
Configuration
Option
Description
Default
sendTimer
Time between sending postal updates to the server.
950 ms
shouldSendPostalData
Toggles the plugin on/off
True
Usage
Using Nearest-Postal​
The plugin only supports 1.5.0 or higher of the nearest postals plugin. Be sure to download the latest version before using.
If you're using the publicly available nearest postals script, some minor configuration is required.
1. Set the Resource Name
In the Sonoran CAD postals plugin config, change the nearestPostalsResourceName value to the exact name of your nearest postals resource.

Ex: nearest-postals-1.5
2. Ensure Proper Startup Order
Be sure that you are starting the nearest-postals addon/resource before/above where you ensure sonorancad in your server.cfg.
Be sure to restart both the Sonoran CAD resource and the nearest-postals script, or restart your server entirely to apply the changes made.
Custom Postal Scripts
This plugin no longer has a "custom" option. If you're not using the nearest postal script, you will need to create an export called getPostal in that script and have it return the player's current postal as a string. Need help? You can always hire a developer.