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.4b3.tar.gz (497.0 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.4b3-py3-none-any.whl (525.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ggxs-1.4b3.tar.gz
Algorithm Hash digest
SHA256 c133e60827b2582258ecfa62a87b01c91f09b72cf6f729fb65e97244f655ff25
MD5 06796cd2c480b465864553cc3591f145
BLAKE2b-256 50d89268b6917351204313cfd26c1b82cc4adbe98f7f6a09ea7f6a13e98b33c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.4b3-py3-none-any.whl
  • Upload date:
  • Size: 525.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.4b3-py3-none-any.whl
Algorithm Hash digest
SHA256 64c48fa0d3659b86955e832eedb219966d73b6c57200c72d303772617fda94f3
MD5 b5014edadfb2ab008dae73dfe2a3252b
BLAKE2b-256 770096f005ebc9c4468a1048218f7f684a791456e1de89d796079b38bea44371

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