🛠️Setup

This is a detailed setup guide for Ultimate License System. If you have any questions before making a purchase, you can contact us on Discord

Setting Up the Script

1. First things first: if you want to change the language, you can do so by modifying the language.lua file and directly editing the HTML file. This allows you to translate the entire script into your preferred language.

2. Specify your server type here. For QB, ESX (QBbox users, write QB).

   
3. To configure the ID card settings, you can start by adjusting the animation for how the ID is displayed. You also have the option to set the ID to automatically disappear after a certain amount of time or allow users to press the "E" key to manually hide the license. Additionally, you can enable metadata-based ID cards, which assign unique IDs containing information about the person who owns them. This feature ensures that if someone steals another person's ID, the information displayed will still belong to the original owner. Please note that your inventory system must support metadata for this feature to work. If it doesn't, you should disable this option by setting it to false.

   
4. You can choose from three profile picture modes: Studio, Auto, and None. Each mode is detailed within the config, allowing you to select the one that best suits your needs. If you opt for Studio mode (which requires metadata to be enabled), you can further configure it to support a greenscreen mode for background-free images.

   
5. This script can be used with both the target system (qb-target, ox_target) and text UI (ox_lib)

   
6. Configure access to the License Creator, which is used to create live in-game licenses, you can set up the command name using the 'creatorCommand' parameter. Additionally, you can restrict access to this command by specifying criteria such as Discord user ID, Steam ID, FiveM ID, Ace permissions, or specific jobs, ensuring that only authorized users can create licenses.

   
7. License Checker settings allow you to configure the command used for checking and verifying issued licenses, similar to the License Creator. You can restrict access to this command by specifying identifiers such as Discord user ID, Steam ID, FiveM ID, Ace permissions, or specific jobs. This setting is particularly useful for allowing emergency units to verify the licenses of players in-game.

   
8. In the Fake/Forge ID Creator settings, you can enable or disable the system as needed. You can specify the item name using the 'itemName' parameter for the fake or forged ID and even add multiple locations where this menu can be accessed. If you prefer not to use it in this way, you can configure it to suit your needs by using the events provided in the Events and Exports section below. This flexibility allows you to tailor the system to your specific requirements.

   
9. In this section, you can configure the License Collection menu, where players can collect their issued licenses. You can add multiple locations for this menu, as shown in the configuration. Additionally, you can specify which types of licenses will be displayed for collection in the menu, such as Public ID, Job ID, or Worker ID. This allows you to customize the menu to display only the relevant licenses for players at certain locations.

   
10. In this section, you can configure the Job Management panel. You can create multiple management panels as needed, as shown in the configuration. Specify the minimum job rank required to access each management panel and add the same panel to various locations if necessary. Additionally, you can enable job badges for specific jobs and customize them by changing the logo, theme colour custom backgrounds, price, and item name of the job badge. These job panels are essential for allowing certain jobs to issue specific public licenses that were created using the License Creator in-game.

    
11. In this section, you can add Worker IDs by specifying the job name, item name, title, logo, theme colour, and price. You can add an unlimited number of Worker IDs, similar to job badges and public licenses. Worker IDs are required for certain jobs and do not require management to issue or revoke them.

    

Note: Remember to put all license items on your server after creating them. For example, the Job Badges Item from the config and the License Inventory Item from the Creator UI. These items must be on your server for you to be able to use them

Creator UI Example: You must create Item name in your server

Events and Exports (Only for Dev Purpose)

Client Side

1. Creator Panel

   TriggerEvent('cs:identity:creatorUI')

2. Job Management Panel

   TriggerEvent('cs:identity:managerUI', job_name)

3. License Collection Menu (Enable/Disable types as required)

   TriggerEvent('cs:identity:cardMenu', {PublicID=true,JobID=true,WorkerID=true})

4. Fake/Forge ID Menu

   TriggerEvent('cs:identity:fakeCreator')

5. License Checker Menu

   TriggerEvent('cs:identity:idCheck')

6. Check whether a player has a certain license issued

   exports['cs_license']:CheckID(license_item_name) --For job badges, use the job name

Server Side

1. Check whether a player has a certain license issued (server side):

   exports['cs_license']:CheckID(Player_ID, license_item_name) --For job badges, use the job name

2. Give Iicense Item (Public and Job) *If a license type is issued based and the player does not have that license, this export will not function. Instead, use the RegisterCard export for such cases

   exports['cs_license']:GiveCard(Player_ID, license_item_name) --For job badges, use the job name

3. Issue license (Public and Job)

   exports['cs_license']:RegisterCard(Player_ID, license_item_name, expireDays, addItem)
   
   -- Player_ID = Server ID of Player
   -- license_item_name = License item name but For job badges, use the job name
   -- expireDays = [OPTIONAL] Expire License Days put false if you don't want the license to expire
   -- addItem = [OPTIONAL] If you want to give that license as an item to the player

4. Revoke issued license

   exports['cs_license']:RevokeCard(Player_ID, license_item_name) --For job badges, use the job name

5. Give Worker ID Item

   exports['cs_license']:GiveWorkerCard(Player_ID, worker_job_name)

6. Fetch Player's Profile Picture *Note: This will not work if the profile mode is set to 'None' in config

   exports['cs_license']:fetchPic(Player_ID)

7. Fetch all issued licenses from a player

   exports['cs_license']:GetPlayerLicenses(identifier) --Player Identifier
   
   --return Example: {{license = "id_card", isPublic = true, expireDate = "November 30, 2024", issueDate = "November 5, 2024", heading = "Some Heading"}}

8. Fetch all available to manage licenses from a job

   exports['cs_license']:GetAllowedLicense(job) --Job
   
   --return Example: {{name = "Driver License", license = "driver_license"}}