Agent
To access the Configs tab, you’ll need the project-view-configs permission,
which is available to users with the Config Manager role or other roles that
include this permission.
This section shows all your AI Agent configurations. You can create new configs or edit existing ones.
AI Agent Config
Each AI Agent config has three parts: Basic Configuration, Tools, and Hint Manual.
Basic Configuration
- game configuration: A brief description of your game. Provide essential information about your game that the AI Agent should understand. Keep this concise, ideally no longer than five sentences.
- keymap configuration: Documentation of the primary controls and input mapping for your game. While optional, this is particularly helpful for PC games as it prevents the AI Agent from having to rediscover the controls each time.
- environment timing: The minimum duration the AI Agent interacts with the game (environment) in each step. After completing a step, we immediately plan the next action. For games with animations that play after an action (such as after pressing a “collect reward” button), increasing this timing ensures these animations finish before the next action is determined.
- recording mode: Choose whether to record the test run. Some users disable this for performance testing to eliminate even minimal overhead. Keep in mind that recording also requires additional data storage.
Tools
The AI Agent is allowed to use tools - Check out AI Agent for more information. We currently only support the compendium tool, which serves as an external knowledge base that the AI agent is allowed to query.
Your tool name and description should be very precise and explain to the AI Agent what and when it should query your compendium to get an answer.
Hint Manual
Hints are a powerful way of providing information to the AI Agent. The Hints you provide here in the Agent Config are project-wide and apply to all tests (given the hint key regex matches).
Read the Providing Necessary Information section.
Hint Key
The hint key is an advanced feature that helps deliver context-specific hints. For example, if you have different hints for level 1 and level 2, you want the AI Agent to receive only the relevant hints for the level it’s currently playing. To accomplish this, add a hint_key field in your game state that identifies the player’s current location or context (like level_1_first_boss). In the hint manual, you can then specify a Regex pattern that matches this hint_key. When the pattern matches, only then will those specific hints be provided to the AI Agent.
Additional information about the hint_key is available in the SDK
Integration -> Game State
section.
Examples
Pattern: ^level_1_.*$ - Matches: level_1_start, level_1_boss -
Doesn’t Match: level_2_start, tutorial - Use Case: Provide hints
specific to all areas in Level 1 Pattern: .*boss.* - Matches:
level_1_boss, final_boss_arena - Doesn’t Match: level_1_start,
hub_world - Use Case: Provide combat hints for any boss encounter
Pattern: ^tutorial$ - Matches: tutorial - Doesn’t Match:
tutorial_end, not_tutorial - Use Case: Provide hints only for the
exact tutorial section
Pattern: .*crafting.* - Matches: crafting_table,
advanced_crafting - Doesn’t Match: combat, inventory - Use Case:
Provide hints when player is at any crafting station Pattern:
^(shop|market|vendor).*$ - Matches: shop, market_district,
vendor_alley - Doesn’t Match: combat_shop, not_a_shop - Use
Case: Provide economy/shopping hints in commercial areas Pattern:
^puzzle_\d+$ - Matches: puzzle_1, puzzle_42 - Doesn’t Match:
puzzle_room, not_puzzle_1 - Use Case: Provide specific hints for
numbered puzzles
Pattern: ^(combat|battle)_(easy|medium|hard)$ - Matches:
combat_easy, battle_hard - Doesn’t Match: combat_tutorial,
battle - Use Case: Provide difficulty-specific combat hints
Pattern: ^.*_(locked|inaccessible)$ - Matches: door_locked,
chest_inaccessible - Doesn’t Match: locked_room, door_open - Use
Case: Provide hints for any locked or inaccessible objects Pattern:
^(npc|character)_dialogue_[a-z]+$ - Matches: npc_dialogue_merchant,
character_dialogue_quest - Doesn’t Match: dialogue_npc,
npc_merchant - Use Case: Provide conversation hints for specific NPC
types