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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggxs-1.3b1.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.3b1.tar.gz
Algorithm Hash digest
SHA256 0f6114a48e845685b0ce63d86ffe95a20eba46eb48ffb277d121d0c5c396adeb
MD5 4f1f12f0059c1cc6ef975f4de1143df8
BLAKE2b-256 e29b300f00014d6e101338846f2246250d7be74ac20ef561a01b06c589aa4781

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.3b1-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.3b1-py3-none-any.whl
Algorithm Hash digest
SHA256 b326eb9be8526e079d007d7d41765c518c72cbc37034489b213168ac646f848e
MD5 4b0c283477cf3e7dba585a9e9f8140b6
BLAKE2b-256 16788e602910ab8eff870d2c96e67078c4487b410b7dffe0ed50d573c06f3521

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