Skip to content

Installation

This page walks through a complete install. It takes a few minutes and needs no database changes.

Check that your server has:

  • ESX (es_extended), QBCore (qb-core) or QBX (qbx_core) already running.
  • PolyZone installed.
  • ox_target or qb-target installed.
  • A boxing ring in your map at the coordinates you plan to use. The default coordinates are listed in Configuration.
  1. Copy the script folder into your server resources folder. This guide calls it kivo-boxing. Any folder name works as long as server.cfg uses the same name.

    resources/
    [kivo]/
    kivo-boxing/
    Config.lua
    fxmanifest.lua
    client/
    server/
    ui/
  2. Make sure PolyZone is in your resources and its folder is named exactly PolyZone (capital P and Z). The script loads PolyZone files by that folder name, and Linux servers care about capital letters.

  3. Add the resources to server.cfg in this order:

    ensure PolyZone
    # Your framework: keep only the one you use
    ensure es_extended
    # ensure qb-core
    # ensure qbx_core
    # Your target resource: keep only the one you use
    ensure ox_target
    # ensure qb-target
    # Optional, used for notifications when present
    ensure ox_lib
    ensure kivo-boxing

    If you start whole folders such as ensure [qb], keep kivo-boxing below them.

  4. Open Config.lua and set debug mode to false for a live server:

    Config.Debug = false

    While Config.Debug is true, signing up starts a fight against an AI opponent immediately, and zone outlines are drawn in the world. See Configuration.

  5. If your ring is not at the default location, update the coordinates in Config.lua. Follow Ring and zone setup.

  6. Restart the server, or run ensure kivo-boxing in the server console after the other resources are up.

  7. Test with two players. Walk to the bouncer, use your target key on him, and choose the sign-up option. Have the second player do the same within the search time. Both players should be moved into the ring.

Kivo Boxing uses PolyZone to define the ring area and the spectator area. The manifest lists it as a required dependency. If PolyZone is missing, misnamed or fails to start, the server console reports a dependency error and kivo-boxing does not start.

Framework Resource name checked Status
ESX es_extended Supported
QBCore qb-core Supported
QBX qbx_core Supported (QBX support was added in a recent update)

How it works:

  • The script looks for these resources by name. If you renamed your framework resource, it will not be detected.
  • The framework is used to read the character name shown on the scoreboard. QBCore and QBX use the character first and last name. ESX uses the name ESX returns for the player. If no name can be read, the scoreboard shows Player followed by the server id.
  • The script checks the framework once, when it starts. Start the framework first.
  • Apart from the names and the bouncer interaction, the boxing logic does not depend on the framework.
Resource Used when
ox_target It is running. Checked first.
qb-target ox_target is not running and qb-target is.

If neither is running, the bouncer appears but cannot be used. The client console (F8) shows a red message that no targeting resource was found.

Like the framework, the target resource is detected once at start. If you restart your target resource, restart kivo-boxing afterwards.

Players get notifications for sign-up, cancelled sign-up, a busy arena, and the match result.

  • If ox_lib is running, they use ox_lib notifications.
  • If not, they appear as chat messages.

You do not have to change anything for either case.

  1. Stop the script, or stop the server.
  2. Replace the folder contents with the new version.
  3. Copy your own values back into the new Config.lua. Do not overwrite your coordinates with the defaults.
  4. Start the script again.