Civilian Integration
Allows players to fetch ID information from the CAD on demand.
Last updated
Allows players to fetch ID information from the CAD on demand.
Last updated
This submodule utilizes API endpoints that require the plus 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!
This submodule allows players to fetch their character information from the CAD. Basic functionality is provided with the /showid command, but developers are encouraged to use the export for their own creations.
If you haven't already, be sure to install and configure the SonoranCAD Core first.
Follow the submodule activation guide for the civintegration
, and locations
submodules.
Don't forget to set your account API ID to properly link your in-game user to the CAD.
The submodule comes with a few basic commands to show off the functionality.
You can use this export to fetch all characters for a specific player ID. This is a server-side export only.
This function can also be used in other submodules (without the export bit).
Option
Description
Default Value
cacheTime
Time to cache characters in seconds
3600
allowCustomIds
Allow players to use /setid to set a custom name.
true
allowPurge
Allow players to use /refreshid to "purge" their character list from cache.
true
enableIDCardUI
Recommended: Allows for a more realistic identification ui with /showid
IF USING: Please ensure you start the resource sonoran_idcard
BEFORE sonorancad
in your server resource start order
false
Command
Description
/showid [id]
Shows the current ID of the specified player ID. If not specified, will show the current player's ID. Currently, it is displayed only to the calling client.
/setid
Sets a custom ID (first/last name, and date of birth). Overrides the currently selected CAD ID. Can be disabled in configuration.
/resetid
Resets the custom ID specified above.
/refreshid
Removes the "cached" characters for the client. This allows players to swap characters in the CAD without relogging or waiting for the cache timer.