chore: clean files + add readme on example

Author: vincent4vx

.gitattributes

@@ -0,0 +1,3 @@
+.github export-ignore
+example export-ignore
+tests export-ignore

composer.json

@@ -13,8 +13,7 @@
         "php": "~8.4",
         "ext-imagick": "*",
         "ext-gd": "*",
-        "arakne/swf": "^0.2.2",
-        "workerman/workerman": "~5.1"
+        "arakne/swf": "^0.2.2"
     },
     "require-dev": {
         "phpunit/phpunit": "~12.0",

example/worldmap/.env

@@ -2,4 +2,6 @@ DB_DSN=mysql:host=172.17.0.1;dbname=araknemu
 DB_USER=araknemu
 DB_PASSWORD=araknemu
 DOFUS_PATH=/srv/data/dofus
-MAPS_PATH=/srv/data/maps
+MAPS_PATH=/srv/data/maps
+LISTEN_PORT=80
+WORKER_COUNT=8

example/worldmap/README.md

@@ -0,0 +1,80 @@
+# WorldMap Viewer
+
+This example provides a simple application with:
+- Incarnam and Amakna worldmap viewer using Leaflet.js
+- Shows teleportation cells on maps
+- Display a single map
+
+It uses database from [Araknemu](https://github.com/Arakne/Araknemu).
+
+## Installation (using docker)
+
+Retrieve all necessary assets:
+- Setup the araknemu database
+- Download and extract the Dofus 1.29 client
+- Download and extract the dofus maps
+
+Configure the `.env`:
+
+```bash
+# Configure the DB connection to your araknemu database
+# Don't forget that the database must be accessible from the docker container
+DB_DSN=mysql:host=172.17.0.1;dbname=araknemu
+DB_USER=araknemu
+DB_PASSWORD=araknemu
+
+# Do not change paths: they are mounted from the host to the container
+DOFUS_PATH=/srv/data/dofus
+MAPS_PATH=/srv/data/maps
+
+# Docker allows to bind ports from the host to the container
+# So port 80 is fine in this case
+LISTEN_PORT=80
+
+# Number of worker processes
+# Consider setting this to the number of CPU cores you have on small traffics
+# Or the double on high traffics
+# Note: higher number of workers means more memory usage (one process = ~200MB)
+WORKER_COUNT=8
+```
+
+Create a `docker-compose.override.yml` file:
+
+```yaml
+services:
+    php:
+        restart: unless-stopped
+        
+        # Map the dofus client and maps from the host to the container
+        # Also keep the cache as persistent volume, so it will not be rebuilt at each container restart
+        volumes:
+            - ./dofus/client/path:/srv/data/dofus:ro
+            - ./dofus/maps/path:/srv/data/maps:ro
+            - ./cache:/srv/cache
+```
+
+Now you can build and start the container:
+
+```bash
+docker-compose build
+docker-compose up -d
+```
+
+To optimise the cache, you can pre-generate the map tiles:
+
+```bash
+docker-compose exec php php index.php warmup
+```
+
+> [!NOTE]
+> The `exec` command runs a command inside the running container, so make sure the container is running before executing it.
+> Use `run` instead of `exec` if you want to run it in a new container.
+
+You can now access the application at [http://127.0.0.1:5000/](http://127.0.0.1:5000/) (or your server IP if not running locally).
+
+## Screenshot
+
+![Amakna worldmap](./screen/amakna-worldmap.png)
+![Incarnam worldmap](./screen/incarnam-worldmap.png)
+![Amakna worldmap zoom](./screen/amakna-zoom.png)
+![Map view](./screen/showmap.png)

example/worldmap/index.php

@@ -18,8 +18,8 @@
     exit(0);
 }
 
-$worker = new \Workerman\Worker('http://0.0.0.0:80');
-$worker->count = 16;
+$worker = new \Workerman\Worker('http://0.0.0.0:' . (getenv('LISTEN_PORT') ?: '80'));
+$worker->count = (int) (getenv('WORKER_COUNT') ?: 4);
 
 $worker->onMessage = function (TcpConnection $connection, Request $request) use ($app) {
     $app->run($request->path(), $request->get(), function (string $data, array $headers = []) use ($connection) {

example/worldmap/screen/amakna-worldmap.png

@@ -74,6 +74,7 @@ function (string $name, int $current, int $total) {
                 echo sprintf("[Amakna] Building %s (%d/%d)\n", $name, $current, $total);
             },
         );
+
         echo "Warming up Incarnam...\n";
         $this->incarnam->warmup(
             function (string $name, int $current, int $total) {