MetaGPT/metagpt/environment
2025-02-28 14:55:52 +08:00
..
android fix bug 2025-02-28 14:55:52 +08:00
api del useless files 2024-03-28 23:19:32 +08:00
mgx add comments 2024-10-15 10:24:28 +08:00
minecraft fix conflicts 2025-02-26 22:20:14 +08:00
software rename folder 2024-03-28 21:10:55 +08:00
stanford_town fix circular dependency for role/env 2024-08-11 01:43:05 +08:00
werewolf fix bug 2025-02-28 14:55:52 +08:00
__init__.py remove default init of android env 2024-05-18 15:06:54 +08:00
base_env.py fix circular dependency for role/env 2024-08-11 01:43:05 +08:00
README.md update st_game using MG v0.7 2024-03-28 21:10:55 +08:00

Here is a environment description of MetaGPT env for different situation.
For now, the code only define the environment and still some todos like migrate roles/actions to current version.

Function

  • Define ExtEnv(Base Class) which help users to integrate with external environment like games through apis or construct the game logics.
  • Define Environment(Base Class) which is the env that MetaGPT directly used. And it includes roles and so on.
  • Define the EnvAPIRegistry to mark the read/write apis that ExtEnv provide observe/step ability. And then, users can call the particular one to get observation from env or feedback to env.

Usage

init environment

android_env = env.create(EnvType.ANDROID)

assistant = Role(name="Bob", profile="android assistant")
team = Team(investment=10.0, env=android_env, roles=[assistant])

observe & step inside role's actions

from metagpt.environment.api.env_api import EnvAPIAbstract

# get screenshot from ExtEnv
screenshot_path: Path = await env.observe(
            EnvAPIAbstract(
                api_name="get_screenshot", kwargs={"ss_name": f"{round_count}_before", "local_save_dir": task_dir}
            )
        )

# do a `tap` action on the screen
res = env.step(EnvAPIAbstract("system_tap", kwargs={"x": x, "y": y}))

TODO

  • add android app operation assistant under examples/android_assistant
  • migrate roles/actions of werewolf game from old version into current version
  • migrate roles/actions of minecraft game from old version into current version
  • migrate roles/actions of stanford_town game from old version into current version