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.4b2.tar.gz (496.3 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.4b2-py3-none-any.whl (524.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggxs-1.4b2.tar.gz
  • Upload date:
  • Size: 496.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for ggxs-1.4b2.tar.gz
Algorithm Hash digest
SHA256 8f7324ae76570fa11b3d8245b88128c2b4cb12b957f931411574448ac710253d
MD5 282a8d04a3171f4b3fe14ed09c48caa2
BLAKE2b-256 997806cfd17168bbc8ac7d55325dbca6278f0b6d224bc8ae36a27011c721ec97

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ggxs-1.4b2-py3-none-any.whl
  • Upload date:
  • Size: 524.8 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.4b2-py3-none-any.whl
Algorithm Hash digest
SHA256 da6c6880c393150f08cef658a499effec0535ddc1bc1bbaa808ef62ffc9fa73a
MD5 6e3255588daa09e320af6bf4aa6006f8
BLAKE2b-256 13f55b7a81cdf35798e539d32d7a2d443ca5290c7710d0a29eb6915dbbd141c8

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