From 1a9b086c9aaa5f53d3a4504c72a07fc34de72883 Mon Sep 17 00:00:00 2001 From: AURUMVORXX Date: Tue, 27 May 2025 00:07:47 +0300 Subject: [PATCH] docs: Updated installation docs --- docs/index.md | 11 +++++------ pyproject.toml | 2 +- src/pyg2o/classes/__init__.py | 0 src/pyg2o/functions/__init__.py | 0 4 files changed, 6 insertions(+), 7 deletions(-) create mode 100644 src/pyg2o/classes/__init__.py create mode 100644 src/pyg2o/functions/__init__.py diff --git a/docs/index.md b/docs/index.md index 2443ab1..ee73440 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,13 @@ ## How to use 1. Install [G2O WebSocket module](https://github.com/AURUMVORXX/G2O-WebSocket) to your server -1. Download **include/** folder and import the Squirrel part of the library: +2. Install [JSON module](https://gitlab.com/GothicMultiplayerTeam/modules/json) to your server +3. Download **include/** folder and import the Squirrel part of the library: ```xml - + ``` 2. Install python library to your application ``` -pip install git+https://github.com/AURUMVORXX/PyG2O.git +pip install pyg2o ``` 3. Launch websocket client in your Squirrel scripts ``` @@ -15,7 +16,7 @@ pip install git+https://github.com/AURUMVORXX/PyG2O.git // max_reconnect_attempts - maximum reconnect attempts if server will stop the connection (0 - infinite attempts). This value doesn't reset on connection // Start server -local srv = PyG2O("ws://localhost:8080", true, 15) +local srv = PyG2O("ws://localhost:8080", false, 15) srv.start() // Stop server srv.stop() @@ -33,9 +34,7 @@ async def main(): host='localhost', port=8080, ping_interval=30, - silent=False, whitelist=['::1'], - # logger = YOUR_LOGGER, ) try: await srv.start() diff --git a/pyproject.toml b/pyproject.toml index ba8b213..89e09e1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "PyG2O" -version = "2.1.3" +version = "2.2.0" description = "" authors = ["AURUMVORAX "] diff --git a/src/pyg2o/classes/__init__.py b/src/pyg2o/classes/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/pyg2o/functions/__init__.py b/src/pyg2o/functions/__init__.py new file mode 100644 index 0000000..e69de29