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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggxs-1.4b4.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.4b4.tar.gz
Algorithm Hash digest
SHA256 ec16bef7f61315acea26681bda492de306c3345ab21de0eb8b3746331bfa2722
MD5 1b7fbf3146241bcc3ba5944ee935668c
BLAKE2b-256 8ae8c8a888811121b18f1a41addb595c192ffd3fb3eb84d6a49b5f497a1d63e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.4b4-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.4b4-py3-none-any.whl
Algorithm Hash digest
SHA256 029aeac01a48451673b365e5150ca4c668b3bcbe2ead24f4e409c359ff89415d
MD5 e65e193b678dcff01026b2be99a04eee
BLAKE2b-256 511c0fa6415f206c07f771e5dbb000bfde8ee65025cfc86e790870ca8ca2bad2

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