How ikabot-collective/ikabot works
Project type and purpose
• From the README (“Ikabot is a cross-platform Python program…enhances your Ikariam game”), this is a desktop/CLI automation tool (with an embedded web API interface) that interacts with the external Ikariam game servers to provide automated city-management and warfare features.
File structure
• Top-level:
• Dockerfile, CI workflows (.github/workflows) – Docker image and CI/CD pipelines.
• setup.py, MANIFEST.in – packaging/ distribution.
• ikabot/ – the application code:
– __main__.py & command_line.py – entry point for CLI.
– config.py / .env.example – configuration management.
– function/ – each script implements a specific game automation feature.
– helpers/ – common utilities (HTTP API comm, encryption, logging, GUI, routing, Telegram bot, etc.).
– web/ – lightweight HTTP session server for remote control or API endpoints.
– locale/ – translations.
• tests/ – automated tests for API routes and core functions.
Detail
• 3 user‐facing interfaces (CLI, Web API, Telegram).
• Helper category (network, encryption, logging).
• Don’t over-abstract—show multiple “function” modules as a single block or grouped by category.