AURUMVORAX/PyG2O
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Updated installation docs

Browse Source
This commit is contained in:
AURUMVORXX
2025-05-27 00:07:47 +03:00
parent 7f189b806b
commit 1a9b086c9a
4 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/index.md
View File

@@ -1,12 +1,13 @@
## How to use ## How to use
1. Install [G2O WebSocket module](https://github.com/AURUMVORXX/G2O-WebSocket) to your server 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 ```xml
<import src="include/pyg2o.exml" /> <import src="include/pyg2o.xml" />
``` ```
2. Install python library to your application 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 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 // max_reconnect_attempts - maximum reconnect attempts if server will stop the connection (0 - infinite attempts). This value doesn't reset on connection
// Start server // Start server
local srv = PyG2O("ws://localhost:8080", true, 15) local srv = PyG2O("ws://localhost:8080", false, 15)
srv.start() srv.start()
// Stop server // Stop server
srv.stop() srv.stop()
@@ -33,9 +34,7 @@ async def main():
host='localhost', host='localhost',
port=8080, port=8080,
ping_interval=30, ping_interval=30,
silent=False,
whitelist=['::1'], whitelist=['::1'],
# logger = YOUR_LOGGER,
) )
try: try:
await srv.start() await srv.start()

2
pyproject.toml
View File

@@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "PyG2O" name = "PyG2O"
version = "2.1.3" version = "2.2.0"
description = "" description = ""
authors = ["AURUMVORAX <aurumvorax.enthroned@gmail.com>"] authors = ["AURUMVORAX <aurumvorax.enthroned@gmail.com>"]

0
src/pyg2o/classes/__init__.py Normal file
View File

0
src/pyg2o/functions/__init__.py Normal file
View File