gameboy_worlds

 1"""
 2Documentation for the <img src="https://dhananjayashok.github.io/GameBoyWorlds/assets/logo_tilt.png" width="70px"> package.
 3
 4### Navigating the Documentation
 5This page and some of the nested links will look a bit empty, but rest assured, the documentation is there. You just need to look for it a little.
 6There are two ways to navigate the documentation:
 71. **Sidebar Navigation**: Use the sidebar on the left to explore different modules. Expand the sections to find detailed documentation.
 82. **Search Functionality**: Use the search bar at the top of the sidebar to quickly find specific classes, methods, or keywords within the documentation.
 9
10### Package Structure
11* `emulation` is the "root" of this project. It handles GameBoy emulation, allows users to parse the game state, and tracks relevant game state information at every step of gameplay. Look here if you want to:
12    - Parse the game state to extract relevant information (e.g. Player location, current party, inventory items).
13    - Check for specific triggers or events in the game (e.g. Did the player open the menu? Did the player enter a battle?).
14    - Track specific metrics or information over multiple steps of gameplay (e.g. Number of regions visited, number of battles won, etc).
15    - Change how the game is run (e.g. automatically skip dialogues and cutscenes, etc).
16* `interface` is where we create the actions that agents can take in the game (e.g. `Seek(looking for prof oak, npc)` that tries to locate an NPC on the screen, determine which one is prof oak, move towards him and then interact with him, all in one command). The submodule also has the Gym API integration which allows us to train RL agents on top of the game. Look here if you want to:
17    - Create new high level actions, which compose multiple button presses into a single action. These actions can use VLMs to help guide their behavior (e.g. using VLMs to determine which grid cell of the screen contains the target object to interact with).
18    - Create new environments or test scenarios, with different observation spaces, reward functions, and termination conditions for the game.
19
20
21### Notable API Imports
22**Utils Submodule:**
23* `get_benchmark_tasks`: Function to get benchmark tasks for evaluating agents in different game variants.
24* `get_benchmark_tasks_dfs`: Function to get benchmark tasks for evaluating agents in different game variants.
25* `get_train_games`: Function to get a list of available game variants for training agents.
26
27**Emulation Submodule:**
28* `AVAILABLE_GAMES`: List of available game variants supported by the package.
29* `get_emulator`: Factory function to get an emulator instance for a specified game variant.
30* `get_available_init_states`: Function to get a list of available initial states for a specified game variant.
31* `clear_tmp_sessions`: Function to clear temporary emulator sessions.
32
33**Interface Submodule:**
34* `AVAILABLE_BENCHMARKS`: List of available benchmark modules for evaluating agents.
35* `get_environment`: Factory function to get an environment instance for a specified game variant and environment variant.
36* `get_test_environment`: Function to create a test environment based on a benchmark task.
37* `get_training_environments_kwargs`: Function to get keyword arguments for creating training environments for a specified game variant.
38* `get_shifted_environments_kwargs`: Function to get keyword arguments for creating shifted environments for domain adaptation experiments.
39
40"""
41
42from gameboy_worlds.utils import (
43    get_train_games,
44    get_benchmark_tasks_dfs,
45    get_benchmark_tasks,
46    get_training_states,
47    get_all_training_states,
48    get_shifted_training_states,
49    get_all_shifted_training_states,
50)
51
52from gameboy_worlds.emulation.registry import (
53    AVAILABLE_GAMES,
54    get_emulator,
55    get_available_init_states,
56)
57from gameboy_worlds.interface.registry import (
58    AVAILABLE_BENCHMARKS,
59    get_environment,
60    get_test_environment,
61    get_training_environments_kwargs,
62    get_shifted_environments_kwargs,
63)
64from gameboy_worlds.emulation import clear_tmp_sessions