Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Luzifix committed Jul 19, 2024
1 parent 75b4b5c commit 02cdd11
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,26 @@
<a href="https://www.nuget.org/packages/Warcraft.NET"><img alt="NuGet Version" src="https://img.shields.io/nuget/v/Warcraft.NET?style=for-the-badge&logo=nuget&label=Warcraft.NET"></a>

## About
Warcraft.NET is a open source C# library for World of Warcraft binary file formats. The goal of the library is to support following game versions:
Warcraft.NET is an open source C# library that can read and write most of the World of Warcraft binary file formats. The goal of the library is to support the following versions of the game:
- Wrath of the Lich King (3.3.5)
- Warlords of Draenor (6.2.4)
- Legion (7.x.x)
- Battle for Azeroth (8.x.x)
- Shadowlands (9.2.x)

## Status
We support most of the World of Warcraft binary formats. Check out the link's below for a detailed view on chunk level.
- [ADT](Docs/ADT.md)
- [WDT](Docs/WDT.md)
- [WDL](Docs/WDL.md)
- [WMO](Docs/WMO.md)
- [M2](Docs/M2.md)
- [TEX](Docs/TEX.md)
- [BLOB](Docs/BLOB.md)

## Used in
- [MapUpconverter](https://github.com/Marlamin/MapUpconverter)

## Licensing
Warcraft.NET is Free Software, and is distributed under the GPLv3 license. This means, in simple terms, that you are free to do whatever you want with the source code and any binaries compiled or generated from it as long as you pass on those rights to anyone aquiring a copy of the source code or binaries. The full licence can be read in the file "LICENSE" at the root of the source tree, or at http://choosealicense.com/licenses/gpl-3.0/, where a more people-friendly summary is also available.

Expand All @@ -20,4 +33,3 @@ The use of the GPLv3 license and not the LGPLv3 license is a conscious choice by
Special thanks to:
- [wowdev.wiki](https://wowdev.wiki/)
- [libwarcarft](https://github.com/WowDevTools/libwarcraft)

0 comments on commit 02cdd11

Please sign in to comment.