Add readme

ModernWoWTools · Aug 1, 2024 · e6e5229 · e6e5229
1 parent 217cd32
commit e6e5229
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# ADTMeta
+Automatically dumps Texture and GroundEffect metadata from World of Warcraft ADT files into a JSON format and saves it to the [Meta](Meta) folder.
+
+## Generated Metadata
+### Retail
+#### Texture
+- [Texture info by texture file id](Meta/wow/Texture/TextureInfoByTextureFileID.json)
+- [Texture info by texture file path](Meta/wow/Texture/TextureInfoByTextureFilePath.json)
+
+#### GroundEffects
+- [GroundEffects by texture file id](Meta/wow/GroundEffect/GroundEffectByTextureFileID.json)
+- [GroundEffects by texture file path](Meta/wow/GroundEffect/GroundEffectByTextureFilePath.json)
+
+## Usage
+Arguments: `ADTMeta.exe <product> (metaFolder)`  
+