Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@skarndev
skarndev authored Apr 27, 2020
1 parent b08cd03 commit c15b832
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,29 @@
[![Build Status](https://travis-ci.org/WowDevTools/pywowlib.svg?branch=master)](https://travis-ci.org/WowDevTools/pywowlib)

**pywowlib** is a Python 3.5+ libary featuring the functionality of reading and writing various World of Warcraft related file formats.
The goal of the library is to initially target 3 WoW versions: 3.3.5a, 7.3.5, retail.
In the future, we may target other core expansion versions: 1.12, 2.4.3, 4.3.4, 5.4.8, 6.2.4
The goal of the library is to initially target core WoW versions (latest expansion patch) starting from 3.3.5a and beyond up to current retail/beta version.
In the future, we may target other core expansion versions: 1.12.1, 2.4.3
Support for in-between versions is not guaranteed, but may work just fine, depending on the case.

# Supported formats

| Format | Description | 3.3.5a | 7.3.5 | retail | Comment |
|-------- |---------------------------- |------------- |--------------- |--------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| M2 | Model | ✔ | % | % | Legion+ is supported for most structs, but the overall Legion+ workflow is not setup yet |
| Skin | M2 LOD file | ✔ | ✔ ? | ✔ ? | |
| Anim | M2 Animation | ✔ | % | % | Since in Legion+ the file is no longer just raw bytes, that needs to be handled. |
| Skel | M2 Skeleton / Animation | - | ✔ ? | ✔ ? | Legion+ is supported for most structs, but the overall Legion+ workflow is not setup yet |
| Phys | M2 Physics | - | TBI | TBI | |
| Bone | M2 Bones | - | TBI | TBI || |
| WMO | World Map Object | ✔ | ✔ ? | ✔ ? | Legion+ is missing a few new chunks, otherwise it is supported. |
| ADT | Terrain Tile | TBI | TBI | TBI | By this category, _tex.adt and other additional ADT-related files are implied as well. |
| WDT | World Terrain Layout | TBI | TBI | TBI | |
| WDL | Lowres Terrain | TBI | TBI | TBI | |
| MPQ | Storage | ✔ | - | - | Writing can be implemented by extending StormLib Python wrapper that we are using. |
| CASC | Storage (multiple formats) | - | ✔ | ✔ | Read-only. CASCHost integration is planned.|
| BLP | Images | ✔ | ✔ | ✔ | Read only |
| DBC / DB2 | DBFilesClient | ✔ | % | % | |
| Format | Description | 1.12.1 | 2.4.3 | 3.3.5a | 4.3.4 | 5.4.8 | 6.2.4 | 7.3.5 | 8.3.5 | 9.0.0 | Comment
|--|--|--|--|--|--|--|--|--|--|--|--|
| M2 | Model | % | % | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | % | Possibly not handling some changes brought with Shadowlands. Missing names for some key bones.
| Skin | M2 Lod File | DNE | DNE | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | % | Shadowlands mesh part IDs are not yet mapped.
| Anim | M2 Low Priority Animation Sequence | DNE | DNE | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Skel | M2 Skeleton Data | DNE | DNE | DNE | DNE | DNE | DNE | ✔ | ✔ | ✔ |
| Phys | M2 Physics | DNE | DNE | DNE | DNE | TBI | TBI | TBI | TBI | TBI |
| Bone | M2 FacePose Transform Data | DNE | DNE | DNE | DNE | DNE | TBI | TBI | TBI | TBI |
| WMO | World Map Object | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | Some changes need to be added to reflect WotLK+ changes.
| ADT | Terrain Tile | % | % | ✔ | TBI | TBI | TBI | TBI | TBI | TBI | By this category, _tex.adt and other additional ADT-related files are implied as well. Support for WotLK was never tested. Likely to be broken and thus reimplemented later.
| WDT | World Terrain Layout | TBI | TBI | TBI | TBI | TBI | TBI | TBI | TBI | TBI |
| WDL | Low Res Terrain | TBI | TBI | TBI | TBI | TBI | TBI | TBI | TBI | TBI |
| MPQ | Mike O'Brien Pack | ✔ | ✔ | ✔ | ✔ | ✔ | DNE | DNE | DNE | DNE | Support for writing may be implemented by extending the StormLib wrapper. Contributions are welcome.
| CASC | Content Adressable Storage Container | DNE | DNE | DNE | DNE | DNE | ✔ | ✔ | ✔ | ✔ | Implemented via a pyCASCLib wrapper. Read-only. Not all library functions are read. Contributions are welcome. Possible integration with TACTAdder / CASCHost or similar software in the future.
| BLP | Images | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | Read-only. Supporting conversion to PNG.
| DBC/DB2 | Client Database Files | ✔ | ✔ | ✔ | TBI | TBI | TBI | TBI | TBI | TBI | Read/Write support is planned.

# Contribution
Feel free to contribute to the library development by either making a pull request or contacting Skarn directly to gain write access.

Expand All @@ -31,7 +33,7 @@ The library comes under MIT license, so feel free to utilize it anywhere you wan

# Legal note
World of Warcraft is a registered trademark of Blizzard Entertainment and/or other respective owners.
This software is not created by Blizzard Entertainment, and is for purely educational and research purposes.
This software is not created by Blizzard Entertainment or its affiliates, and is for purely educational and research purposes.
This software is not intended for the use and production of cheating (hacking) software or modificaitons that can disrupt World of Warcraft's gameplay.
It is your sole responsibility to follow copyright law, game's ToS and EULA.
The creators hold no responsibility for the consequences of use of this software.

0 comments on commit c15b832

Please sign in to comment.