Config Settings

⚙️ Config Settings

The shared/config.lua file is the heart of FRKN Weapon Skin. It is designed to be highly intuitive, allowing you to modify almost every aspect of the script without needing to touch the core code.

Below is a detailed breakdown of the main configuration categories.

---

🌐 Core Settings & UI

Control the basic behavior of the script, including framework detection and user interface positioning.

• FRKN.Framework: The script detects your framework automatically ('auto'). You can force it to 'qb', 'qbx', or 'esx' if needed.

• FRKN.Locale: Set the language for all notifications and UI text (e.g., 'en', 'tr').

• FRKN.UI.Position: Choose whether the 3D editor menu appears on the 'right' or 'left' side of the screen.

• FRKN.UI.HideHUD: When set to true, the script automatically hides the server minimap and HUD (hunger, thirst) to provide a clean, cinematic view while customizing weapons.

---

👮 Access Control & Permissions

You have complete control over who can access the weapon skin editor.

• Command Access (FRKN.Command): Toggle whether players can open the menu anywhere using a chat command (e.g., /weaponskin).

• Job System (FRKN.JobSystem): Restrict the customization menu to specific in-game jobs.

  FRKN.JobSystem = {
      Enabled = false,
      Jobs = { "police", "ambulance" }, -- Only these jobs can open the editor
  }

• Permission / VIP System (FRKN.DonateSystem): Lock the editor behind a whitelist. If enabled, an admin must grant permission to a player in-game using /giveskinmenu [ID].

---

💰 Economy & Content Pricing

You can integrate the editor with your server's economy or make everything completely free.

• Money System (FRKN.Money): Set Enabled = true to charge players. You can deduct money from their 'cash' or 'bank' accounts.

• Color Pricing: Set a flat rate for applying custom base colors (ColorPrice = 100).

• Skin & Sticker Pricing: Every single skin, font, and sticker has its own individual price in the config. You can make basic skins cheap, and animated/legendary skins very expensive!

  -- Example Skin Configuration
  { name = 'dragon_lore', label = 'Golden Saga', category = 'legendary', rarity = 'legendary', price = 5000 },

---

💰 Economy & Content Pricing

You can integrate the editor with your server's economy, use item-based payments, or make everything completely free.

• Money System (FRKN.Money): Set Enabled = true to charge players. You can deduct money from their 'cash' or 'bank' accounts.

• Item Payment (FRKN.Money.ItemPayment): Set ItemPayment = true to require a specific item alongside or instead of money to apply a skin/sticker.

• Color Pricing: Set a flat rate for applying custom base colors (ColorPrice = 100).

• Skin & Sticker Pricing: Every single skin, font, and sticker has its own individual price and required item in the config. You can mix and match—charge only money, only items, or both!

-- Example Skin Configuration
{ name = 'dragon_lore', label = 'Golden Saga', category = 'legendary', rarity = 'legendary', price = 5000, item = 'skin_ticket', itemAmount = 1 },

📍 Immersive World Interactions (NPC & Zones)

If you don't want players using a chat command, you can create a physical shop in the world.

1. NPC Shop (FRKN.NPC) Spawns a custom ped with a floating weapon prop. Players walk up to the NPC to modify their weapons.

• Customize the Model, Coords, and the specific Heading the NPC faces.

• Includes camera offset settings (CamDistance, CamFov) so the cinematic view is perfect for the location.

2. Target System (FRKN.Target) Enable interaction via the popular third-eye targeting scripts (ox_target or qb-target).

FRKN.Target = {
    Enabled = true,
    System = 'ox',             -- Choose 'ox' or 'qb'
    Label = 'Weapon Skin Editor',
    Icon = 'fas fa-spray-can',
}

Marker / 3D Text Alternative (FRKN.Marker) If you prefer not to use an NPC or Target system, you can enable a classic floating 3D marker (like a floating cone) and a [E] to open prompt.

---

🗺️ Map Blips

Easily configure the map blip for your weapon shop so players can find it.

FRKN.Blip = {
    Enabled = true,
    Sprite = 110,               -- Blip Icon ID
    Color = 2,                  -- Blip Color
    Scale = 0.7,
    Label = 'Weapon Skin Shop', -- Text shown on the map
}