Locale integration

README.md

@@ -31,4 +31,8 @@ It is highly recommended to alter the scripts creating the calls/dispatch events
 ```bash
 # Set the default/fallback time (in seconds) for dispatch messages
 setr lb-tablet-dispatch:default-time 100
+
+# Set the default locale for the various translations
+# Current locales: en
+setr lb-tablet-dispatch:locale en
 ```

locales/en.json

@@ -0,0 +1,10 @@
+{
+    "DEFAULT": {
+        "TITLE": "Dispatch Notification",
+        "LOCATION_LABEL": "Call Origin"
+    },
+    "RCORE": {
+        "SHOP_ROBBERY": "Shop Robbery",
+        "CAR_ROBBERY": "Car theft"
+    }
+}

server/ps-dispatch.lua

@@ -10,10 +10,10 @@ RegisterNetEvent('ps-dispatch:server:notify', function (data)
     exports["lb-tablet"]:AddDispatch({
         priority = priority,
         code = data?.code or '',
-        title = data?.codename or 'Dispatch Notification',
+        title = data?.codename or T("DEFAULT.TITLE"),
         description = data.message or '',
         location = {
-          label = data?.codename or "Call Origin",
+          label = data?.codename or T("DEFAULT.LOCATION_LABEL"),
           coords = vector2(data?.coords.x or 0, data?.coords.y or 0)
         },
         time = CONFIG['default-time'],

server/qs-dispatch.lua

@@ -8,10 +8,10 @@ RegisterNetEvent('qs-dispatch:server:CreateDispatchCall', function (data)
     exports["lb-tablet"]:AddDispatch({
         priority = priority,
         code = data?.callCode.code or '',
-        title = data?.callCode.snippet or 'Dispatch Notification',
+        title = data?.callCode.snippet or T("DEFAULT.TITLE"),
         description = data.message or '',
         location = {
-          label = data?.callCode.snippet or "Call Origin",
+          label = data?.callCode.snippet or T("DEFAULT.LOCATION_LABEL"),
           coords = vector2(data?.callLocation.x or 0, data?.callLocation.y or 0)
         },
         time = data?.blip.time and math.floor(data.blip.time / 1000) or CONFIG['default-time'],

server/rcore-dispatch.lua

@@ -1,18 +1,18 @@
 RegisterNetEvent('rcore_dispatch:server:sendAlert', function(data)
     local callTitles = {
-        default      = "Dispatch Notification",
-        shop_robbery = "Shop Robbery",
-        car_robbery  = "Car Robbery",
+        default      = "DEFAULT.TITLE",
+        shop_robbery = "RCORE.SHOP_ROBBERY",
+        car_robbery  = "RCORE.CAR_ROBBERY",
     }
     local type = callTitles[data?.type or "default"] or callTitles.default
 
     exports["lb-tablet"]:AddDispatch({
         priority = data.default_priority,
         code = data?.code or '',
-        title = type,
+        title = T(type),
         description = data.text or '',
         location = {
-            label = data?.blip.text or "Call Origin",
+            label = data?.blip.text or T('DEFAULT.LOCATION_LABEL'),
             coords = vector2(data?.coords.x or 0, data?.coords.y or 0)
         },
         time = CONFIG['default-time'],

utils/convars.lua

@@ -1,3 +1,4 @@
 CONFIG = {
     ['default-time'] = GetConvarInt('lb-tablet-dispatch:default-time', 100),
+    ['locale'] = GetConvar('lb-tablet-dispatch:locale', 'en')
 }

utils/localeHandler.lua

@@ -0,0 +1,35 @@
+local locale = {}
+
+local localeKey = CONFIG['locale']
+
+local rawContent = LoadResourceFile(GetCurrentResourceName(), ('locales/%s.json'):format(localeKey))
+
+if not rawContent then
+    lib.print.warn(('Unable to load %s locale as it doesn\'t exist in @%s/locales/'):format(localeKey, GetCurrentResourceName()))
+    lib.print.warn('Falling back to english locale.')
+    rawContent = LoadResourceFile(GetCurrentResourceName(), 'locales/en.json')
+end
+
+locale = json.decode(rawContent)[IsDuplicityVersion() and 'SERVER' or 'CLIENT']
+
+function T(key, args)
+    local keys = {}
+    for str in string.gmatch(key, "([^%.]+)") do
+        keys[#keys+1] = str
+    end
+
+    local localizedString = locale
+    for _, keyPart in ipairs(keys) do
+        localizedString = localizedString[keyPart]
+        if localizedString == nil then
+            return key
+        end
+    end
+
+    local formatedString = localizedString:gsub("%b{}", function(match)
+        local key = match:sub(2, -2)
+        return args[key] or ""
+    end)
+
+    return formatedString
+end