Merge pull request game-by-virtuals#67 from stevensf1998/feat/update-readme

update read me

Author: celesteanglm

src/game_sdk/hosted_game/README.md

@@ -30,12 +30,18 @@ The SDK provides another interface to configure agents that is more friendly to
 ```python
 from game_sdk.hosted_game.agent import Agent
 
+
+
 # Create agent with just strings for each component
+> [!NOTE]
+> {{replyCount}} is a variable that will be replaced with the number of replies made by the agent. Only applicable for task_description.
+
 agent = Agent(
     api_key=VIRTUALS_API_KEY,
     goal="Autonomously analyze crypto markets and provide trading insights",
     description="HODL-9000: A meme-loving trading bot powered by hopium and ramen",
-    world_info="Virtual crypto trading environment where 1 DOGE = 1 DOGE"
+    world_info="Virtual crypto trading environment where 1 DOGE = 1 DOGE",
+    task_description="Process incoming tweet. Ignore if it is boring or unimportant. Total replies made: {{replyCount}}. Ignore if the conversation has gone too long."
 )
 ```
 
@@ -44,25 +50,43 @@ You can also initialize the agent first with just the API key and set the goals,
 ```python
 agent = Agent(api_key=VIRTUALS_API_KEY)
 
-# check what is current goal, descriptions and world_info
+# check what is current goal, descriptions, world_info and task_description
 agent.get_goal()
 agent.get_description()
 agent.get_world_info()
+agent.get_task_description()
 
-# Set components individually - set change the agent goal/description/worldinfo
+# Set components individually - set change the agent goal/description/worldinfo/task_description
 agent.set_goal("Autonomously analyze crypto markets and provide trading insights")
 agent.set_description("HODL-9000: A meme-loving trading bot powered by hopium and ramen")
 agent.set_world_info("Virtual crypto trading environment where 1 DOGE = 1 DOGE")
+agent.set_task_description("Process incoming tweet. Ignore if it is boring or unimportant. Total replies made: {{replyCount}}. Ignore if the conversation has gone too long.")
 
-# check what is current goal, descriptions and world_info
+# check what is current goal, descriptions, world_info and task_description
 agent.get_goal()
 agent.get_description()
 agent.get_world_info()
+agent.get_task_description()
 
 # set game engine model
 # Available models: llama_3_1_405b, deepseek_r1, llama_3_3_70b_instruct, qwen2p5_72b_instruct, deepseek_v3
 agent.set_game_engine_model("llama_3_1_405b")
 
+# Set heartbeat
+agent.set_main_heartbeat(15)
+agent.set_reaction_heartbeat(5)
+
+# check what is current heartbeat
+agent.get_main_heartbeat()
+agent.get_reaction_heartbeat()
+```
+
+### Worker
+
+You can add a worker to the agent. This is useful if you want to run a function on a specific worker.
+
+```python
+agent.add_worker(Worker(name="worker-twitter", description="worker for twitter", environment={"NODE_ENV": "production"}))
 ```
 
 ### Functions
@@ -97,6 +121,11 @@ search_function = game.Function(
             success_feedback="I found the best songs",
             error_feedback="I couldn't find the best songs",
         )
+        worker= Worker( # you can link a worker to the function
+            name="worker custom search internet",
+            description="worker for custom search internet",
+            environment={"NODE_ENV": "production"}
+        )
     )
 
 # adding custom functions only for platform twitter
@@ -205,4 +234,7 @@ pin_message_fn("xxxxxxxx", "xx", "True")
 agent.add_custom_function(reply_message_fn)
 agent.add_custom_function(create_poll_fn)
 agent.add_custom_function(pin_message_fn)
+
+# reset memory
+agent.reset_memory()
 ```