📝 Contribution Opportunities

Interested in contributing? Below are available tasks across different areas of the project. Feel free to reach out to @yulesxoxo for questions or guidance.

🔧 Backend Development

Device Abstraction Layer for ADB retry mechanism

Implement a ADBDevice class and remove all adbutils specific code from game.py
Create some general retry logic or wrapper for anything that uses adbutils

Rough idea with a decorator:

def adb_retry(retry_attempts=2, retry_attempts_after_restart=3, sleep_time=5):
    def decorator(func):
        @wraps(func)
        def wrapper(self, *args, **kwargs):
            last_exception = None
            
            # First phase try again but wait before next try.
            for attempt in range(1, retry_attempts + 2):
                try:
                    return func(self, *args, **kwargs)
                except Exception as e:
                    last_exception = e
                    if attempt <= retry_attempts:
                        logging.warning(f"Attempt {attempt} failed for {func.__name__}, retrying in {sleep_time} seconds...")
                        time.sleep(sleep_time)
            
            # Second phase: Restart ADB server and rebuild the connection
            # Kill ADB process
            # Restart adb server
            # reinitialize ADBDevice

            for attempt in range(1, retry_attempts_after_restart + 2):
                ...
            
            # If we get here, all attempts failed
            raise ADBUnrecoverableError(str(last_exception))
        return wrapper
    return decorator

Usage:

@adb_retry
def press_back_button(self) -> None:
    """Presses the back button."""
    with self.device.shell("input keyevent 4", stream=True) as connection:
        logging.debug("pressed back button")
        connection.read_until_close()

Android Multi-Touch Gesture Implementation (PoC)

Library: uiautomator2

Challenge:
ADB lacks native multi-touch gesture support. uiautomator2 offers:

Coordinate-based tapping (d.click(x, y))
Screenshot capture (d.screenshot())
Advanced gestures (swipe, pinch, etc.)

Goals:

Develop PoC for multi-touch gestures
Prioritize pinch-to-zoom for game automation

Extended Opportunities:

Explore additional uiautomator2 game automation features
Performance comparison: uiautomator2 vs standard ADB
Benchmark tests for shared functionality (tap, screenshot, swipe)

Desktop Client Support Investigation

Current Understanding:

Mouse click simulation limitations (requires actual cursor movement)
Screenshot challenges with display scaling/multi-monitor setups
Higher detection risk compared to ADB (if Lilith starts to care about botting)

Implementation Needs:

Device abstraction layer (Android vs Desktop)

Unified input mapping system

# The actual bot code should not end up looking like this.
if device.platform == "Android":
device.press_back_button()
elif device.platform == "DesktopApp":
device.keyboard.press("ESC")