Installation Guide

Installation Guide: ATM Owner System

Follow this guide to install and set up the ATM Owner System on your FiveM server.

---

1️⃣ Install Dependencies

Required Dependencies

The script requires the following dependencies to function properly:

ox_lib

ox_lib is required for:

• Progress bars and notifications

• Text UI components

• Input dialogs

• Context menus

Installation:

1. Download from overextended/ox_lib

2. Place in your resources folder

3. Add to server.cfg: ensure ox_lib

ic3d_lib

ic3d_lib is required for:

• Framework abstraction (QBCore/ESX/Qbox compatibility)

• Player identifier resolution

• Bank/cash operations

Installation:

1. The library is included with the script in the ic3d_lib folder

2. Ensure it's in your resources folder

3. Add to server.cfg: ensure ic3d_lib

oxmysql

oxmysql is required for:

• Database operations

• MySQL connection pooling

Installation:

1. Download from overextended/oxmysql

2. Place in your resources folder

3. Add to server.cfg: ensure oxmysql

4. Configure database connection in oxmysql/resource/oxmysql.sql

---

2️⃣ Database Setup

Import SQL File

1. Open your MySQL database management tool (phpMyAdmin, HeidiSQL, etc.)

2. Select your FiveM database

3. Import the atm.sql file located in the script folder

4. Verify all tables were created:

   • owned_atms

   • atm_transactions

   • atm_employees

   • atm_admin_logs

   • atm_movements

   • atm_permissions

Verify Database Connection

Ensure your oxmysql configuration is correct and the database connection is working.

---

3️⃣ Install the Script

Step 1: Place Script Files

1. Extract the script to your resources folder

2. Ensure the folder structure is:

   resources/
   ├── godv_buyatm/
   │   ├── client/
   │   ├── server/
   │   ├── web/
   │   ├── locales/
   │   ├── config.lua
   │   ├── fxmanifest.lua
   │   └── atm.sql
   └── ic3d_lib/

Step 2: Configure server.cfg

Add the following to your server.cfg:

# Dependencies (add these BEFORE the script)
ensure ox_lib
ensure ic3d_lib
ensure oxmysql

# Script
ensure godv_buyatm

Important: Dependencies must be started before the script!

---

4️⃣ Configure the Script

Basic Configuration

Open config.lua and configure the following:

Config.Locale = "en"  -- Set your language
Config.Debug = false  -- Set to true for debug prints (disable in production)
Config.ProximityRadius = 1.0  -- Detection radius in meters
Config.AutoDetectBankDelta = true  -- Auto-tax transactions near ATMs
Config.MaxATMsPerPlayer = 2  -- Maximum ATMs a player can own (0 = unlimited)

ATM Blip Configuration

Config.ATMBlip = {
    Enabled = true,      -- Show ATM blips on map
    Sprite = 277,        -- Blip sprite ID
    Scale = 0.6,         -- Blip size
    Color = 2,           -- Blip color (green)
    ShortRange = true    -- Only visible when near
}

ATM Manager NPC Configuration

Config.ATMNpc = {
    Enabled = true,
    Model = "cs_bankman",
    Coords = vector3(-1381.12, -499.61, 32.16),
    Heading = 193.62,
    InteractionDistance = 2.0,
    TextUI = "[E] Manage ATMs",
    Blip = {
        Enabled = true,
        Sprite = 480,
        Scale = 0.7,
        Color = 2,
        Label = "ATM Manager"
    }
}

Tax Permission Configuration

Config.RequireOwnerForTax = false  -- Only owner can change tax
Config.AllowTaxChangeByManagers = true  -- Managers can change tax (if RequireOwnerForTax = false)

---

5️⃣ Add ATMs to Database

Method 1: Use /addatm Command (Recommended)

1. In-game, stand at the location where you want to add an ATM

2. Run the command: /addatm

3. Follow the menu prompts:

   • Enter owner identifier (optional, leave blank for unowned)

   • Select location (North, South, Paleto, Sandy Shores)

   • Enter tax percentage (e.g., 10)

   • Enter price (e.g., 10000)

   • Enter rent amount (e.g., 500)

Method 2: Import Scanned ATMs

1. Use the /scanatms_live command to scan for existing ATM props

2. Fly around the map to discover ATMs

3. Run /importatms to import scanned ATMs to database

4. ATMs will be imported with default settings (price: $10,000, tax: 10%)

Method 3: Manual SQL Insert

You can manually insert ATMs via SQL:

INSERT INTO owned_atms (owner, location, coords, price, tax, due_rent, utilization) 
VALUES (NULL, 'North', 'x,y,z', 10000, 10, 500, 'This ATM is available for purchase.');

---

6️⃣ Verify Installation

Check Server Console

After starting the server, check for:

1. ✅ No error messages related to the script

2. ✅ Database connection successful

3. ✅ All dependencies loaded

4. ✅ Script started without errors

Test In-Game

1. Check NPC Spawn: Visit the configured NPC location to verify it spawned

2. Test Command: Run /atms to toggle ATM blips

3. Test Management: Interact with NPC or use /addatm command

4. Check Database: Verify ATMs are being created/loaded correctly

---

7️⃣ Ready to Go! 🚀

Your ATM system is now installed and configured!

Next Steps

• Add ATMs: Use /addatm or import scanned ATMs

• Configure Settings: Adjust tax rates, limits, and permissions in config.lua

• Test Features: Purchase an ATM, hire employees, test tax collection

• Customize UI: Modify web/ files for custom styling (if needed)

Troubleshooting

If you encounter issues, check the Troubleshooting Guide for common solutions.

---

💡 Tip: Enable Config.Debug = true during setup to see detailed logs, but remember to disable it in production for better performance.