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.3b2.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.3b2-py3-none-any.whl (93.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggxs-1.3b2.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.3b2.tar.gz
Algorithm Hash digest
SHA256 35208ec0494e9af032dca945c7f59bfb760bbc51a9fc67ef2047c6c3f05dbda1
MD5 9589100043d9c43a6496086a5ccf1572
BLAKE2b-256 16150fffa839dd12461c84de3101d8863e87a4b269c8171c136312fed8d94b80

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.3b2-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.3b2-py3-none-any.whl
Algorithm Hash digest
SHA256 6d681a4033091c6fc15e1eb740b761bbe3ec3e07b651d9d42ff0f1706d36bc4f
MD5 6ab93644860ad2a6289d06844c3d4731
BLAKE2b-256 bf233822e0c57fd4ccedcaa3b412fd66ff4eb619eb03b0e0df911e2709f5ab54

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