{"id":22267906,"url":"https://github.com/cfmvcarlos/zup-game-bot","last_synced_at":"2025-03-25T14:44:02.792Z","repository":{"id":264397928,"uuid":"893259849","full_name":"CFMVCarlos/Zup-Game-Bot","owner":"CFMVCarlos","description":"This project automates mouse clicks to complete a sequence of levels in the game Zup!, available on Steam. By leveraging Python, it simulates precise mouse interactions at specific screen coordinates, enabling seamless and efficient gameplay automation.","archived":false,"fork":false,"pushed_at":"2024-11-24T00:19:30.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T13:28:35.780Z","etag":null,"topics":["pil-image","pyautogui","python","python-bot","python-game","python-keyboard","python-mouse","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CFMVCarlos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-24T00:17:37.000Z","updated_at":"2024-11-24T00:21:05.000Z","dependencies_parsed_at":"2024-11-24T02:15:40.780Z","dependency_job_id":null,"html_url":"https://github.com/CFMVCarlos/Zup-Game-Bot","commit_stats":null,"previous_names":["cfmvcarlos/zup-game-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMVCarlos%2FZup-Game-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMVCarlos%2FZup-Game-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMVCarlos%2FZup-Game-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMVCarlos%2FZup-Game-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CFMVCarlos","download_url":"https://codeload.github.com/CFMVCarlos/Zup-Game-Bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245485690,"owners_count":20623237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pil-image","pyautogui","python","python-bot","python-game","python-keyboard","python-mouse","python3"],"created_at":"2024-12-03T11:09:33.303Z","updated_at":"2025-03-25T14:44:02.752Z","avatar_url":"https://github.com/CFMVCarlos.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Programming Click Mouse  \n\nThis project automates mouse clicks to complete a sequence of levels in the game **Zup!**, available on [Steam](https://store.steampowered.com/app/533300/Zup/). By leveraging Python, it simulates precise mouse interactions at specific screen coordinates, enabling seamless and efficient gameplay automation.  \n\n---\n\n## Features  \n- **Automated Mouse Clicks**: Automate predefined sequences of clicks to progress through game levels.  \n- **Real-Time Mouse Coordinates**: Retrieve and display the current position of the mouse cursor.  \n- **Modular and Extensible**: Includes reusable utility functions for efficient automation and customization.  \n\n---\n\n## Project Structure  \n\n- **`Levels.py`**:  \n  Implements the `run_levels` function, which automates mouse clicks across multiple game levels.  \n\n- **`getMouse.py`**:  \n  Displays the current mouse position in real-time when a mouse click is detected.  \n\n- **`ZUP.py`**:  \n  The main script that initiates and manages gameplay automation for all predefined levels.  \n\n- **`common.py`**:  \n  A utility module containing shared functions for mouse control, including:  \n  - `level_template_click`: Manages level-specific automation sequences.  \n  - `mouse_click`: Simulates a single mouse click with optional coordinate conversion for different screen resolutions.  \n\n---\n\n## Setup and Usage  \n\n### Prerequisites  \n1. Install Python (version 3.7 or later is recommended).  \n2. Install required dependencies using the following command:  \n   ```bash  \n   pip install -r requirements.txt  \n   ```  \n\n### Running the Scripts  \n\n#### 1. Display Mouse Position  \nUse `getMouse.py` to identify screen coordinates for automation. Each mouse click will print the current cursor position to the console, making it ideal for debugging and customization.  \n   ```bash  \n   python getMouse.py  \n   ```  \n\n#### 2. Automate Gameplay  \nRun the main script `ZUP.py` to initiate the automation. This script performs the following tasks:  \n- Resets the game state.  \n- Executes level-specific click sequences.  \n- Retries levels if necessary, based on timeout or unmet conditions.  \n   ```bash  \n   python ZUP.py  \n   ```  \n\n---\n\n## Core Functions  \n\n### `run_levels` (in `Levels.py`)  \nAutomates mouse clicks across multiple game levels, with customizable timing and positional parameters.  \n\n### `display_mouse_position` (in `getMouse.py`)  \nDisplays the current mouse cursor position in the console when the mouse is clicked.  \n\n### `level_template_click` (in `common.py`)  \nHandles the automation logic for individual levels, including:  \n- Resetting the game state.  \n- Simulating multiple clicks with precise timing.  \n- Implementing retries for unmet conditions or timeouts.  \n\n### `mouse_click` (in `common.py`)  \nSimulates a mouse click at a specified position, with built-in support for screen resolution scaling.  \n\n---\n\n## Additional Notes  \n\n- **Customizable Click Sequences**: The click positions, delays, and conditions can be easily modified in `Levels.py` to suit different levels or UI layouts.  \n- **Screen Resolution Adaptability**: The `convert_coords` function ensures compatibility with various screen resolutions by scaling coordinates dynamically.  \n\n---\n\n## Contributing  \n\nContributions are welcome! Here's how you can help:  \n- **Fork this repository**: Create a branch for your changes.  \n- **Submit a pull request**: Share your improvements for review.  \n\nFor significant changes, open an issue to discuss your ideas before implementation.  \n\n---\n\n## License  \n\nThis project is licensed under the [MIT License](LICENSE).  \n\n---\n\n## Author  \n\nDeveloped by [Carlos Valente](https://github.com/CFMVCarlos).  \n\nFeel free to reach out with any questions, suggestions, or collaboration opportunities!  ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfmvcarlos%2Fzup-game-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfmvcarlos%2Fzup-game-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfmvcarlos%2Fzup-game-bot/lists"}