🦑Kivo Inventory

Kivo Inventory - Installation Guide

Overview

Kivo Inventory is a redesigned inventory system for FiveM servers, built on ox_inventory version 2.44.1. This system includes two main components:

• kivo-inv-bridge: Bridge script for multi-framework support with balance system

• ox_inventory: Redesigned inventory UI and functionality

Installation Steps

1. Start the Bridge Script First

IMPORTANT: The kivo-inv-bridge resource must be started before the ox_inventory resource to ensure proper framework detection and balance system initialization.

Add the following to your server.cfg in this exact order:

ensure kivo-inv-bridge
ensure ox_inventory

2. Configuration

Bridge Configuration

The bridge script can be configured via kivo-inv-bridge/shared/config.lua. Available settings include:

• Avatar Settings: Configure Discord and Steam avatar fetching

  • DiscordBotToken: Discord bot token for fetching Discord avatars

  • SteamApiKey: Steam Web API key for fetching Steam avatars

  • Priority: Avatar fetch priority ('discord' or 'steam')

  • CacheDuration: Avatar cache duration in seconds (0 = cache forever until disconnect)

• Debug Settings: Enable debug logging for troubleshooting

  • Enabled: Enable/disable debug prints

  • LogAvatar: Enable/disable avatar fetching logs

Ox_Inventory Configuration

You can modify the ox_inventory configurations as needed:

• Edit files in ox_inventory/data/ for item definitions and other data

• Modify ox_inventory/locales/ for language customization

• Configure modules in ox_inventory/modules/ as per your framework needs

3. Custom Version Integration

1. Drag and drop the entire web/build/ folder into your custom version of ox_inventory, replacing the existing build folder.

2. Ensure your custom ox_inventory's fxmanifest.lua includes the build files:

   ui_page 'web/build/index.html'
   
   files {
       'web/build/index.html',
       'web/build/**/*',
       'web/images/*.png',
   }

4. Dependencies

Make sure you have the following dependencies installed and started before kivo-inventory:

• oxmysql - Database resource

• ox_lib - Overextended library

• FiveM Server artifact 6116 or higher

• OneSync enabled

Features

Bridge System

• Multi-framework support with automatic detection

• Player balance system integration

• Avatar fetching from Discord and Steam

• Server key generation and validation

Inventory System

• Custom redesigned UI

• Based on ox_inventory 2.44.1

• Enhanced user experience

• Item images and icons included

Troubleshooting

Common Issues

1. Inventory not working

   • Ensure kivo-inv-bridge is started before ox_inventory

   • Check that all dependencies are installed and running

   • Verify server artifact is 6116 or higher

2. Avatar not loading

   • Verify Discord bot token or Steam API key is configured correctly

   • Check debug logs by enabling Config.Debug.LogAvatar = true

   • Ensure the bot has proper permissions in your Discord server

3. Custom build not working

   • Make sure you copied the entire web/build/ folder

   • Verify fxmanifest.lua points to the correct build paths

   • Clear your FiveM cache and restart the server

File Structure

kivo-inventory/
├── kivo-inv-bridge/          # Bridge script (start first)
│   ├── client/               # Client-side scripts
│   ├── server/               # Server-side scripts
│   ├── shared/               # Shared configuration and framework detection
│   └── fxmanifest.lua        # Resource manifest
│
├── ox_inventory/             # Main inventory system
│   ├── client.lua            # Client initialization
│   ├── server.lua            # Server initialization
│   ├── data/                 # Item definitions and data
│   ├── locales/              # Language files
│   ├── modules/              # Framework modules
│   ├── web/                  # UI source code
│   │   ├── src/              # React source files
│   │   ├── build/            # Compiled UI (after npm run build)
│   │   └── package.json      # Node dependencies
│   └── fxmanifest.lua        # Resource manifest
│
└── doc.md                    # This documentation file

Support

For issues, feature requests, or questions join our discord.

Credits

• ox_inventory: Original inventory system by Overextended

• Dev: Roroleroh, Royaly

• Version: Based on ox_inventory 2.44.1