Lua Starter Template

my-script/
├── fxmanifest.lua       # Resource manifest (required)
├── client/
│   └── main.lua         # Client-side code (runs on player's PC)
├── server/
│   └── main.lua         # Server-side code (runs on server)
├── shared/
│   └── config.lua       # Shared configuration
└── html/                    # NUI files (optional, for UI)
    ├── index.html
    ├── style.css
    └── script.js

fx_version 'cerulean'
game 'gta5'

name 'my-script'
description 'A template FiveM resource'
author 'Your Name'
version '1.0.0'

shared_scripts {
    'shared/*.lua',
}

client_scripts {
    'client/*.lua',
}

server_scripts {
    'server/*.lua',
}

-- Uncomment if using NUI:
-- ui_page 'html/index.html'
-- files { 'html/index.html', 'html/style.css', 'html/script.js' }

-- Client-side code runs on each player's machine
-- Use for: rendering UI, handling input, visual effects, animations

local Config = Config or {}

-- Example: Register a command
RegisterCommand('hello', function()
    -- Show notification to player
    SetNotificationTextEntry('STRING')
    AddTextComponentString('Hello from my first script!')
    DrawNotification(false, false)
end, false)

-- Example: Listen for a server event
RegisterNetEvent('my-script:client:notify', function(message)
    SetNotificationTextEntry('STRING')
    AddTextComponentString(message)
    DrawNotification(false, false)
end)

print('[my-script] Client loaded successfully')

-- Server-side code runs once on the server
-- Use for: database operations, validation, cross-player logic

local Config = Config or {}

-- Example: Server command with player validation
RegisterCommand('announce', function(source, args)
    -- source = 0 means console, otherwise it's a player ID
    if source > 0 then
        -- Check if player has permission
        if not IsPlayerAceAllowed(source, 'command.announce') then
            TriggerClientEvent('my-script:client:notify', source, 'No permission')
            return
        end
    end

    local message = table.concat(args, ' ')
    -- Send to ALL players
    TriggerClientEvent('my-script:client:notify', -1, message)
    print(('[my-script] Announcement: %s'):format(message))
end, false)

print('[my-script] Server loaded successfully')

Config = {}

Config.Debug = false          -- Enable debug prints
Config.CommandPrefix = 'my'   -- Prefix for commands

-- Add your configurable values here
-- These are accessible from both client and server scripts