This library provides a Python interface to the API of Anacreon 3, which is an online 4X game produced by Kronosaur Productions, LLC.
Project description
anacreonlib
|PyPI Version| |Documentation Status|
This unofficial library provides a Python interface to the API of
Anacreon 3 <https://anacreon.kronosaur.com>
, which is an online
4X <https://en.wikipedia.org/wiki/4X>
game produced by
Kronosaur Productions, LLC. <http://kronosaur.com/>
_.
The minimum supported Python version is 3.8
Make sure to read the "Scripts and Bots" section of the
Kronosaur Terms of Service <https://multiverse.kronosaur.com/news.hexm?id=97#:~:text=scripts%20and%20bots>
_.
Installation
anacreonlib
can be installed using pip::
$ pip install anacreonlib
Usage
Below is a minimum working example to get started with using the Anacreon API
.. code-block:: python
from anacreonlib import Anacreon, Fleet
import asyncio
async def main():
## Step 1: Log in
client: Anacreon = await Anacreon.log_in(
game_id="8JNJ7FNZ",
username="username",
password="password"
)
## Step 2: do cool stuff, automatically!
# find all of our fleets
all_my_fleets = [
fleet
for fleet in client.space_objects.values()
if isinstance(fleet, Fleet)
and fleet.sovereign_id == client.sov_id
]
# send all our fleets to world ID 100
for fleet in all_my_fleets:
await client.set_fleet_destination(fleet.id, 100)
if __name__ == "__main__":
asyncio.run(main())
Rate Limits
The API has rate limits which are detailed in
this Ministry record <https://ministry.kronosaur.com/record.hexm?id=79981>
_.
Beware that they apply to both any scripts you write AND the online client.
.. |PyPI Version| image:: https://img.shields.io/pypi/v/anacreonlib.svg :target: https://pypi.python.org/pypi/anacreonlib
.. |Documentation Status| image:: https://readthedocs.org/projects/anacreonlib/badge/?version=latest :target: http://anacreonlib.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for anacreonlib-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61cae311b66c8b8e91f68213783c56475d78e838faad7e4efae535e4e840a7c9 |
|
MD5 | 0532196e08810b1200a1b42feca5f297 |
|
BLAKE2b-256 | bc4b75dcd60de28a344e9ca14ff0d2aa967ab0fe5141423752c0f521d7c38e26 |