Helios Documentation

Introduction

Helios is a revolutionary software-based controller adapter that bridges the gap between computer vision and controller inputs. With Helios, you can create sophisticated automation scripts that respond to visual cues, implement complex macros, and enhance your gaming experience in ways never before possible.

This documentation will guide you through the installation process, basic usage, and advanced features of Helios.

System Requirements

Minimum Requirements

  • Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
  • Processor: Intel Core i5 or AMD Ryzen 5 (or equivalent)
  • Memory: 8GB RAM
  • Graphics: DirectX 11 compatible GPU with 2GB VRAM
  • Storage: 500MB available space
  • Python 3.8 or higher

Recommended Requirements

  • Processor: Intel Core i7 or AMD Ryzen 7 (or equivalent)
  • Memory: 16GB RAM
  • Graphics: NVIDIA GTX 1060 or AMD RX 580 (or better)
  • Storage: 1GB available space

Installation

Step 1: Download Helios

Download the latest version of Helios from our Discord server. Make sure to join the server first to access the download channels.

Step 2: Install Dependencies

Bash
# Install Python dependencies
pip install opencv-python numpy
pip install helios-controller

# For advanced features
pip install tensorflow scikit-learn

Step 3: Verify Installation

Python
import helios
print(f"Helios version: {helios.__version__}")
print("Installation successful!")

Getting Started

Your First Script

Let's create a simple script that demonstrates the basic functionality of Helios:

Python
from helios import Controller
import time

# Initialize the controller
controller = Controller()

# Simple button press
controller.press('A')
time.sleep(0.1)

# Hold a button
controller.hold('B', duration=2.0)

# Analog stick movement
controller.move_stick('left', x=0.5, y=0.5)
time.sleep(1.0)
controller.move_stick('left', x=0, y=0)
Note: Make sure your controller is connected and recognized by your system before running Helios scripts.

Basic Usage

Button Controls

Helios supports all standard controller buttons:

  • Face buttons: A, B, X, Y (Xbox) / Cross, Circle, Square, Triangle (PlayStation)
  • Shoulder buttons: LB, RB, LT, RT / L1, R1, L2, R2
  • D-Pad: Up, Down, Left, Right
  • System buttons: Start, Select/Back, Home
  • Stick buttons: LS, RS (Left Stick, Right Stick click)

Analog Controls

Control analog sticks with precise values:

Python
# Move left stick to 50% right, 75% up
controller.move_stick('left', x=0.5, y=0.75)

# Move right stick in a circle
import math
for angle in range(0, 360, 10):
    x = math.cos(math.radians(angle))
    y = math.sin(math.radians(angle))
    controller.move_stick('right', x=x, y=y)
    time.sleep(0.05)

Configuration

Helios can be configured through the helios_config.json file:

JSON
{
    "controller": {
        "type": "xbox",
        "deadzone": 0.15,
        "vibration": true
    },
    "vision": {
        "capture_fps": 30,
        "resolution": [1920, 1080],
        "processing_threads": 4
    },
    "logging": {
        "level": "INFO",
        "file": "helios.log"
    }
}

Scripting Basics

VG Script Language

In addition to Python, Helios supports VG (Visual Gaming) scripts for simpler automation:

VG Script
# Simple combo
combo quick_attack {
    press X
    wait 100ms
    press A
    wait 50ms
    hold B 500ms
}

# Conditional execution
if health < 30% {
    use_item healing_potion
    wait 2s
}

# Loop example
repeat 5 {
    combo quick_attack
    wait 1s
}

Computer Vision Integration

Helios's most powerful feature is its integration with computer vision:

Python
from helios import Controller, Vision
import cv2

controller = Controller()
vision = Vision()

# Define what to look for
template = cv2.imread('enemy_marker.png')

@vision.on_screen_match(template, threshold=0.8)
def on_enemy_detected(match):
    # Get position of the match
    x, y = match.center
    
    # Aim towards the enemy
    screen_center_x = vision.width // 2
    offset = (x - screen_center_x) / screen_center_x
    
    controller.move_stick('right', x=offset * 0.3, y=0)
    controller.press('RT')  # Fire!

# Start vision processing
vision.start()
Warning: Always use computer vision features responsibly and in accordance with game terms of service.

Troubleshooting

Common Issues

Controller Not Detected

  • Ensure your controller is properly connected via USB or Bluetooth
  • Check if the controller works in other applications
  • Try running Helios with administrator privileges
  • Update your controller drivers

Vision Features Not Working

  • Verify OpenCV is properly installed: pip install opencv-python --upgrade
  • Check if the game is running in fullscreen borderless mode
  • Ensure Helios has screen capture permissions
  • Try reducing the capture resolution in the configuration

High CPU Usage

  • Lower the vision capture FPS in configuration
  • Reduce the number of processing threads
  • Optimize your vision detection algorithms
  • Use region-of-interest (ROI) to limit processing area

Frequently Asked Questions

Is Helios allowed in online games?

The legality of using Helios depends on the specific game's terms of service. Always check and comply with the rules of the games you play. We recommend using Helios primarily for single-player games, accessibility purposes, or in private matches with consent.

Can I share my scripts with others?

Yes! We encourage sharing scripts within our Discord community. You can find a dedicated channel for script sharing and collaboration.

Does Helios work with all controllers?

Helios supports most modern controllers including Xbox, PlayStation, and many third-party controllers. Check our compatibility list in the Discord server for specific models.

How do I update Helios?

Updates are distributed through our Discord server. Join the announcements channel to be notified of new releases and features.

Need More Help?

Join our community for support, script sharing, and updates

Join Discord Community