deploy: a306c73

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 72b61ecddff837f17cda4790dbf68345
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/index.rst.txt

@@ -0,0 +1,23 @@
+.. samp-query documentation master file, created by
+   sphinx-quickstart on Sat Jul  1 14:02:04 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to samp-query's documentation!
+======================================
+
+.. include:: intro.rst
+.. include:: usage.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Reference:
+
+   samp_query
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

_sources/intro.rst.txt

@@ -0,0 +1,19 @@
+samp-query is a Python library for interacting with SA-MP/open.mp servers using the query protocol. It provides functionality to query server information, retrieve player list, show rules, and execute remote console (RCON) commands.
+
+Installation
+------------
+
+To install the library, you can use ``pip``:
+
+.. code-block:: sh
+
+    pip install samp-query
+
+Features
+--------
+
+* Connect to a game server using IP address and port.
+* Retrieve server information including name, player count, maximum players, gamemode, and language.
+* Get a list of players currently on the server with their name and score.
+* Fetch a list of rules and their values set on the server.
+* Execute RCON commands on the server (requires RCON password).

_sources/samp_query.rst.txt

@@ -0,0 +1,9 @@
+samp\_query module
+==================
+
+API reference
+-------------
+
+.. automodule:: samp_query
+   :members:
+   :show-inheritance:

_sources/usage.rst.txt

@@ -0,0 +1,42 @@
+Usage
+-----
+
+Here's a basic example of how to use the library:
+
+.. code-block:: python
+
+    import trio
+    from samp_query import Client
+
+
+    async def main():
+        client = Client(
+            ip='127.0.0.1',
+            port=7777,
+            rcon_password=None,  # Your rcon password as string
+        )
+
+        info = await client.info()
+        print(f'Server Name: {info.name}')
+        print(f'Player Count: {info.players}/{info.max_players}')
+
+        player_list = await client.players()
+        print('Players:')
+
+        for player in player_list.players:
+            print(f'- {player.name} (Score: {player.score})')
+
+        rule_list = await client.rules()
+        print('Rules:')
+
+        for rule in rule_list.rules:
+            print(f'- {rule.name}: {rule.value}')
+
+        if client.rcon_password:
+            response = await client.rcon('echo Hello, server!')
+            print(f'RCON Response: {response}')
+
+
+    trio.run(main)
+
+Make sure to replace ``'127.0.0.1'`` and ``7777`` with the actual IP address and port of the game server you want to connect to. If the server has RCON enabled, provide a password in the ``rcon_password`` attribute of the :class:`samp_query.Client` instance (otherwise keep it None).

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}