Solstice-HouseRobbery

Installation Instructions:

Prerequisites:

• A FiveM server running QBCore or ESX framework.

• One of the target interaction scripts: qb-target or ox_target.

• Minigame resources: t3_lockpick, mbt_minigames, or your preferred alternatives.

Step-by-Step Guide:

1. Download the Script:

   • Obtain the script package and extract it to a temporary location on your computer.

2. Add the Script to Your Server:

   • Place the extracted script folder into your server's resources directory.

3. Configure the Script:

   • Open the config.lua file located inside the script folder.

   • Framework Configuration:

     • Set Config.Framework to 'QBCore' or 'ESX' depending on your server.

   • Target Script Configuration:

     • Set Config.TargetScript to 'qb-target' or 'ox_target'.

   • Adjust Houses:

     • Define the houses available for robbery under Config.Houses.

     • Specify entry coordinates, interior shells, loot positions, occupant spawn positions, and other settings.

   • Set Up Loot Tables:

     • Customize the loot for each security level in Config.LootTable.

   • Minigame Settings:

     • Configure minigame options under Config.Minigames.

     • Ensure the minigames are properly installed and adjust settings like difficulty and time limits.

   • Police Settings:

     • Adjust Config.RequiredCops to set the minimum number of police online required to rob a house.

     • Configure dispatch settings to integrate with your server's dispatch system.

   • XP and Progression:

     • Modify Config.XP settings to balance the progression system as desired.

4. Database Setup:

   • For QBCore:

     • Ensure your players table has a robbery_xp column.

     • If not, add it using:

       ALTER TABLE players ADD COLUMN robbery_xp INT DEFAULT 0;

   • For ESX:

     • Ensure your users table has a robbery_xp column.

     • If not, add it using:

       ALTER TABLE users ADD COLUMN robbery_xp INT DEFAULT 0;

5. Install Dependencies:

   • Target Scripts:

     • Install qb-target or ox_target based on your configuration.

   • Minigame Resources:

     • Install t3_lockpick and mbt_minigames or replace them with your preferred minigame scripts.

     • Adjust the export calls in config.lua and cl_open.lua if using different minigames.

   • Dispatch System:

     • Ensure your dispatch system can handle the event cas-sendDispatch.

     • Adjust the dispatch event and data in cl_open.lua if using a different dispatch script.

6. Add the Script to Your Server Configuration:

   • Open your server's server.cfg file.

   • Add the following line to ensure the script starts when the server launches:

     ensure house-robbery

7. Restart Your Server:

   • Start or restart your server to apply the changes.

8. Test the Script:

   • Join your server and test the house robbery features.

   • Ensure that interactions, minigames, loot collection, and dispatch alerts function correctly.

   • Verify that player XP is tracking and updating as expected.

---

Customization and Advanced Configuration:

• Adding More Houses:

  • Use the provided template in config.lua to add more houses with unique settings.

• Adjusting Occupant Behavior:

  • Modify occupant and guard models, weapons, and combat behaviors in client.lua.

• Integrating Custom Minigames:

  • Replace the minigame exports with those from your preferred minigame scripts.

  • Ensure the success/failure callbacks are appropriately handled.

• Dispatch System Integration:

  • Update the dispatch event in cl_open.lua to match your dispatch resource.

  • Customize the dispatch information, blip settings, and messages.

---

Support and Assistance:

If you encounter any issues during installation or have questions about customizing the script, please don't hesitate to reach out. We're committed to ensuring you have a smooth experience integrating this exciting new gameplay element into your server.