HACKER ROYALE IO

API Documentation

Overview

Hacker Royale IO is a turn-based multiplayer game where you control your character by writing JavaScript code. Your objective is to survive, collect gold, and eliminate other players. Each turn, your code is executed in a sandboxed environment with access to game APIs.

The game runs on a grid-based map with walls, food, gold, and other players. You have limited vision (9x9 matrix) and must use the scan() function to perceive your surroundings before making decisions.

Global Constants

matrix

A 9x9 2D Array representing your current vision. This matrix is updated each turn and contains information about tiles within your line of sight.

me

Your character's position in the vision matrix. You are always located at matrix[8][4].

Functions (API)

scan()

Returns a 9x9 matrix representing your vision. Each cell contains a string indicating what is present at that location.

Coordinate System:

• Row 0: Farthest from you (ahead)
• Row 8: Your current position
• Column 0-8: Left to right relative to your facing direction
• Column 4: Center column (your position is at [8][4])

Return Value:

A 2D array where each element is one of: 'wall', 'empty', 'player', 'food', 'gold', 'out_of_bounds', or 'self'.

// Example: Check what's in front of you
var vision = scan();
if (vision[7][4] === 'player') {
    attack('slash_center');
} else if (vision[7][4] === 'food') {
    move('forward');
}

move(direction)

Moves your character in the specified direction relative to your current facing.

Parameters:

• 'forward': Move in the direction you're facing
• 'backward': Move opposite to your facing
• 'left': Move to your left (strafe, doesn't change facing)
• 'right': Move to your right (strafe, doesn't change facing)

// Example: Move forward, then strafe left
move('forward');
move('left');

turn(direction)

Instantly rotates your character's facing direction. This is an instant action that doesn't consume your turn movement.

Parameters:

• 'left': Rotate 90° counterclockwise
• 'right': Rotate 90° clockwise
• 'back': Rotate 180° (face opposite direction)

// Example: Turn right, then move forward
turn('right');
move('forward');

attack(mode)

Performs an attack in the direction you're facing. The available attack modes depend on your activeWeapon.

Parameters:

Weapon: Sword

Available modes:

Weapon: Spear

Available modes:

// Example: Scan for enemies, then attack
var vision = scan();
if (vision[7][4] === 'player') {
    attack('thrust'); // High damage single-target
} else if (vision[7][3] === 'player' || vision[7][5] === 'player') {
    attack('slash_center'); // AOE attack
}

Objects & Tile Types

Tile Types

Values returned by scan() matrix cells:

Entities

Dynamic objects that can appear in the vision matrix:

Code Examples

Basic Patrol

// Simple random movement
var dirs = ['forward', 'left', 'right'];
var rand = Math.floor(Math.random() * dirs.length);
move(dirs[rand]);

Aggressive Hunter

// Scan and attack nearby players
var vision = scan();
var foundEnemy = false;

// Check front row for enemies
for (var col = 0; col < 9; col++) {
    if (vision[7][col] === 'player') {
        attack('slash_center');
        foundEnemy = true;
        break;
    }
}

// If no enemy, move forward
if (!foundEnemy) {
    if (vision[7][4] === 'empty' || vision[7][4] === 'food') {
        move('forward');
    } else {
        turn('right');
    }
}

Food Collector

// Prioritize collecting food
var vision = scan();
var foodFound = false;

// Search for food in vision
for (var row = 0; row < 9; row++) {
    for (var col = 0; col < 9; col++) {
        if (vision[row][col] === 'food') {
            // Calculate direction to food
            var targetCol = col;
            if (targetCol < 4) {
                turn('left');
                move('forward');
            } else if (targetCol > 4) {
                turn('right');
                move('forward');
            } else {
                move('forward');
            }
            foodFound = true;
            break;
        }
    }
    if (foodFound) break;
}

// Default: random movement
if (!foodFound) {
    var dirs = ['forward', 'left', 'right'];
    move(dirs[Math.floor(Math.random() * dirs.length)]);
}

Defensive Fighter

// Defensive strategy: attack when threatened, otherwise collect resources
var vision = scan();

// Check immediate front for threats
if (vision[7][4] === 'player') {
    attack('thrust'); // High damage single attack
} else if (vision[7][3] === 'player' || vision[7][5] === 'player') {
    attack('slash_center'); // AOE to hit side enemies
} else if (vision[7][4] === 'food' || vision[7][4] === 'gold') {
    move('forward'); // Collect resources
} else if (vision[7][4] === 'empty') {
    move('forward'); // Safe to advance
} else {
    turn('left'); // Turn if blocked
}

Tips & Best Practices

• Always scan first: Use scan() at the beginning of each turn to assess your surroundings.
• Check boundaries: Before moving, verify the target tile is not a wall or out of bounds.
• Weapon selection: Choose your loadout wisely. Sword offers versatility, Spear offers range.
• Resource management: Collect food to restore HP and gold to increase your score.
• Facing matters: Your attacks and relative movements depend on your facing direction.
• Combine actions: You can turn() and move() in the same turn.

Hacker Royale IO - API Documentation v1.0