Get action: ref data

Reference data is data that doesn't change throughout the game, but is needed for the bot to calculate its actions.

Examples

Wordle

Wordle game

In a word game like Wordle where the bot needs to guess a 5 letter word, the bot needs to know a list of all 5 letter words. Here is ref_data.json for Wordle. The proto schema for it is:

message refData {
  repeated string words = 1;
}

The bot can access ref_data by:

Python

def get_action(state, ref_data, api):
    words = ref_data["words"]
    # ... Pick from one of these words

Javascript

function getAction({state, refData, api}) {
  let words = refData["words"];
  // ... Pick from one of these words
}

Risk

A game involving a map

This game has a more complex example of ref_data.json. This map does not change throughout the game. A bot needs to know which areas are connected to determine what actions it should take.