prokki/warlight2-bot-template

Bot template for Warlight AI Challenge 2

0.4.0 2017-03-14 16:15 UTC

This package is auto-updated.

Last update: 2024-04-29 03:47:34 UTC


README

License Packagist Minimum PHP Version

This is a php bot template for Warlight AI Challenge 2 (http://theaigames.com/competitions/warlight-ai-challenge-2).

Note: The project is in beta stage. Feel free to report any issues you encounter.

Installation

Composer

Create a new project and install the template via Composer using the following command:

composer require prokki/warlight2-bot-template

Usage

Create Your Own Bot

Create your own bot by inherit from the Prokki\Warlight2BotTemplate\AIBot class. To ensure the bot is responding correctly the class has to implement the Prokki\Warlight2BotTemplate\Bot\AI interface.

Following methods has to be overridden:

use Prokki\TheaigamesBotEngine\Bot;

class AIBot implements Bot, AI
{
    /**
     * Returns the pick move of the region to pick.
     *
     * These moves are going to build the response to the request `pick_starting_region` - see {@see \Prokki\Warlight2BotTemplate\Command\PickStartingRegionCommand}.
     *
     * @param integer[] $region_ids
     *
     * @return PickMove|null
     */
    public function getPickMove($region_ids)
    {
        // put your code here
    }

    /**
     * Returns all place moves.
     *
     * These moves are going to build the response to the request `go place_armies` - see {@see \Prokki\Warlight2BotTemplate\Command\GoPlaceArmiesCommand}.
     *
     * @return PlaceMove[]
     */
    public function getPlaceMoves();
    {
        // put your code here
    }

    /**
     * Returns all attack and transfer moves.
     *
     * These moves are going to build the response to the request `go attack/transfer` - see {@see \Prokki\Warlight2BotTemplate\Command\GoAttackTransferCommand}.
     *
     * @return TransferMove[]|AttackMove[]
     */
    public function getAttackTransferMoves();
    {
        // put your code here
    }
}

Customize Game Classes

To add heuristic data, static data or other custom data for your invincible bot, you can add custom classes to manage additional information. But instead of adding extra classes the bot engine provides a better way to add custom information for your bot: You can extend game related base classes with own properties and methods.

The \Prokki\TheaigamesBotEngine\Game\EnvironmentFactory implements the factory pattern to create all game related objects with one class. Overriding this class gives you the power to use custom classes with custom properties.

Take a look to example Prokki\Warlight2BotTemplate\Example\StupidRandomBot for further information.

Links