Catching up

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["@babel/preset-env", { "targets": { "node": "current" } }]]
+}

.github/workflows/docker.yml

@@ -12,20 +12,20 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Docker Build
         id: buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}    
 
       - name: Build image and push to Docker Hub and GitHub Container Registry
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
         with:
           context: .
           tags: sandermertens/flecs.explorer:latest 

.gitignore

@@ -1,5 +1,6 @@
 .bake_cache
 .DS_Store
 .vscode
+.claude
 gcov
 bin

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Flecs Hub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,9 @@
 # Flecs Explorer
 Web-based UI for monitoring Flecs applications, trying out queries & learning ECS
 
-<img width="995" alt="Screen Shot 2021-11-07 at 10 20 51 PM" src="https://user-images.githubusercontent.com/9919222/140693729-12b9c7bb-3147-4040-9c15-d830e9bc1080.png">
+<img width="1981" height="1202" alt="Screenshot 2025-09-12 at 5 35 23 PM" src="https://github.com/user-attachments/assets/604275d4-d7dd-4434-a847-51b675f0e0ef" />
+
+<img width="1983" height="1206" alt="Screenshot 2025-09-12 at 5 48 15 PM" src="https://github.com/user-attachments/assets/e4d59ce4-eb7a-47da-9cb4-2e0bbf31ba5e" />
 
 A live version of the explorer is running @ https://flecs.dev/explorer
 
@@ -16,7 +18,7 @@ In C:
 ecs_singleton_set(world, EcsRest, {0});
 ```
 
-In C with the flecs app addon:
+In C with the app addon:
 ```c
 ecs_app_run(world, &(ecs_app_desc_t) {
   .enable_rest = true
@@ -28,6 +30,13 @@ In C++:
 world.set<flecs::Rest>({});
 ```
 
+In C++ with the app addon:
+```cpp
+world.app()
+  .enable_rest()
+  .run();
+```
+
 When the application is running, verify that the server works by going to:
 http://localhost:27750/entity/flecs
 
@@ -72,6 +81,35 @@ docker run --name=explorer -p 80:80 --restart=unless-stopped -d sandermertens/fl
 
 You can now go to http://localhost to open the explorer.
 
+### Statistics
+The explorer can visualize statistics from Flecs applications. Statistics collection is disabled by default as it is not free. To enable it, import the `flecs.monitor` module:
+
+In C:
+```c
+ECS_IMPORT(world, FlecsMonitor);
+```
+
+In C++:
+```c
+world.import<flecs::monitor>();
+```
+
+Note that the statistics collection systems run as part of the default Flecs pipeline. If your application does not use systems, manually runs systems or uses a custom pipeline statistics collection will not run. To make sure the collection systems are ran, call this once in the main loop of your game:
+
+In C:
+```c
+ecs_progress(world, 0);
+```
+
+In C++
+```c
+world.progress();
+```
+
+You should now be able to see statistics in the explorer, which should look like this:
+
+<img width="1983" height="1206" alt="Screenshot 2025-09-12 at 5 49 11 PM" src="https://github.com/user-attachments/assets/108d5003-ef79-46d4-88c7-9f8eb13cd8a5" />
+
 ### URL options
 The following options can be added to the URL: