Installation Guide

Let's start with the initial installation steps you need to follow to make the script work correctly.

📄 Configuration Guide

This guide covers the configuration options available for the Crime Tablet system. You can customize framework integration, command setup, interaction methods, UI styling, ranks/roles, upgrades, and more.

---

⚙️ Framework & Notification Integration

Config.frameworkType = 'ESX' 
Config.notifyType = 'OX'

• frameworkType: Choose your game framework. Options:

  • 'ESX'

  • 'QBCore'

  • 'QBOX'

  • 'CUSTOM' (requires manual setup in server/functions_editable.lua and client/editable.lua)

• notifyType: Select the type of notification system. Options:

  • 'ESX'

  • 'QBCore'

  • 'OX'

  • 'CUSTOM' (requires manual setup in server/functions_editable.lua and client/editable.lua

---

🧾 Commands Configuration

Config.commandSettings = {
  ['users'] = {
    ['enable'] = true,
    ['command'] = 'tabletCrime',
  },
  ['crimeLeader'] = {
    ['enable'] = true,
    ['command'] = 'crimeLeader',
  }
}

• Define in-game commands for users and leaders.

• Set enable to true or false to toggle command usage.

• You can rename the command strings to your preferred trigger.

---

📦 Item System

Config.itemSettings = {
  ['enable'] = true,
  ['itemName'] = 'tablet_crime',
}

• Enable item-based access to the system.

• Define the item name players will use.

---

🎯 Interaction Settings

Config.interactionType = 'ox_target'
Config.zOffset = 0.9

• Interaction options:

  • 'ox_target'

  • 'qb-target'

  • 'draw3DText'

• Adjust zOffset to change interaction height in 3D space.

---

📁 Inventory System

Config.inventoryType = 'ox_inventory'

• Choose your inventory backend:

  • 'ox_inventory'

  • 'qb-inventory'

  • 'qs-inventory'

  • 'CUSTOM' (requires manual setup in server/functions_editable.lua and client/editable.lua

---

🖼️ UI & Logo

Config.defaultLogo = 'https://cdn3.iconfinder.com/data/icons/people-emoji/50/Devil-512.png'
Config.mainUIColor = 'rgba(255, 80, 219, 1)'

• Customize the default organization logo and main UI color.

---

🔄 Performance & Updates

Config.updateTimeBetweenServerChecks = 1000 * 60 * 1
Config.allowLoadDataWithScriptRestartWithoutRelog = true

• Controls how often server checks occur (in milliseconds).

• allowLoadDataWithScriptRestartWithoutRelog: useful for development/testing (You don't need to use /relog with systems likes a multicharacter).

---

💳 Nearby Withdraw/Stats

Config.enableWithdrawNearbyDeposit = false
Config.enableStatsRanking = false

• Enable stash deposit from nearby locations.

• Enable organization ranking (requires pinkFrog_crimeZones from our Tebex).

---

🛡️ Crime Leader Permissions

Config.crimeLeaderPermission = {
  ['discordRoles'] = false, -- this need to be false
  ['discordIdRole'] = '1332504196393730161',
  ['useStandardFrameWorkGroups'] = true, -- if you use this (upper)
  ['useStandardFrameWorkGroupsList'] = {'admin', 'god'}
}

• Allow discord-based and framework-based group permissions. required resource: discordRoles

• Works with Discord IDs or standard admin groups like admin, god.

---

🎓 Organization Grades

Each grade has specific permissions:

Config.grades = {
  {
    name = "freshman",
    label = "freshman",
    permissions = {
      withdraw = false,
      deposit = false,
      upgrade = false,
      addMember = false,
      removeMember = false,
      gradeSetting = false,
      useStash = false,
      useArmoury = false,
      useWarderobe = true,
    },
    description = "Ability to use wardrobe"
  },
  {
    name = "member",
    ...
  },
  ...
}

Permissions Explained:

• withdraw, deposit: Inventory control.

• upgrade: Organization upgrades.

• addMember, removeMember, gradeSetting: Member management.

• useStash, useArmoury, useWarderobe: Facility access.

---

📈 Default Organization Settings

Config.DefaultSlots = 100
Config.DefaultWeight = 400
Config.DefaultMembers = 10

• DefaultSlots: Inventory slots

• DefaultWeight: Max stash weight

• DefaultMembers: Max initial members

---

⬆️ Upgrades Configuration

Config.upgrades = {
  ['members_limit'] = {
    description = 'Max number of members',
    price = 100000,
    max = 50,
    inputStep = 1,
  },
  ...
}

Upgrade Types:

• members_limit: Increases member cap.

• warehouse_slots: Adds stash/armoury slots.

• warehouse_weight: Increases stash/armoury weight limit.

Each upgrade has:

• description: Shown in UI

• price: Per step

• max: Max allowed value

• inputStep: Step increment

---

🌐 Localization

Config.useLocale = 'en'

• Custom your locales

• Current default: 'en'.

---

👕 Wardrobe Menu

The wardrobe menu is only a visual interface. It does not change your clothes by itself — you must define what happens when a player selects an option.

🔹 Define Your Wardrobe Opening Event

In the following section of client/client_editable.lua:

onSelect = function()
    -- Add your logic to open wardrobe menu here
end

You must provide an event or export / event from your own clothing system that opens the wardrobe UI.

✅ Example:

onSelect = function()
    exports['yourPropertyResourceOrClotheShop']:openWardrobe()
end

---

📌 Since every server uses a different wardrobe system, we could not fully customize this for you. You need to connect this by yourself.

---