Quick Start Guide

Let's create some useful scripts to get you started with Kinetic Lua scripting.

Script 1: Player Counter

Display the number of players in the game.

File: scripts/autoload/player_counter.lua

script_info = {
    name = "Player Counter",
    author = "Kinetic",
    version = "1.0.0",
    description = "Shows player count on screen"
}

kinetic.on_frame = function(delta_time)
    -- Get all players
    local players = kinetic.players.get_all()
    local count = #players
    
    -- Draw on screen
    kinetic.draw.text({10, 10}, {255, 255, 255}, "Players: " .. count)
end

print("Player Counter loaded!")

Script 2: Health Monitor

Track your health and show a warning when low.

File: scripts/autoload/health_monitor.lua

script_info = {
    name = "Health Monitor",
    author = "Kinetic",
    version = "1.0.0"
}

local low_health_threshold = 30
local warned = false

kinetic.on_frame = function(delta_time)
    local local_player = kinetic.players.get_local()
    
    if local_player then
        local health = local_player.health
        local max_health = local_player.max_health
        local health_percent = (health / max_health) * 100
        
        -- Draw health bar
        local bar_width = 200
        local bar_height = 20
        local fill_width = (health / max_health) * bar_width
        
        -- Background
        kinetic.draw.filled_box({10, 40}, {10 + bar_width, 40 + bar_height}, {50, 50, 50})
        
        -- Health fill (green to red based on health)
        local r = math.floor(255 * (1 - health_percent / 100))
        local g = math.floor(255 * (health_percent / 100))
        kinetic.draw.filled_box({10, 40}, {10 + fill_width, 40 + bar_height}, {r, g, 0})
        
        -- Border
        kinetic.draw.box({10, 40}, {10 + bar_width, 40 + bar_height}, {255, 255, 255})
        
        -- Text
        kinetic.draw.text({15, 45}, {255, 255, 255}, 
            string.format("Health: %.0f/%.0f", health, max_health))
        
        -- Low health warning
        if health_percent < low_health_threshold and not warned then
            kinetic.notify("Warning", "Low Health!", 2.0)
            warned = true
        elseif health_percent >= low_health_threshold then
            warned = false
        end
    end
end

Script 3: Closest Player Tracker

Show information about the closest player.

File: scripts/autoload/closest_tracker.lua

script_info = {
    name = "Closest Player Tracker",
    author = "Kinetic",
    version = "1.0.0"
}

kinetic.on_frame = function(delta_time)
    local closest = kinetic.players.get_closest()
    
    if closest then
        local y = 70
        
        -- Title
        kinetic.draw.text({10, y}, {255, 255, 0}, "Closest Player:")
        y = y + 20
        
        -- Name
        kinetic.draw.text({10, y}, {255, 255, 255}, "Name: " .. closest.name)
        y = y + 15
        
        -- Distance
        kinetic.draw.text({10, y}, {255, 255, 255}, 
            string.format("Distance: %.1f studs", closest.distance))
        y = y + 15
        
        -- Health
        kinetic.draw.text({10, y}, {255, 255, 255}, 
            string.format("Health: %.0f/%.0f", closest.health, closest.max_health))
        y = y + 15
        
        -- Health bar
        local health_percent = closest.health / closest.max_health
        kinetic.draw.progress_bar(
            {10, y}, 150, 15, health_percent,
            {50, 50, 50}, {0, 255, 0}
        )
    end
end

Script 4: Custom ESP Toggle

Toggle ESP with a custom key.

File: scripts/autoload/esp_toggle.lua

script_info = {
    name = "ESP Toggle",
    author = "Kinetic",
    version = "1.0.0"
}

local toggle_key = 0x45  -- E key
local was_pressed = false

kinetic.on_frame = function(delta_time)
    local is_pressed = kinetic.input.is_key_down(toggle_key)
    
    -- Detect key press (not hold)
    if is_pressed and not was_pressed then
        -- Toggle ESP
        local current = kinetic.esp.get_enabled()
        kinetic.esp.set_enabled(not current)
        
        -- Notify
        if current then
            kinetic.notify("ESP", "Disabled", 1.0)
        else
            kinetic.notify("ESP", "Enabled", 1.0)
        end
    end
    
    was_pressed = is_pressed
end

Script 5: FPS Display

Show FPS with color coding.

File: scripts/autoload/fps_display.lua

script_info = {
    name = "FPS Display",
    author = "Kinetic",
    version = "1.0.0"
}

kinetic.on_frame = function(delta_time)
    local fps = kinetic.fps()
    
    -- Color based on FPS
    local color
    if fps >= 60 then
        color = {0, 255, 0}  -- Green
    elseif fps >= 30 then
        color = {255, 255, 0}  -- Yellow
    else
        color = {255, 0, 0}  -- Red
    end
    
    -- Draw FPS
    kinetic.draw.text({10, 150}, color, string.format("FPS: %.0f", fps))
end

Script 6: Target Arrow

Draw an arrow pointing to the aimbot target.

File: scripts/autoload/target_arrow.lua

script_info = {
    name = "Target Arrow",
    author = "Kinetic",
    version = "1.0.0"
}

kinetic.on_frame = function(delta_time)
    local target = kinetic.target.get_current()
    
    if target and target.position then
        -- Get screen position
        local screen_pos = kinetic.camera.world_to_screen(
            target.position.x,
            target.position.y,
            target.position.z
        )
        
        if screen_pos and screen_pos.visible then
            -- Draw arrow pointing to target
            local center_x = kinetic.camera.get_screen_size().width / 2
            local center_y = kinetic.camera.get_screen_size().height / 2
            
            -- Draw line from center to target
            kinetic.draw.thick_line(
                {center_x, center_y},
                {screen_pos.x, screen_pos.y},
                {255, 0, 0},
                2.0
            )
            
            -- Draw circle at target
            kinetic.draw.circle({screen_pos.x, screen_pos.y}, {255, 0, 0}, 10)
        end
    end
end

Testing Your Scripts

1. Save the script file

2. Restart Kinetic (or reload the script)

3. Join a Roblox game

4. Check if the script is working

5. Debug using print() statements

Common Issues

Script Not Loading

• Check file is in correct folder

• Verify Lua syntax (no errors)

• Check console for error messages

Script Not Working

• Add print() statements to debug

• Check if API calls return valid data

• Verify you're in a game with players

Performance Issues

• Reduce draw calls in on_frame

• Cache values instead of recalculating

• Use player cache instead of direct reads

Next Steps

• Script Structure - Organize your code better

• Callbacks - Learn about all available callbacks

• API Reference - Explore all functions

• Examples - More example scripts