📝 #62 add map doc

Signed-off-by: JAGFx <contact@jagfx.fr>
JAGFx · Apr 25, 2021 · a9b4c04 · a9b4c04
1 parent 589b07e
commit a9b4c04
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ This project was based on the [TruckSim-Telemetry-Demo](https://github.com/kniff
 
 ![Screenshot](doc/screens/demo.gif)
 
-This project have also a Map integration. [See here](#maps)
+This project have also a Map integration. [See here](./doc/MAP.md)
 
 You can check also a review and installation guide made
 by [Neranjana Wijesinghe](https://www.youtube.com/playlist?list=PLJONr1a8YX5Tyw-i49yk2jYTAFJJ5h7fw)
@@ -43,6 +43,21 @@ A event overlay can also be configured !
 
 It's work on desktop and mobile browser.
 
+## Map
+
+|Map|Game|Version|Download|
+|---|---|---|---|
+|Base|Euro Truck Simulator 2|v1.40.3.3|Download|
+|Base|American Truck Simulator (1)|v1.40.3.3|-|
+|Promod|Euro Truck Simulator 2 (1) (2)|v2.50|-|
+|Promod Canada|American Truck Simulator (1) (2)|v2.50|-|
+
+> (1) Not yet available
+>
+> (2) Not required on self-hosting
+
+More information on the [Map](./doc/MAP.md) readme
+
 ## Requirements
 
 - OS: Windows 64Bits
@@ -129,34 +144,6 @@ And that's it :D
 
 > Tip: You can save a shortcut on your home screen to use it as an app like.
 
-### Maps
-
-#### Supported game / mod
-
-| Map / Mod | Supported ? | Latest version |
-|---|---|---|
-|ETS2 base map|YES|v1.38|
-|Promod ETS|Not tested|--|
-|ATS base map|YES|v1.38|
-|Promod ATS|Not tested|--|
-
-The map feature need tiles collection. You've two way to get this tiles:
-
-- **Remotly**, you don't need to download anything. But you need an internet connexion
-- **Localy**, you **NEED** to download the tiles collection. See below.
-
-Download tiles collection for the local use:
-
-1. Download the [`vanilla`](https://ets2.jagfx.fr/maps.vanilla.tar.gz) and
-   or [`promod`](https://ets2.jagfx.fr/maps.promod.tar.gz) tiles collection
-2. Extract them into the folder of your installation folder. Final path example: `ETSDashFolder/maps/vanilla/...`
-3. Set the `Tiles location` (Menu > Config > Map's options > Map > Tile location) to `Local`
-4. Restart the app
-5. And that's it !
-
-> Please note all tiles was picked up from [mike-koch / ets2-mobile-route-advisor](https://github.com/mike-koch/ets2-mobile-route-advisor). I'm not (yet) able to generate tiles for ETS2 (Base map and Promod map) or ATS (Base map or Promod). I've not all the DLC for it. If you're interested to participate, send me a message.
->
-> I'm work on side project to be able to update map tiles myself.
 
 ## Know issues
 

diff --git a/doc/CONFIG_SETTINGS.md b/doc/CONFIG_SETTINGS.md
@@ -702,7 +702,7 @@ You can find common elements, and skin config.
         <td>true</td>
     </tr>
     <tr>
-        <td>maps_map_tilesLocations</td>
+        <td>maps_map_tilesLocation</td>
         <td>Tiles location</td>
         <td>
             <ul>
@@ -713,16 +713,38 @@ You can find common elements, and skin config.
         <td>remote</td>
     </tr>
     <tr>
-        <td>maps_map_activeMap</td>
-        <td>Active map</td>
+        <td>maps_map_type</td>
+        <td>Kind of map</td>
         <td>
             <ul>
                 <li>vanilla</li>
-                <li>promods</li>
+                <li>mod</li>
             </ul>
         </td>
         <td>vanilla</td>
     </tr>
+    <tr>
+        <td>maps_map_tilesRemotePath</td>
+        <td>Custom remote tiles location</td>
+        <td>
+            N/A
+        </td>
+        <td>https://ets.jagfx.fr</td>
+    </tr>
+    <tr>
+        <td>maps_map_activeMap</td>
+        <td>Active map</td>
+        <td>
+            <ul>
+                <li>null</li>
+                <li>ets</li>
+                <li>ats</li>
+                <li>promod</li>
+                <li>promod-ca</li>
+            </ul>
+        </td>
+        <td>null</td>
+    </tr>
     <tr>
         <td>maps_map_navigationRemaining</td>
         <td>Navigation ETA</td>
@@ -737,7 +759,7 @@ You can find common elements, and skin config.
 
 </table>
 
-> Note: When the `maps_map_tilesLocations` is set to `local`, you need to download the tiles collection. See the main README.
+> Note: When the `maps_map_tilesLocations` is set to `local`, you need to download the tiles collection. See the [MAP](./MAP.md) README.
 
 ---
 ↩️ [Home](../README.md)
diff --git a/doc/FEATURES.md b/doc/FEATURES.md
@@ -119,8 +119,7 @@ Currently, I'm introduced the map with some navigation data only. Not the full r
 
 #### Map support
 
-- Vanilla map (ETS & ATS)
-- Promod map (Promod for ETS & Promod Canada)
+See the [Map](./MAP.md) section
 
 #### Available configuration
 
@@ -132,9 +131,7 @@ To know all available configurations, see the `CONFIG_SETTINGS.md`
 
 #### Additionnal setup
 
-You can choos to load the tiles map from a remote (by default) or choice to load it from your computer.
-
-See the main `README.md` to know how :D
+See the [Map](./MAP.md) section
 
 ---
 ↩️ [Home](../README.md)
diff --git a/doc/MAP.md b/doc/MAP.md
@@ -19,11 +19,20 @@ On this section, you can retrieve the following information:
 
 ## Usage
 
-To use the map skin, you need a map tiles collection. This collection may be use from:
+The map feature need tiles collection. You've three way to get this tiles:
 
-- Local: On your machine
-- Default remote: Collection hosted on a remote by me
-- Your remote: Self-hosted
+- **Default remote**, you don't need to download anything. But you need an internet connexion
+- **Self-hosted remote**, you can use your own remote.
+- **Localy**, you **NEED** to download the tiles collection. See below.
+
+Download tiles collection for the local use:
+
+1. Download the [`vanilla`](https://ets2.jagfx.fr/maps.vanilla.tar.gz) and
+   or [`promod`](https://ets2.jagfx.fr/maps.promod.tar.gz) tiles collection
+2. Extract them into the folder of your installation folder. Final path example: `ETSDashFolder/maps/vanilla/...`
+3. Set the `Tiles location` (Menu > Config > Map's options > Map > Tile location) to `Local`
+4. Restart the app
+5. And that's it !
 
 ### Default
 
@@ -111,6 +120,16 @@ only: [JAGFx / ts-map](https://github.com/JAGFx/ts-map).
 
 Follow the instruction in `Generation` section.
 
+#### Example
+
+You can use `http-server` to host a local tiles collection
+
+````bash
+$ http-server ./maps -p 8081 --cors -s
+````
+
+And then set the `Custom remote tiles location` to `http://localhost:8081`
+
 ## Generation
 
 SOON