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.2b0.tar.gz (65.1 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.2b0-py3-none-any.whl (93.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ggxs-1.2b0.tar.gz
Algorithm Hash digest
SHA256 154609704b1a53bcbce1b88ccfef3d4ae066e6161b6c2aaf16a4ed07592ccd44
MD5 9717cdb01dc0269f2d0f9bb7e2b5431f
BLAKE2b-256 d91a09de5b158744f9dcf8020e197ac0b257823b618ca9824e5f275ebecbf45f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.2b0-py3-none-any.whl
  • Upload date:
  • Size: 93.3 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.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 78e0783d1e855b914df26e245b99a58d4551c5766e575b10c14f2989bb06506b
MD5 97394db16ae168c47df3db97104c27ed
BLAKE2b-256 52b48018c10e28c195345b8479c6f56cfbf5bdcce86bb4ab91a61d3ef9b6d7d2

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