Metadata-Version: 2.1
Name: arknights-farmer
Version: 2020.7.28
Summary: Farming assistant for Arknights
Home-page: https://github.com/cytopz/arknights-farmer
Author: cytopz
Author-email: cytopz@protonmail.com
License: MIT
Description: # arknights-farmer
        
        Farming assistant for Arknights.
        
        ## Installation
        
        ### Prerequisites
        
        * Python >= 3.7.4
        * pip
        * adb from android platform-tools added to your `$PATH`
        
        ### From Source
        
        Clone this repository using `git clone` command (or just download the `zip` version). 
        
        Install the dependencies using `pip`.
        ```bash
        $ pip install -r requirements.txt
        ```
        
        Run the script using the following command inside the repo directory.
        ```bash
        $ python3 -m arknights-farmer
        ```
        ### From PyPi (Recommended)
        
        For Windows users (run `cmd` as administrator):
        ```bash
        pip install arknights-farmer
        ```
        
        For Linux users:
        ```bash
        $ sudo pip install arknights-farmer
        ```
        
        ## Usage
        
        ```
        usage: arknights-farmer [-h] [-s STAGE [STAGE ...]] [-c] [-r REFILL] [-l] [-v]
        
        optional arguments:
          -h, --help            show this help message and exit
        
        required args:
          -s STAGE [STAGE ...], --stage STAGE [STAGE ...]
                                manually add stage(s) to farm task (e.g. 1-7:100
                                4-4:25 (separated by whitespace))
          -c, --cont            continue from the most recent farming session
        
        optional args:
          -r REFILL, --refill REFILL
                                how many times you want to refill. default is 0
          -l, --list-task       list unfinished task(s) from recent farming session
          -v, --version         show version
        ```
        
        ### Connect to ADB
        
        Use the `adb devices` command to check if your adb client is connected to your emulator.
        
        Refer to your emulator manual on how to connect your adb client.
        
        ### Emulator Setting
        
        Make sure to use the following display settings on your emulator:
        * Display Resolution: 1280x720
        * DPI: 240 DPI
        
        ### Examples
        
        ```bash
        $ arknights-farmer -s 1-7:100           # runs 1-7 100 times (will stop whenever you run out of sanity)
        $ arknights-farmer -s 1-7:100 -r 10     # runs 1-7 100 times with 10 times sanity refill (prioritizes using sanity potion)
        $ arknights-farmer -s 1-7:100 ce-5:20   # runs 1-7 100 times then CE-5 20 times
        $ arknights-farmer -c                   # continues the most recent halted farming session
        ```
        Before starting the script, make sure to set yourself in the main menu screen.
        
        You can safely stop the script using `Ctrl-C`. It will save the ongoing farming task(s) before quitting.
        
        ## Contributing
        Pull requests are welcome. 
        
        ## License
        Licensed under the MIT License. See `LICENSE` for more information.
        
        ## Disclaimer
        
        It has not been clear whether it is safe to use this tool or not. I am not responsible for what happens to your account.
        
        Use at your own risk.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7.4
Description-Content-Type: text/markdown
