💿Installation

📥 Installation Guide

Get SceneKits running on your server in under 5 minutes. Follow these simple steps:

---

📋 Prerequisites

Before installing SceneKits, ensure you have:

✅ FiveM Server (Artifact 5181 or higher recommended) ✅ ox_lib (latest version) - Download here ✅ Framework: Standalone (Custom) , ESX (es_extended), QBCore (qb-core), or QBox (qbx_core)

---

🔽 Step 1: Download SceneKits

1. Go to the Cfx.re Tebex Portal

2. Navigate to your purchases

3. Download 0bug_SceneKits

4. Extract the ZIP file

---

📁 Step 2: Install the Resource

1. Copy the 0bug_SceneKits folder

2. Paste it into your server's resources directory

---

⚙️ Step 3: Configure server.cfg

Add SceneKits to your server.cfg file. Order is critical!

✅ Correct Load Order:

# 1. Load ox_lib first
ensure ox_lib

# 2. Load your framework
ensure es_extended        # If using ESX
# OR
ensure qb-core           # If using QBCore
# OR
ensure qbx_core          # If using QBox

# 3. Load SceneKits AFTER framework
ensure 0bug_SceneKits

❌ Common Mistakes to Avoid:

# WRONG - SceneKits before ox_lib
ensure 0bug_SceneKits
ensure ox_lib

# WRONG - SceneKits before framework
ensure 0bug_SceneKits
ensure qb-core

# RIGHT - Correct order
ensure ox_lib
ensure qb-core
ensure 0bug_SceneKits

---

🔄 Step 4: Restart Your Server

1. Stop your FiveM server

2. Start your server

3. Check console for successful load:

[0bug_SceneKits] Resource started successfully
[0bug_SceneKits] Framework detected: ESX/QBCore/QBox

---

✅ Step 5: Verify Installation

1. Join your server

2. Type /sk_spawnin chat (or your configured command)

3. The SceneKits menu should open

If the menu doesn't open, check the Troubleshooting section below.

---

🔐 Step 6: Configure Admin Permissions (Optional)

If you want certain players to access admin tools (purge scenes, view all scenes, etc.), add this to your server.cfg:

# Grant admin group access to SceneKits admin commands
add_ace group.admin scenekits.admin allow

# Add specific players to admin group
add_principal identifier.license:YOUR_LICENSE_HERE group.admin

Finding your license identifier:

You can get your license either from txadmin ids or database.

Example configuration:

Note: This step is optional. Regular players can still use SceneKits without admin permissions—they just won't see admin tools in the menu.

---

🎨 Step 7: Customize (Optional)

Configure SceneKits to match your server's needs:

Check Our Configuration Page for Details

---

🛠️ Troubleshooting

❌ Menu doesn't open

Check:

1. Is ox_lib installed and started?

2. Is SceneKits started after ox_lib and your framework?

3. Check F8 console for errors

4. Verify resource name is exactly 0bug_SceneKits

Solution:

# Verify this exact order:
ensure ox_lib
ensure qb-core  # or es_extended / qbx_core
ensure 0bug_SceneKits

---

❌ "Framework not detected" error

Cause: SceneKits loaded before your framework.

Solution: Check server.cfg load order:

# Framework MUST be before SceneKits
ensure qb-core
ensure 0bug_SceneKits

---

❌ Permission errors

Check:

1. Job names match your framework (e.g., police vs leo)

2. Admin groups configured correctly in config

Solution: Edit config/kits.lua and match job names:

allow = 'police'
-- Verify your framework's job names
 permissions = {
    police = { 'police', 'sheriff', 'state' },
    ems    = { 'ambulance', 'ems' },
    mech   = { 'mechanic', 'tow' },
    public = false,
  },

---

🆘 Still Having Issues?

1. Check Console: Look for red errors in server/client console

2. F8 Console: Open in-game and check for JavaScript errors

3. Discord Support: Join our Discord and open a support ticket

4. Logs: Share your server console logs for faster help

---

📊 Installation Checklist

Use this checklist to ensure proper installation:

• ox_lib installed and working

• Framework (ESX/QBCore/QBox) installed

• 0bug_SceneKits downloaded from Cfx portal

• Resource placed in resources/ folder

• server.cfg configured with correct load order

• Server restarted

• Menu opens in-game with /sk_spawn

• Test scene spawned successfully

• Admin tools accessible (if applicable)

---

🎓 Next Steps

Now that SceneKits is installed, learn how to use it:

• 📖 Configuration Guide - Customize scene kits and settings

• 💬 Commands Reference - Learn all available commands

• 🛡️ Admin Tools - Master scene management

• 🎨 Creating Custom Kits - Build your own scenes

---

🔄 Updating SceneKits

When a new version is released:

1. Backup your config/ folder

2. Download the new version from Cfx portal

3. Replace old files with new ones

4. Restore your custom configurations

5. Restart server

Note: Always read the changelog for breaking changes!

---

Installation complete! 🎉 Ready to create amazing roleplay scenes.

← Back to Home | Next: Configuration →