#📦 INSTALLATION

bashensure fx-pausemenu

• Place the script inside resources/fx-pausemenu
• Add ensure fx-pausemenu to your server.cfg
• Restart your server

---

#⚙️ BASIC SETTINGS

luaConfig.Language = "en"

• Defines system language
• Used for UI and notifications

---

#🎬 PAUSE ANIMATION SYSTEM

luaConfig.PauseMenuAnimation = {
  Random = true,
  Animations = {
    {scenario = "WORLD_HUMAN_WRITE_NOTEBOOK"}
  }
}

• Plays animation when pause menu is opened
• Random → selects random animation
• Supports scenario and prop-based animations

---

#🎯 ACTION REQUIREMENT SYSTEM

luaConfig.ActionRequirements = {
  map = {
    enabled = true,
    item = "map",
    amount = 1
  }
}

• Requires item to use certain actions
• Example → map requires "map" item
• Can be disabled

---

#📊 LEADERBOARD SYSTEM

luaConfig.LeaderboardLimits = {
  weekly = 10,
  total = 50
}

• Limits leaderboard display
• weekly → weekly top players
• total → all-time players

---

#⏱️ SAVE SYSTEM

luaConfig.SaveInterval = 60

• Saves player playtime periodically
• Value is in seconds
• Prevents data loss

---

#🎁 DAILY REWARD SYSTEM

luaConfig.DailyRewards = {
  [1] = {
    label = "Daily Reward #1",
    requiredTime = 60
  }
}

• Rewards based on playtime
• requiredTime → minutes required
• Includes money and item rewards

---

luaConfig.DailyResetHour = 0

• Resets daily rewards at specific hour
• Example → 0 = midnight

---

luaConfig.DailyResetCmdCommand = "resetdaily"

• Command to reset rewards manually

---

#🏆 WEEKLY REWARD SYSTEM

luaConfig.EnableWeeklyRewards = true
Config.WeeklyResetDay = "monday"
Config.WeeklyResetHour = 20

• Enables weekly rewards
• Rewards top players by playtime
• Automatically distributed

---

luaConfig.WeeklyRewards = {
  [1] = {
    label = "First Player #1"
  }
}

• Defines rewards for top players
• Supports money and items

---

#📈 TOTAL TIME REWARD SYSTEM

luaConfig.TotalTimeRewards = {
  [1] = {
    label = "5 Hours",
    requiredTime = 300
  }
}

• Rewards based on total playtime
• Permanent progression rewards
• Encourages long-term play

---

#🎮 HOTKEY SYSTEM

luaConfig.Hotkeys = {
  ["Z"] = {label = "Ragdoll"},
  ["B"] = {label = "Point Finger"}
}

• Displays keybinds in UI
• Helps new players
• Fully customizable

---

#🎯 HUD CONTROL

luaConfig.HideHud = function()
Config.ShowHud = function()

• Automatically hides HUD when menu opens
• Works with fx-hud
• Optional system

---

#🔔 NOTIFY SYSTEM

luaNotify({
  text = "Reward claimed",
  type = "success"
})

• Framework-based notification system
• Supports VORP / RSG / REDEMRP

---

#🌐 LOCALE SYSTEM

luaConfig.Locale = {
  ["en"] = {
    ["rewardClaimed"] = "You received: ${items}"
  }
}

• Multi-language support
• Fully customizable messages

---

#⚙️ SERVER CONFIG

luaSV_Config.Webhook = {
  url = "YOUR_WEBHOOK",
  logo = "...",
  banner = "...",
  color = 16775871
}

• Discord logging system
• Sends events to webhook
• Optional but recommended

---

#🔧 VORP SETUP

luaself.Joblabel = function(value)

• Required for job label sync
• Updates job label in UI
• Must be replaced in vorp_core

---

#⚠️ IMPORTANT NOTES

• Rewards depend on playtime
• Daily reset must be configured
• Weekly rewards require EnableWeeklyRewards
• HUD integration requires fx-hud
• Locale must match selected language

---

#🚨 COMMON MISTAKES

• Rewards not working → wrong time config
• Leaderboard empty → playtime not saved
• Animation not playing → invalid scenario
• HUD not hiding → fx-hud not running
• Webhook not sending → invalid URL

---

#🏁 SUMMARY

FX-PAUSEMENU provides:

• Advanced pause menu system
• Daily / weekly reward system
• Leaderboard system
• Animation system
• Hotkey UI system
• Full framework compatibility

---

© Fixitfy Development