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 alpha 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.0b0.tar.gz (52.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.0b0-py3-none-any.whl (76.4 kB view details)

Uploaded Python 3

File details

Details for the file ggxs-1.0b0.tar.gz.

File metadata

  • Download URL: ggxs-1.0b0.tar.gz
  • Upload date:
  • Size: 52.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ggxs-1.0b0.tar.gz
Algorithm Hash digest
SHA256 e23a66136afba542172bbcb3ff09fc5a85ac047fa531d956f1b843286f1396b8
MD5 e47b42c556b50b488b9e46e010287238
BLAKE2b-256 abb422010aa87448b996285109d0daf6bc79cb552f0258d4b7962101a0549f88

See more details on using hashes here.

File details

Details for the file ggxs-1.0b0-py3-none-any.whl.

File metadata

  • Download URL: ggxs-1.0b0-py3-none-any.whl
  • Upload date:
  • Size: 76.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ggxs-1.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa806e20ae16aa6017c8ba314c98ffe93559933b257bbafa41e9c549e0fbdbf6
MD5 9ddce59968f32bf59ea9e186bcf30068
BLAKE2b-256 fad937bd999b66d6902dd6469f11df57f018c949e59f6120deb6bcec0d6602c5

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