Skip to main content

GoodGame Empire websocket engine.

Project description

GGXS

The most advanced API library for interacting with GoodGame Empire.

Description

The most advanced API client library for GoodGame Empire (GGE), enabling automated connection, gameplay actions, and system scripting. Built for Python 3.12+, ggxs is currently in beta stage—ideal for early adopters exploring automation within GoodGame Empire.

Install

pip install ggxs

Example

from ggxs import GGXS
import asyncio


class Example(GGXS):

    def __init__(self, url, server_header, username, password):
        super().__init__(url, server_header, username, password)
        ## var example
        self.example = None


    ## add your jobs here!
    async def run_jobs(self):
        ## get castles detailes
        await self.get_detailed_castles()

async def main():
    app = Example("wss://ep-live-ro1-game.goodgamestudios.com/", "EmpireEx_15", "My username", "my password")
    await app.connect()
     
asyncio.run(main())

Warning

  • This project is still under development and can cause errors or bugs!
  • Just for education purpose only!
  • I'm not responsible for any action which will be taken by GGE Studios against your account!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ggxs-1.3b3.tar.gz (65.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ggxs-1.3b3-py3-none-any.whl (93.3 kB view details)

Uploaded Python 3

File details

Details for the file ggxs-1.3b3.tar.gz.

File metadata

  • Download URL: ggxs-1.3b3.tar.gz
  • Upload date:
  • Size: 65.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for ggxs-1.3b3.tar.gz
Algorithm Hash digest
SHA256 a46bee1c46e46ff4bd2d524cc050d60a063ba8f02c11cc5aeef18a7ca5c31e62
MD5 deb6e34ff2d0cf55aadf9b44d52481eb
BLAKE2b-256 5bf2f8208ee8e7b2df8d1a64033c31575019f9caaeed389f9f91b7d63fd7bb07

See more details on using hashes here.

File details

Details for the file ggxs-1.3b3-py3-none-any.whl.

File metadata

  • Download URL: ggxs-1.3b3-py3-none-any.whl
  • Upload date:
  • Size: 93.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for ggxs-1.3b3-py3-none-any.whl
Algorithm Hash digest
SHA256 c8c785f7311bf21eda3297ed30ac04aa07c1fff9e7779c292f7bb4c1c1bf2882
MD5 f2ef8f6f411294ac811c5fad5313d28c
BLAKE2b-256 08d87dac73a3628af23c043e2bc58c5304b79a7da9a7c2758337afcbcdf5e3f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page