ggx


Nameggx JSON
Version 0.4.8 PyPI version JSON
download
home_pageNone
SummaryAPI for GoodGame Empire
upload_time2025-08-31 13:39:25
maintainerNone
docs_urlNone
authormst4ck
requires_python>=3.12
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GGX
The most advanced API library for interacting with GoodGame Empire.


## Description

An API client library for GoodGame Empire (GGE), enabling automated
connection, gameplay actions, and system scripting. Built for Python 3.12+,
ggx is currently in alpha stage—ideal for early adopters exploring automation
within GoodGame Empire.


## Install

```bash
pip install ggx
```

## Example

```
from ggx 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()

## example contain Romanian server!
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!
 - For any contribution, contact me!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ggx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "mst4ck",
    "author_email": "mst4ck@mailfence.com",
    "download_url": "https://files.pythonhosted.org/packages/00/31/b6dcf27f2fc6e7853e7680f283de8dc24b88a2cec3c6a138ef5470d37d02/ggx-0.4.8.tar.gz",
    "platform": null,
    "description": "# GGX\r\nThe most advanced API library for interacting with GoodGame Empire.\r\n\r\n\r\n## Description\r\n\r\nAn API client library for GoodGame Empire (GGE), enabling automated\r\nconnection, gameplay actions, and system scripting. Built for Python 3.12+,\r\nggx is currently in alpha stage\u2014ideal for early adopters exploring automation\r\nwithin GoodGame Empire.\r\n\r\n\r\n## Install\r\n\r\n```bash\r\npip install ggx\r\n```\r\n\r\n## Example\r\n\r\n```\r\nfrom ggx import GGXS\r\nimport asyncio\r\n\r\n\r\nclass Example(GGXS):\r\n\r\n    def __init__(self, url, server_header, username, password):\r\n        super().__init__(url, server_header, username, password)\r\n        ## var example\r\n        self.example = None\r\n\r\n\r\n    ## add your jobs here!\r\n    async def run_jobs(self):\r\n        ## get castles detailes\r\n        await self.get_detailed_castles()\r\n\r\n## example contain Romanian server!\r\nasync def main():\r\n    app = Example(\"wss://ep-live-ro1-game.goodgamestudios.com/\", \"EmpireEx_15\", \"My username\", \"my password\")\r\n    await app.connect()\r\n     \r\nasyncio.run(main())\r\n```\r\n\r\n\r\n## Warning\r\n\r\n - This project is still under development and can cause errors or bugs!\r\n - Just for education purpose only!\r\n - I'm not responsible for any action which will be taken by GGE Studios against your account!\r\n - For any contribution, contact me!\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "API for GoodGame Empire",
    "version": "0.4.8",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7782c87a974d008bf08e9d75dc7b5a8123ee208b37e8c2cde10e3aebb000c339",
                "md5": "e29f782b7415fdf107ecfc4c188d3e5b",
                "sha256": "0f4d218b0b5cb8cefff057eff34145351d53dad65641a55e881e4cd0cc62851a"
            },
            "downloads": -1,
            "filename": "ggx-0.4.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e29f782b7415fdf107ecfc4c188d3e5b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 39163,
            "upload_time": "2025-08-31T13:39:23",
            "upload_time_iso_8601": "2025-08-31T13:39:23.861586Z",
            "url": "https://files.pythonhosted.org/packages/77/82/c87a974d008bf08e9d75dc7b5a8123ee208b37e8c2cde10e3aebb000c339/ggx-0.4.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0031b6dcf27f2fc6e7853e7680f283de8dc24b88a2cec3c6a138ef5470d37d02",
                "md5": "071bfe7b6f7559f8f4f2b0ab55ec6b68",
                "sha256": "70db338df73ab88ed27ea5799cbf285560b433c41ba88c5f6e410bb43ca0917a"
            },
            "downloads": -1,
            "filename": "ggx-0.4.8.tar.gz",
            "has_sig": false,
            "md5_digest": "071bfe7b6f7559f8f4f2b0ab55ec6b68",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 24473,
            "upload_time": "2025-08-31T13:39:25",
            "upload_time_iso_8601": "2025-08-31T13:39:25.151547Z",
            "url": "https://files.pythonhosted.org/packages/00/31/b6dcf27f2fc6e7853e7680f283de8dc24b88a2cec3c6a138ef5470d37d02/ggx-0.4.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-31 13:39:25",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ggx"
}
        
Elapsed time: 0.72395s