Installation

📋 Prerequisites

Before installing InfinityUI, make sure you have:

  • ✅ A FiveM server (txAdmin or standalone)

  • ox_lib resource installed

  • ✅ Access to FiveM Keymaster

  • ✅ Basic knowledge of Lua scripting

1

🛒 Step 1: Buy the product

2

🔐 Step 2: Download from Keymaster

  • Go to https://keymaster.fivem.net

  • Log in with your account

  • Navigate to "Granted Assets"

  • Find InfinityUI in your purchased assets

  • Download the resource

3

📦 Step 3: Installation

Extract the Resource

  1. Extract the downloaded ZIP file

  2. You should see a folder named infinityUI (or similar)

  3. Place this folder in your server's resources directory

Example structure:

your-server/
├── resources/
│   ├── [essential]/
│   ├── [gameplay]/
│   └── infinityUI/          ← Place it here
│       ├── fxmanifest.lua
|       ├── .fxap
│       ├── config.lua
│       └── client/
│           └── ui.lua

Add to server.cfg

Open your server.cfg file and add:

# Dependencies
ensure ox_lib

# InfinityUI
ensure infinityUI
circle-exclamation
4

⚙️ Step 3: Configuration

InfinityUI requires a configuration file. To do it correctly, you have to:

Find the configuration file

  1. Go into the resource infinityUI

  2. Open config.lua

  3. Check the configuration section for informations

  4. Configure it

  5. Save it

5

✅ Step 4: Verify Installation

Test the Resource

  1. Start your server

  2. Check the server console for errors

  3. Join your server

  4. Open F8 console and type:

/infinityui_jump_to

If you see a dialog box, InfinityUI is working! ✅

Check for Errors

Look for these messages in your server console:

Good:

Started resource infinityUI

Bad:

Error loading script client/ui.lua
CONFIG FILE NOT FOUND

If you see errors, check:

  • Is config.lua loaded before ui.lua in fxmanifest?

  • Did you create the InfinityUIConfig table?

  • Is ox_lib installed and started?

  • If you can't find the error yourself, head to the support on the Discord serverarrow-up-right !

6

🔧 Step 5: Integration with Your Framework

ESX Example

-- In your config
InfinityUIConfig.CoreResource = "es_extended"

function InfinityUIConfig.GetPlayerMenuSide()
    local side = exports['es_extended']:getSharedObject().GetPlayerData().menuSide
    return side or "left"
end

QBCore Example

-- In your config
InfinityUIConfig.CoreResource = "qb-core"

function InfinityUIConfig.GetPlayerMenuSide()
    local PlayerData = exports['qb-core']:GetPlayerData()
    return PlayerData.metadata?.menuSide or "left"
end

Standalone (No Framework)

function InfinityUIConfig.GetPlayerMenuSide()
    -- Use a saved preference or default
    return "left" -- or "right"
end
7

🎨 Step 6: Create Your First Menu

Create a test script to verify everything works.

File: test_infinityui.lua

local TestMenu = InfinityUI.CreateMenu("Test Menu", "Testing InfinityUI")

Citizen.CreateThread(function()
    while true do
        Wait(0)
        
        if InfinityUI.IsVisible(TestMenu) then
            InfinityUI.Button("Test Button", "Click me!", {}, true, {
                onSelected = function()
                    print("InfinityUI works! ✅")
                end
            })
            
            InfinityUI.IsVisible(TestMenu)
        end
    end
end)

RegisterCommand("testmenu", function()
    InfinityUI.Visible(TestMenu, true)
end)

Add to your fxmanifest.lua:

client_scripts {
    '@infinityUI/config.lua',
    '@infinityUI/client/ui.lua',
    'test_infinityui.lua'
}

Then in game: /testmenu

🐛 Troubleshooting

chevron-right"CONFIG FILE NOT FOUND"hashtag

Problem: InfinityUI can't find your config.

Solution:

  1. Make sure infinityui_config.lua is loaded BEFORE @infinityUI/client/ui.lua

  2. Check that InfinityUIConfig table is created

  3. Verify file path in fxmanifest.lua

chevron-right"attempt to index a nil value (field 'MappingSettings')"hashtag

Problem: Config loaded but incomplete.

Solution: Add all required fields to your config:

InfinityUIConfig.MappingSettings = {
    Command = "infinityui_jump_to",
    Description = "Menu: Jump to a button"
}
chevron-rightSounds not workinghashtag

Solution:

📚 Next Steps

  1. ✅ Read the Configuration Guide

  2. ✅ Check the API Reference

  3. ✅ Join our Discordarrow-up-right for help

Last updated