🌴 FX-GUARMATP

Advanced Guarma teleport system for RedM with NPC interaction, travel system, pricing, and full framework compatibility.

---

📦 INSTALLATION

ensure fx-guarmatp

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

---

⚙️ BASIC CONFIG

Config.Language = "en"

• Defines system language • Used for all notifications and UI

---

🎮 PROMPT SYSTEM

Config.Prompts = {
	["teleport"] = {
	    Label = "Boat Ticket Vendor",
        distance = 3.0,
	    Keys = {
            [1] = {
                Key = 0xC7B5340A,
                Label = "OPEN MENU",
                HoldTime = 500
            },
	    }
	},
}

• Defines interaction prompt • distance → interaction range • Key → interaction key • HoldTime → hold duration

---

👮 ADMIN COMMANDS

Config.AdminCommands = {
    {
        command = "tpguarma",
    },
    {
        command = "exitguarma",
    }
}

• Admin teleport system • tpguarma → teleport player to Guarma • exitguarma → return player • Supports target player ID

---

🌴 GUARMA LOCATIONS

Config.GuarmaLocations = {
    {
        label = "Guarma Port",
        price = { cash = 5, gold = 0 },
        coords = vector4(...),
    }
}

• Defines Guarma teleport points • price → travel cost • coords → spawn location • Supports multiple locations

---

requiredItem = {
    itemName = "ticket",
    itemLabel = "Ticket",
    removeItem = true
}

• Optional item requirement • Removes item on use • Can replace money system

---

🚤 VEHICLE SYSTEM

spawnVehicle = {
    enable = true,
    model = "hotAirBalloon01",
    spawnCoords = vector4(...),
    gotoCoords  = vector4(...)
}

• Spawns vehicle during travel • model → vehicle type • spawnCoords → spawn position • gotoCoords → destination path

---

🌍 CITY LOCATIONS

Config.CityLocations = {
    {
        label = "Blackwater Port",
        price = { cash = 5 },
        coords = vector4(...),
    }
}

• Defines return points from Guarma • Used for teleporting back to mainland • Works same as GuarmaLocations

---

👷 NPC SYSTEM

Config.NpcSetting = {
    ["Blackwater Port"] = {
        ped = true,
        model = "a_m_m_deliverytravelers_cool_01",
        coords = { vector4(...) },
    }
}

• Creates interactive NPCs • Players interact to open teleport menu • Fully customizable

---

Blip = {
    showBlip = true,
    BlipSprite = 2033397166,
}

• Adds map marker for NPC • Helps players find teleport points

---

openTimeSetting = {
    allowed = false,
    open = 8,
    close = 21
}

• Restricts teleport by time • Example → only daytime travel

---

💰 PRICE SYSTEM

price = { cash = 5, gold = 0 }

• Defines teleport cost • Supports both cash and gold • Can be disabled

---

🎒 REQUIRED ITEM SYSTEM

requiredItem = false

• Optional item requirement • If false → no item needed • If enabled → must match inventory item

---

👁️ HUD INTEGRATION

Config.HideHud()
Config.ShowHud()

• Automatically hides HUD during travel • Works with fx-hud • Optional system

---

🔔 NOTIFY SYSTEM

Notify({
  text = "Teleport Started",
  type = "success"
})

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

---

⚠️ IMPORTANT NOTES

• NPC coords must be correct • Vehicle spawn coords must be safe • requiredItem must exist in database • price must match economy system • fx-hud integration is optional

---

🚨 COMMON MISTAKES

• Wrong coordinates • Missing required item • Vehicle spawning under map • NPC not appearing • Incorrect job permissions

---

🏁 SUMMARY

FX-GuarmaTP provides:

• Advanced teleport system • NPC interaction system • Travel vehicle system • Price & item system • Full framework compatibility

---

© Fixitfy Development