I need the protocol for scum server

[TheChaosToast]

Hello everyone,

I would like to use the protocol for Scum Server. I've tried everything possible so far, but haven't had any real success. I would be very grateful if there is a working workaround.

Thank you very much

[ReaperIM]

Workaround via the api.hellbz.de website :( only client_port sample: 202.189.7.3:9002

<?php
namespace GameQ\Protocols;

use GameQ\Exception\Protocol as Exception;
use GameQ\Result;
use GameQ\Server;

/**
 * SCUM API Class Protocol (cURL backend)
 */
class Scum extends Http
{
	protected $normalize = [
		'general' => [
			'hostname'   => ['hostname', 'name'],
			'dedicated'  => 'dedicated',
			'numplayers' => 'numplayers',
			'maxplayers' => 'maxplayers',
			'password'   => 'password',
			'mapname'    => 'world',
		],
	];
	
	protected $protocol = 'scum';
    protected $name = 'scum';
    protected $name_long = "SCUM API (api.hellbz.de)";

    protected $realIp = null;
    protected $realPortQuery = null;
    protected string $url = '';

    /**
     * query_port = client_port - 2
     *
     * @var int
     */
    // protected $port_diff = -2;
	

    public function findQueryPort($clientPort)
    {
        return $clientPort-2;
    }
	
    public function beforeSend(Server $server)
    {
        $this->realIp = $server->ip;
        $this->realPortQuery = $server->port_query;

        $this->url = sprintf(
            "https://api.hellbz.de/scum/api.php?address=%s&port=%s",
            $server->ip,
            $server->port_query
        );

   
        $server->ip = 'api.hellbz.de';
        $server->port_query = 443;
    }
	
    /**
     *
     * @param string $url
     * @return string
     * @throws Exception
     */
    private function httpGet(string $url): string
    {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($ch, CURLOPT_TIMEOUT, 15);

        // HTTP/1.1
        if (defined('CURL_HTTP_VERSION_1_1')) {
            curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
        }

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);

        curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120 Safari/537.36');
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Accept: application/json, text/plain, */*',
            'Accept-Language: en-US,en;q=0.9',
            'Connection: close',
            'Upgrade-Insecure-Requests: 1'
        ]);

        // gzip/deflate
        curl_setopt($ch, CURLOPT_ENCODING, '');
        curl_setopt($ch, CURLOPT_HEADER, false);

        $response = curl_exec($ch);
        $err = curl_error($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

        curl_close($ch);

        if ($response === false) {
            throw new Exception("cURL error while fetching SCUM API: $err");
        }

        if ($httpCode !== 200) {
            throw new Exception("SCUM API returned HTTP $httpCode");
        }

        if (empty($response)) {
            throw new Exception("SCUM API returned empty body.");
        }

        return $response;
    }

    public function processResponse()
    {
        if (empty($this->url)) {
            throw new Exception("SCUM URL not prepared.");
        }

        $raw = $this->httpGet($this->url);

        $json = json_decode($raw);
        if ($json === null) {
            if (preg_match('/\{.*\}/s', $raw, $m)) {
                $json = json_decode($m[0]);
            }
        }

        if ($json === null) {
            throw new Exception("Invalid JSON from SCUM API: " . substr($raw, 0, 1024));
        }

        if (!isset($json->success) || $json->success !== true) {
            $err = $json->error ?? '(no error given)';
            throw new Exception("SCUM API error: " . $err);
        }

        if (empty($json->data) || !isset($json->data[0])) {
            throw new Exception("SCUM API returned no server data.");
        }

        $data = $json->data[0];

        $result = new Result();
        $result->add('dedicated', 1);
        $result->add('gq_address', $this->realIp);
        $result->add('gq_port_query', $this->realPortQuery);
        $result->add('hostname', $data->name ?? null);
        $result->add('game_port', $data->port ?? null);
        $result->add('serverversion', $data->version ?? null);
        $result->add('world', 'scum');
        $result->add('uptime', $data->time ?? null);
        $result->add('password', isset($data->password) ? (int)$data->password : null);
        $result->add('numplayers', $data->players ?? 0);
        $result->add('maxplayers', $data->players_max ?? 0);

        return $result->fetch();
    }
}

[TheChaosToast]

Hey, thank you so much! At least it's showing me the server name correctly. But the number of online players is always 0, even though there are players on the server. What could be causing this?

[ReaperIM]

Hey, thank you so much! At least it's showing me the server name correctly. But the number of online players is always 0, even though there are players on the server. What could be causing this?

Sorry, no idea honestly 😅 I do get the player count, but it's kind of a crutch using a different API. Ideally, it should pull the data straight from the server on the site itself, but I’ve got no clue how to do that yet😬
in my site i get ts:

    "bots": 0,
    "rules": [],
    "world": "scum",
    "uptime": "00:00",
    "game_id": 0,
    "gq_name": "SCUM API (api.hellbz.de)",
    "gq_type": "scum",
    "hostname": "[2333]小蓝和她的朋友们!主PVE·5倍物资!无高达!全图刷车!无车伤!有尸潮僵尸不开门!满倍炼体",
    "password": 0,
    "dedicated": 1,
    "game_name": "SCUM API (api.hellbz.de)",
    "game_port": 28600,
    "gq_online": true,
    "gq_address": "83.223.197.127",
    "gq_mapname": "scum",
    "maxplayers": 50,
    "numplayers": 38,
    "steamappid": 0,
    "gq_hostname": "[2333]小蓝和她的朋友们!主PVE·5倍物资!无高达!全图刷车!无车伤!有尸潮僵尸不开门!满倍炼体",
    "gq_joinlink": null,
    "gq_password": 0,
    "gq_protocol": "scum",
    "gq_dedicated": 1,
    "gq_transport": "tcp",
    "gq_maxplayers": 50,
    "gq_numplayers": 38,
    "gq_port_query": 28600,
    "serverversion": "0.0.0.0.0",
    "actual_players": 38,
    "gq_port_client": 28602

[TheChaosToast]

Hello, quick update. I can add servers and they are displayed, but as soon as I try to update the data, they are marked as offline. It seems like a query is wrong... I'll have to search again.