Update readme with new demo images and BattleMap support

README.md

@@ -1,11 +1,9 @@
-# WIP io_scene_a3d
+# io_scene_a3d
-Blender plugin to import the proprietary model format `A3D` used by the game [Tanki Online](https://tankionline.com/en/) from [Alternativa Games](https://alternativa.games/), it is not compatible with older the formats used by the flash based Alternativa3D engine (see [this plugin by Davide Jones](https://github.com/davidejones/alternativa3d_tools) instead).
+Blender plugin to import the proprietary model format `A3D` used by the game [Tanki Online](https://tankionline.com/en/) from [Alternativa Games](https://alternativa.games/), it is not compatible with older the formats used by the flash based Alternativa3D engine (see [this plugin by Davide Jones](https://github.com/davidejones/alternativa3d_tools) instead). The plugin can also import Tanki Online binary format maps: `map.bin`, both legacy maps and remaster maps work.
-
-## File format
-Check the wiki for file format documentation.
 
 ## Installation
-### Requirments: Blender version 4.2+
+### Requirements: Blender version 4.2+
+### Optional: io_scene_3ds plugin for importing legacy maps (non remaster)
 
 Firstly download the repository by clicking the "Code" button and then "Download ZIP".<br>
 ![step1](./images/step1.png)<br>
@@ -15,50 +13,34 @@ In blender, go to Edit > Preferences and click the "add-ons" button. From there
 
 Select the zip folder you downloaded and you should be good to go.
 
-## Demo
+## Showcase
-![A3D models used in a blender scene ready for render](./images/demo1.png)<br>
+![Demonstration showing textured tank hull models](./images/demo1.png)
-![UV and material surface showcase](./images/demo2.png)<br>
+![Demonstration showing models related to particle effects](./images/demo2.png)
-![Terrain mesh example](./images/demo3.png)
+![Demonstration showing remaster map importing](./images/demo3.png)
+![Demonstration showing legacy map collision meshes](./images/demo4.png)
 
 ## Status
-### Work in progress, the project is mostly complete for readonly file access.
+### .a3d
-### A3D1
+The plugin only supports importing models and supports loading the majority of A3D data:
-No support, I have never seen one of these files and 99.999% of people will only be using A3D2 and A3D3 files so there isn't much point supporting them.
+- Materials (color data imported but diffuse map is ignored as it is usually empty or references files that are not available to players)
-### A3D2
+- Mesh data (vertex positions, normals and UV channels)
-Full readonly support, not all data is imported into blender.
+- Material indices (each mesh can have multiple materials applied to it)
-#### Import
+- Object data (object hierarchy/parents, object names)
-- [x] Materials
+- Transform data (object position, scale, rotation)
-- diffuse map data is not used by the plugin because it references files that are only accessible if you work at Alternativa Games (such as texture `.psd` source files)
+
-- [x] Meshes
+The plugin only supports version 2 (map props) and version 3 (tank models) files, version 1 is not implemented because it is not currently used in game and I have never seen one of these files before.
-- - [x] Submesh data
+### map.bin
-- - [x] Coordinates
+The plugin can load Remaster and Legacy maps, legacy maps have incorrect transforms on some props due to the `.3ds` file plugin, not all data is required to import the files into blender, currently supported data is:
-- - [ ] Normals (data not imported into blender)
+- Static geometry (the visual aspect of the map)
-- - [x] UVs
+- Collision geometry (the collisions of the map)
-- - [ ] Vertex colour (data not imported into blender, not very useful anyway)
+- Spawnpoints (where tanks spawn)
-- - [ ] Smoothing groups
+The plugin also supports `lightmapdata` files that come with remaster maps, these files provide information about the lighting of the map:
-- [x] Transform
+- Sun angle and colour
-- [x] Object data
+- Ambient light colour
-#### Export
+- Object shadow settings (can the object recieve or cast shadows)
-- [ ] Materials
+- Lightmap UV coordinates (not imported)
-- [ ] Meshes
+- Lightmaps (not imported)
-- [ ] Transfoms
+- Lightprobes (not imported)
-- [ ] Objects
+
-### A3D3
+## File format
-Full readonly support, not all data is imported into blender.
+Check the wiki for file format documentation.
-#### Import
-- [x] Materials
-- diffuse map data is not used by the plugin because it references files that are only accessible if you work at Alternativa Games (such as texture `.psd` source files)
-- [x] Meshes
-- - [x] Submesh data
-- - [x] Coordinates
-- - [ ] Normals (data not imported into blender)
-- - [x] UVs
-- - [ ] Vertex colour (data not imported into blender, not very useful anyway)
-- - [ ] Boundbox (data not imported into blender, blender calculates its own boundbox data)
-- [x] Transforms
-- [x] Objects
-#### Export
-- [ ] Materials
-- [ ] Meshes
-- [ ] Transfoms
-- [ ] Objects