⚡ Quick Start

TL;DR: Create .lua file → Write mod → COMPILE → Distribute

📋 Requirements

🔴 MANDATORY Compilation

❌ Raw .lua files → WILL NOT WORK
✅ Compiled mods → WILL WORK

📁 File Structure

• Single .lua source file
• File name = mod name (e.g., regenerative_health.lua)
• Must be compiled before distribution

🧩 Required Code Components

Every mod MUST include:

modName = "Your Mod Name"
modDescription = "What your mod does"

function onEnable()  -- Called when enabled
    return true      -- Return true for success
end
function onDisable() -- Called when disabled
end
function update()    -- Called every game tick
    -- Your mod logic here
end

🔧 Available APIs

👤 Player Functions

📖 Complete Example

Regenerative Health Mod - Heals player up to 50 health when below 50:

-- Mod Information
modName = "Regenerative Health"
modDescription = "Regenerates health up to 50 maximum at 5 health per second whenever below 50%"
-- Settings
local isRegenerating = false
local lastRegenerationTime = 0
local regenerationRate = 5
local maxHealthLimit = 50
local regenerationInterval = 1.0
-- Called when mod is enabled
function onEnable()
    isRegenerating = false
    lastRegenerationTime = os.clock()
    print("Regenerative Health Mod enabled!")
    return true
end
-- Called when mod is disabled
function onDisable()
    isRegenerating = false
    print("Regenerative Health Mod disabled!")
end
-- Called every tick while enabled
function update()
    local currentHealth = natives.safeGetHealth()
    if not currentHealth then return end
    processHealthRegeneration(currentHealth)
end
-- Regeneration logic
function processHealthRegeneration(currentHealth)
    local currentTime = os.clock()
    
    if currentHealth < maxHealthLimit and not isRegenerating then
        isRegenerating = true
        lastRegenerationTime = currentTime
        print("Health regeneration started at " .. currentHealth .. " health")
        
    elseif isRegenerating and currentHealth < maxHealthLimit then
        if currentTime - lastRegenerationTime >= regenerationInterval then
            local newHealth = math.min(currentHealth + regenerationRate, maxHealthLimit)
            natives.safeSetHealth(newHealth)
            lastRegenerationTime = currentTime
            print("Health regenerated: " .. currentHealth .. " -> " .. newHealth)
            
            if newHealth >= maxHealthLimit then
                isRegenerating = false
                print("Health regeneration completed")
            end
        end
        
    elseif isRegenerating and currentHealth >= maxHealthLimit then
        isRegenerating = false
        print("Health regeneration stopped")
    end
end

📦 Installation & Distribution

🔨 For Developers:

1. ✍️ Write your .lua mod
2. 🧪 Test your logic
3. ⚙️ COMPILE using mod compiler tool
4. 📤 Distribute compiled mod

👥 For Users:

1. 📥 Download compiled mod
2. 📂 Place in AssaultCube Mod Manager Mods directory
3. ▶️ Load through mod manager
4. ✅ Enable to use

⚖️ Legal Notice - Source Code Rights

📜 NO REQUIREMENT to release source code
🆓 VOLUNTARY ONLY - your choice
✅ NO VIOLATION keeping source private
🏆 FULL OWNERSHIP of your code
❌ NO OBLIGATION to share anything
👑 CREATOR'S CHOICE always respected

INFORMACIÓN LEGAL CRÍTICA

📜 NO ES OBLIGATORIO liberar código fuente
🆓 SOLO VOLUNTARIO - tu elección
✅ NO ES VIOLACIÓN mantener el código privado
🏆 PROPIEDAD COMPLETA de tu código
❌ NO HAY OBLIGACIÓN de compartir nada
👑 ELECCIÓN DEL CREADOR siempre respetada

Tú controlas tu código fuente completamente. Compartir es opcional, no obligatorio.

КРИТИЧЕСКАЯ ПРАВОВАЯ ИНФОРМАЦИЯ

📜 НЕ ТРЕБУЕТСЯ публиковать исходный код
🆓 ТОЛЬКО ДОБРОВОЛЬНО - ваш выбор
✅ НЕ НАРУШЕНИЕ держать код приватным
🏆 ПОЛНАЯ СОБСТВЕННОСТЬ на ваш код
❌ НЕТ ОБЯЗАТЕЛЬСТВ делиться чем-либо
👑 ВЫБОР СОЗДАТЕЛЯ всегда уважается

Вы полностью контролируете свой исходный код. Делиться необязательно, это ваш выбор.