WraithV2
Implements the Wraith ARS 2X plate reader for automated plate reading.
This plugin utilizes API endpoints that require the Plus version of SonoranCAD or higher. For more information, view our pricing page.
Looking for VPS, web, or dedicated hosting? Check out our official server hosting!
This plugin is for sending plate reads to other plugins.
Showcase Video
View our WraithV2 showcase video!
Installation Video
Click to view our WraithV2 plate reader and lookup installation 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
Click HERE to download the WraithV2 plugin .zip file.
Download and install the lookups plugin.
Ensure the third-party pNotify addon is installed.
3. Install the Plugin and all Dependencies
Follow the standard plugin installation guide for the WraithV2 plugin and the lookups plugins.
4. Configuration
In the config_wraithv2.luafile, set isPluginEnabled in the to true.
Use of this plugin requires the Sonoran version of Wraith ARS 2X radar and plate reader to function. This resource is bundled with the latest SonoranCAD release as wk_wars2x.
You also need pNotify, a third party resource that is not bundled by default.
Config Option
Description
useExpires
use vehicle registration expirations, or not
useMiddleInitial
use middle initials?
alertNoRegistration
alert if no registration was found on scan?
statusUid
Custom record field UID containing the status
expiresUid
Custom record field UID containing the expiration date
flagOnStatuses
List of statuses to flag/alert on
vehTypeFilter
List of Classes that will NOT get ran through CAD
5. Custom Record Handling
If you wish to have the plugin alert when the vehicle is not registered, is marked as stolen, etc. you will need to ensure you have set the custom record field's UID in your config.
Find your custom record field's UID
In the CAD navigate to Admin > Customization > Custom Records > select your custom Vehicle Registration record.
The very last column of the field containing your status and expiration dates will have the Field Mapping ID.
Set the UID in your Config
By default, the statusUid is status and expiresUid is expiration for the default record. If you have customized these, you will need to update the UID in your config.
Set Statuses to be Flagged
The flagOnStatuses array contains a list of values that will result in a flag being displayed on the radar popup if they're found in the corresponding statusUid field.
Ex: flagOnStatuses = {"STOLEN", "EXPIRED", "PENDING", "SUSPENDED"}
6. Set Your API ID
In order to have locked plate results sent back to your CAD, don't forget to set your account API ID.
Usage
For more information on using the in-game UI, please view the Sonoran version of the Wraith ARS 2X release information. Results are sent directly to your CAD when a license plate is locked.
Sonoran wk_wars2x
These features are not found in the original wk_wars2x resource, and only come packaged with our version found here.
Additional Features
Added the ability to blacklist certain vehicle classes via the config.lua, these blacklisted vehicles will show on the plate reader as the
CONFIG.noPlateValuevalue (default: "NO PLATE").Added the feature
CONFIG.realisticPlateScanning. This feature is disabled by default due to certain vehicles having incorrect metadata causing this feature to displayCONFIG.noPlateValuefalsely. Behavior when enabled: when you are traveling toward/away from a vehicle that does not have a front/back plate the plate reader will not be able to scan it and will display theCONFIG.noPlateValuevalue.
Realistic Plate Scanning
Set CONFIG.realisticPlateScanning to true to enable only scanning vehicles with the ALPR when they have a plate.
Note: Some vehicles may show a plate due to missing vehicle metadata or being able to remove the plate with extras.
Troubleshooting
AI Cars are Spamming the Reader
The framework ships with the wk_wars2x plate reader included. This will have the config.use_sonorancad set to true. When enabled, the plate reader will not run a lookup on any AI vehicle.
Vehicles Aren't Being Flagged
Status
Keep in mind that AI vehicles won't display or be ran unless there's a vehicle registration record added to the CAD with that plate.
Ensure that you've correctly followed step 5 and the statusUid and expirationUid fields have been set correctly, both in the CAD record template and the plugin config.
Ensure that the flagOnStatuses array has the exact string/text values that match the options in your custom record template.
BOLO and Warrant
Ensure that your custom BOLO and Warrant records have a field with the type set to status. Otherwise, there's no way to determine if the BOLO/Warrant is active, closed, etc. The plate reader will warn of any active BOLO or Warrant records with the vehicle plate attached and the status type field set to active/open.
Error: attempt to index a nil value (local 'vehicle')
Some servers will see this error in their server console:
To fix this, navigate to your [sonorancad]/wk_wars2x folder, and rename config.dist.lua to just config.lua
The config not being renamed is the most common cause of this error, however, if for some reason that doesn't fix it, feel free to open a support ticket with us.
Last updated
