CS:GO KZ Docs

Appearance

Return to top
On this page

Requirements

  • Server owners cannot be globally banned or have a previous global ban.
  • Must not be a LAN or locally-hosted server. Regardless of whether it's open to the public.
  • If the server is going to be password protected or SteamID/group whitelisted, then replay bot files must be accessible to the Global Team. The Global Team must be able to access the server (add them to the whitelist or share the password).
  • You have read, understood and comply with the Global Server Owner Code of Conduct.

Before you begin

  1. This guide assumes that you have a working GOKZ server.
  2. This guide assumes that you have access to the server files.

WARNING

If you are asked to overwrite files at any point in the guide, accept the overwrites.

WARNING

If you are having trouble with a step, try the #support channel in our Discord server.
Be sure to mention which step you are having trouble with and include as much information as possible, including the error logs from csgo/addons/sourcemod/logs/errors_********.log.

1. Install SteamWorks

  1. Start by downloading SteamWorks.

  2. Extract the files into your server's csgo directory.

  3. You should now have SteamWorks installed and working.

Confirm this step

Run the following command in the server console: sm exts load SteamWorks.
You should see the following line in the output: [SM] Loaded extension SteamWorks.ext.so successfully..

2. Install GlobalAPI plugin

  1. Start by downloading GlobalAPI-SMPlugin.

  2. Extract the files into your server's csgo directory.

  3. You should now have GlobalAPI-SMPlugin installed and working.

Confirm this step

Restart your server and type sm plugins list in the server console.
You should see the following line in the output: GlobalAPI (2.0.4).

3. Verify installation

Once you have installed the above, type !globalcheck in chat.

You should see output being the following:

KZ | Global Records Availability Check
API Key X | Plugins ✓ | Settings Enforcer ✓ | Map ✓ | You X
Vanilla ✓ | SimpleKZ ✓ | KZTimer ✓

4. Verify configuration of the server

Install the KZ Server Advisor Plugin.

Use the sm_kzserveradvisor_gokz command.

Check the log file made in csgo/addons/sourcemod/logs/L********.log.

The output must show OKAY or PASS for all tests. Rectify any issues and run the command again.

5. Apply for an API key

  1. Sign in to the GlobalAPI portal.
  2. After logging in, click "New Server".
  3. Fill in your server's details and press "Apply".
  4. Once you've applied, you will see the server listed.
  5. Note the server's id, you will need it in the next steps.
  6. Click on the arrow on the left of the server and copy your API key.
  7. Paste the API key as is into csgo/cfg/sourcemod/globalapi-key.cfg.

6. Posting an application

  1. Login to the GOKZ forum.
  2. Start a discussion in the Server Application section.
  3. Title the application as your server's name.
  4. Replace the post content with your information.

The Global Team will then review your application and advise you further if necessary.