Update README.md

README.md

@@ -52,7 +52,7 @@ SimWorld is built on Unreal Engine 5 and offers core capabilities to meet the ne
 **SimWorld** consists of three layers:
 - the Unreal Engine Backend, providing diverse and open-ended environments, rich assets and realistic physics simulation;
 - the Environment layer, supporting procedural city generation, language-driven scene editing, gym-like APIs for LLM/VLM agents and traffic simulation;
-- the Agent layer, enabling LLM/VLM agents to reason over multimodal observations and history while executing actions via a local action planner;
+- the Agent layer, enabling LLM/VLM agents to reason over multimodal observations and history while executing actions via a local action planner.
 
 SimWorld's architecture is designed to be modular and flexible, supporting an array of functionalities such as dynamic world generation, agent control, and performance benchmarking. The components are seamlessly integrated to provide a robust platform for **Embodied AI** and **Agents** research and applications.
 
@@ -69,9 +69,11 @@ simworld/               # Python package
     map/                # Basic map class and waypoint system
     traffic/            # Traffic system
     utils/              # Utility functions
+    data/               # Default data files, e.g., object categories
+    weather/            # Weather system
 data/                   # Necessary input data
 config/                 # Example configuration file and user configuration file
-scripts/                # Examples of usage, such as layout generation and traffic simulation
+examples/                # Examples of usage, such as layout generation and traffic simulation
 docs/                   # Documentation source files
 README.md
 ```
@@ -89,17 +91,16 @@ pip install -e .
 ```
 
 + UE server
-Download the SimWorld server executable from S3:
+Download the SimWorld server executable from huggingface. Choose the version according to your OS and the edition you want to use.
 
 We offer two versions of the SimWorld UE package: the base version, which comes with an empty map, and the additional environments version, which provides extra pre-defined environments for more diverse simulation scenarios. Both versions include all the core features of SimWorld.
 
 | Platform | Package | Scenes/Maps Included | Download | Notes |
 | --- | --- | --- | --- | --- |
-| Windows | Base | Empty map for procedural generation | [Download (Base)](https://simworld-release.s3.us-east-1.amazonaws.com/SimWorld-Win64-v0_1_0-Foundation.zip) | Full agent features; smaller download. |
-| Windows | Additional Environments | 100+ maps (including the empty one) | [Download (100+ Maps)](https://simworld-release.s3.us-east-1.amazonaws.com/SimWorld-Win64-v0_1_0-100Maps.zip) | Full agent features; larger download. |
-| Linux | Base | Empty map for procedural generation | [Download (Base)](https://simworld-release.s3.us-east-1.amazonaws.com/SimWorld-Linux-v0_1_0-Foundation.zip) | Full agent features; smaller download. |
-| Linux | Additional Environments | 100+ maps (including the empty one) | [Download (100+ Maps)](https://simworld-release.s3.us-east-1.amazonaws.com/SimWorld-Linux-v0_1_0-100Maps.zip) | Full agent features; larger download. |
+| Windows | Base | Empty map for procedural generation | [Download](https://huggingface.co/datasets/SimWorld-AI/SimWorld/resolve/main/Base/Windows.zip) | Full agent features; smaller download. |
+| Linux | Base | Empty map for procedural generation | [Download](https://huggingface.co/datasets/SimWorld-AI/SimWorld/resolve/main/Base/Linux.zip) | Full agent features; smaller download. |
 
+Additional environment paks are available on the [environments paks page](https://huggingface.co/datasets/SimWorld-AI/SimWorld/tree/main/AdditionEnvironmentPaks). You may download them as needed according to the OS you are using.
 
 **Note:**
 1. Please check the [documentation](https://simworld.readthedocs.io/en/latest/getting_started/additional_environments.html#usage) for usage instructions of the **100+ Maps** version.
@@ -116,7 +117,7 @@ SimWorld uses YAML-formatted configuration files for system settings. The defaul
 - `simworld/config/default.yaml` serves as the default configuration file.
 - `config/example.yaml` is provided as a template for custom configurations.
 
-Users can switch between different configurations by specifying a custom configuration file path through the `Config` class:
+Users can switch between different configurations by specifying a custom configuration file path through the `Config` class.
 
 To set up your own configuration:
 
@@ -125,7 +126,7 @@ To set up your own configuration:
    cp config/example.yaml config/your_config.yaml
    ```
 
-2. Modify the configuration values in `your_config.yaml` according to your needs
+2. Modify the configuration values in `your_config.yaml` according to your needs.
 
 3. Load your custom configuration in your code:
    ```python
@@ -161,11 +162,6 @@ from simworld.llm.base_llm import BaseLLM
 from simworld.local_planner.local_planner import LocalPlanner
 from simworld.llm.a2a_llm import A2ALLM
 
-
-# Connect to the running Unreal Engine instance via UnrealCV
-ucv = UnrealCV()
-comm = Communicator(ucv)
-
 class Agent:
     def __init__(self, goal):
         self.goal = goal
@@ -228,8 +224,11 @@ class Environment:
 
         return observation, reward
 
-
 if __name__ == "__main__":
+    # Connect to the running Unreal Engine instance via UnrealCV
+    ucv = UnrealCV()
+    comm = Communicator(ucv)
+
     # Create the environment wrapper
     agent = Agent(goal='Go to (1700, -1700) and pick up GEN_BP_Box_1_C.')
     env = Environment(comm)
@@ -242,4 +241,8 @@ if __name__ == "__main__":
         obs, reward = env.step(action)
         print(f"obs: {obs}, reward: {reward}")
         # Plug this into your RL loop / logging as needed
-```
+```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=SimWorld-AI/SimWorld&type=date&legend=bottom-right)](https://www.star-history.com/#SimWorld-AI/SimWorld&type=date&legend=bottom-right)