@rhyster/wow-casc-dbc 1.0.1

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2024 Rhyster
+
+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.

package/README.md

@@ -0,0 +1,36 @@
+# WoW CASC & DBC
+
+Node.js tool to fetch World of Warcraft data files from CASC and parse DBC/DB2 files.
+
+## Snippet
+
+```javascript
+// Get version
+const region = 'us';
+const product = 'wow';
+const version = await CASCClient.getProductVersion(region, product);
+
+// Client initialization
+const client = new CASCClient(region, product, version);
+await client.init();
+await client.loadRemoteTACTKeys();
+await client.loadRemoteListFile();
+
+// Fetch file
+const fileDataID = client.getFileDataIDByName('dbfilesclient/questxp.db2');
+const cKeys = client.getContentKeysByFileDataID(fileDataID);
+const cKey = cKeys.find((data) => !!(data.localeFlags & CASCClient.LocaleFlags.enUS));
+const { buffer } = await client.getFileByContentKey(cKey.cKey);
+
+// Parse DB2 file
+const reader = new WDCReader(buffer);
+const parser = new DBDParser(reader);
+
+// Access DB2 file
+// reader.getRowData
+// parser.getRowData
+```
+
+## License
+
+MIT License