From 7d762cbd707ebe1acd8358e5855d1a00ae5122ec Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:01:24 +0100 Subject: [PATCH 01/15] Remove deprecated project from list. --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 7495a41b..d84a74ad 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,6 @@ War3Net is a collection of libraries for Warcraft III modding. | [War3Net.Build] | Generate Wacraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | | [War3Net.Build.Core] | Parsers and serializers for war3map files. | [![VBuildCore]][PBuildCore] | | [War3Net.CodeAnalysis] | Helper methods for Pidgin parsers. | [![VCode]][PCode] | -| [War3Net.CodeAnalysis.CSharp] | *deprecated* | [![VCodeCSharp]][PCodeCSharp] | | [War3Net.CodeAnalysis.Decompilers]| Regenerate war3map files from a Warcraft III map script. | [![VCodeDecomp]][PCodeDecomp] | | [War3Net.CodeAnalysis.Jass] | War3Net.CodeAnalysis.Jass is a library for parsing and rendering JASS source files. | [![VCodeJass]][PCodeJass] | | [War3Net.CodeAnalysis.Transpilers]| Transpiles JASS source code to C# or lua. | [![VCodeTrans]][PCodeTrans] | @@ -98,7 +97,6 @@ Projects from NuGet packages and submodules may have a different license. [PBuild]: https://www.nuget.org/packages/War3Net.Build [PBuildCore]: https://www.nuget.org/packages/War3Net.Build.Core [PCode]: https://www.nuget.org/packages/War3Net.CodeAnalysis -[PCodeCSharp]: https://www.nuget.org/packages/War3Net.CodeAnalysis.CSharp [PCodeDecomp]: https://www.nuget.org/packages/War3Net.CodeAnalysis.Decompilers [PCodeJass]: https://www.nuget.org/packages/War3Net.CodeAnalysis.Jass [PCodeTrans]: https://www.nuget.org/packages/War3Net.CodeAnalysis.Transpilers @@ -118,8 +116,7 @@ Projects from NuGet packages and submodules may have a different license. [VBuild]: https://img.shields.io/nuget/v/War3Net.Build.svg [VBuildCore]: https://img.shields.io/nuget/v/War3Net.Build.Core.svg -[VCode]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.svg -[VCodeCSharp]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.CSharp.svg +[VCode]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.svg [VCodeDecomp]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.Decompilers.svg [VCodeJass]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.Jass.svg [VCodeTrans]: https://img.shields.io/nuget/v/War3Net.CodeAnalysis.Transpilers.svg From 38cfa9e5e138dfe1de76dc6202b7f49511e4fb91 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:05:39 +0100 Subject: [PATCH 02/15] Rename projects section to packages. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d84a74ad..c7dd9504 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ • What is War3Net? • - Projects • + Packages • Contributing • License @@ -23,9 +23,9 @@ War3Net is a collection of libraries for Warcraft III modding. -### Projects +### Packages -| Project | Summary | NuGet | +| Package | Summary | NuGet | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- | | [War3Net.Build] | Generate Wacraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | | [War3Net.Build.Core] | Parsers and serializers for war3map files. | [![VBuildCore]][PBuildCore] | @@ -33,7 +33,7 @@ War3Net is a collection of libraries for Warcraft III modding. | [War3Net.CodeAnalysis.Decompilers]| Regenerate war3map files from a Warcraft III map script. | [![VCodeDecomp]][PCodeDecomp] | | [War3Net.CodeAnalysis.Jass] | War3Net.CodeAnalysis.Jass is a library for parsing and rendering JASS source files. | [![VCodeJass]][PCodeJass] | | [War3Net.CodeAnalysis.Transpilers]| Transpiles JASS source code to C# or lua. | [![VCodeTrans]][PCodeTrans] | -| [War3Net.Common] | Contains some methods used by several other War3Net projects. | [![VCommon]][PCommon] | +| [War3Net.Common] | Contains some methods used by several other War3Net packages. | [![VCommon]][PCommon] | | [War3Net.Drawing.Blp] | War3Net.Drawing.Blp is a library for reading and writing files with the ".blp" extension. | [![VBlp]][PBlp] | | [War3Net.IO.Casc] | Class library for opening CASC archives. | *Coming soon* | | [War3Net.IO.Compression] | Decompression and compression algorithms for compression methods commonly used in MPQ archives. | [![VCompress]][PCompress] | @@ -47,7 +47,7 @@ War3Net is a collection of libraries for Warcraft III modding. | [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon* | | [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon* | -Some of the above projects are based on code from other repositories: +Some of the above packages are based on code from other repositories: - *[War3Net.Drawing.Blp]:* [SereniaBLPLib](https://github.com/WoW-Tools/SereniaBLPLib) - *[War3Net.IO.Compression] and [War3Net.IO.Mpq]:* [MpqTool](https://github.com/hazzik/MpqTool) From c530d56b751a95e6510746065f1636fb97ec2bed Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:10:49 +0100 Subject: [PATCH 03/15] Fix typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c7dd9504..8d58ed19 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ War3Net is a collection of libraries for Warcraft III modding. | Package | Summary | NuGet | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [War3Net.Build] | Generate Wacraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | +| [War3Net.Build] | Generate Warcraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | | [War3Net.Build.Core] | Parsers and serializers for war3map files. | [![VBuildCore]][PBuildCore] | | [War3Net.CodeAnalysis] | Helper methods for Pidgin parsers. | [![VCode]][PCode] | | [War3Net.CodeAnalysis.Decompilers]| Regenerate war3map files from a Warcraft III map script. | [![VCodeDecomp]][PCodeDecomp] | From ae273dc8107fe036adc12e231f2217a3486646af Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:13:24 +0100 Subject: [PATCH 04/15] Add contributing guidelines, move badges to top. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8d58ed19..71113d95 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ [![GitHub stars](https://img.shields.io/github/stars/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/stargazers) [![GitHub forks](https://img.shields.io/github/forks/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/network/members) +[![GitHub issues](https://img.shields.io/github/issues/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/pulls) +[![GitHub license](https://img.shields.io/github/license/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/blob/master/LICENSE) --- @@ -53,12 +56,12 @@ Some of the above packages are based on code from other repositories: ### Contributing -[![GitHub issues](https://img.shields.io/github/issues/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/issues) -[![GitHub pull requests](https://img.shields.io/github/issues-pr/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/pulls) +Please open an issue before creating a pull request. -### License +Pull requests should be small and atomic to make them easier to review. +Avoid doing multiple things in a single pull request like fixing bugs, adding new features, and refactoring code. -[![GitHub license](https://img.shields.io/github/license/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/blob/master/LICENSE) +### License War3Net is licenced under the [MIT](LICENSE) license. Projects from NuGet packages and submodules may have a different license. From 4658929daa5d44e694811961bcfd61c35bfe7e0c Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:17:39 +0100 Subject: [PATCH 05/15] =?UTF-8?q?soon=E2=84=A2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 71113d95..2387434b 100644 --- a/README.md +++ b/README.md @@ -38,17 +38,17 @@ War3Net is a collection of libraries for Warcraft III modding. | [War3Net.CodeAnalysis.Transpilers]| Transpiles JASS source code to C# or lua. | [![VCodeTrans]][PCodeTrans] | | [War3Net.Common] | Contains some methods used by several other War3Net packages. | [![VCommon]][PCommon] | | [War3Net.Drawing.Blp] | War3Net.Drawing.Blp is a library for reading and writing files with the ".blp" extension. | [![VBlp]][PBlp] | -| [War3Net.IO.Casc] | Class library for opening CASC archives. | *Coming soon* | +| [War3Net.IO.Casc] | Class library for opening CASC archives. | *Coming soon™* | | [War3Net.IO.Compression] | Decompression and compression algorithms for compression methods commonly used in MPQ archives. | [![VCompress]][PCompress] | | [War3Net.IO.Mpq] | Class library for opening and creating MPQ files. | [![VMpq]][PMpq] | | [War3Net.IO.Slk] | Library for opening and creating files in SLK format. | [![VSlk]][PSlk] | -| [War3Net.Modeling] | Read and write .mdl and .mdx files. | *Coming soon* | -| [War3Net.Rendering] | Renders Warcraft III models using [Veldrid]. | *Coming soon* | -| [War3Net.Replay] | Parse replay (.w3g) files. | *Coming soon* | -| [War3Net.Runtime] | Uses [NLua] to run JASS and lua map scripts. | *Coming soon* | -| [War3Net.Runtime.Core] | C# implementation of Warcraft III's backend code. | *Coming soon* | -| [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon* | -| [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon* | +| [War3Net.Modeling] | Read and write .mdl and .mdx files. | *Coming soon™* | +| [War3Net.Rendering] | Renders Warcraft III models using [Veldrid]. | *Coming soon™* | +| [War3Net.Replay] | Parse replay (.w3g) files. | *Coming soon™* | +| [War3Net.Runtime] | Uses [NLua] to run JASS and lua map scripts. | *Coming soon™* | +| [War3Net.Runtime.Core] | C# implementation of Warcraft III's backend code. | *Coming soon™* | +| [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon™* | +| [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon™* | Some of the above packages are based on code from other repositories: - *[War3Net.Drawing.Blp]:* [SereniaBLPLib](https://github.com/WoW-Tools/SereniaBLPLib) From 47c943f37f1c39c83b3e2fc10aeaa0304023c9ea Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:18:03 +0100 Subject: [PATCH 06/15] Remove unused link --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 2387434b..de1946ef 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,6 @@ Projects from NuGet packages and submodules may have a different license. [War3Net.Build]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.Build [War3Net.Build.Core]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.Build.Core [War3Net.CodeAnalysis]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.CodeAnalysis -[War3Net.CodeAnalysis.CSharp]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.CodeAnalysis.CSharp [War3Net.CodeAnalysis.Decompilers]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.CodeAnalysis.Decompilers [War3Net.CodeAnalysis.Jass]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.CodeAnalysis.Jass [War3Net.CodeAnalysis.Transpilers]: https://github.com/Drake53/War3Net/tree/master/src/War3Net.CodeAnalysis.Transpilers From 152be3bc28ddbbfc4e9fabe8a4425bc66ff1ea2b Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:21:58 +0100 Subject: [PATCH 07/15] Highlight consumer-facing packages and describe them in more practical terms. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index de1946ef..02b5d8b9 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,13 @@ War3Net is a collection of libraries for Warcraft III modding. ### Packages +Main packages: + +- **[War3Net.Build]** — Build complete Warcraft III maps programmatically, including script generation and asset packaging +- **[War3Net.CodeAnalysis.Jass]** — Work with JASS code: parse existing scripts, transpile to C#/Lua, or generate new code + +Full list of current and planned packages: + | Package | Summary | NuGet | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- | | [War3Net.Build] | Generate Warcraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | From 5e8f74713736a4c48f92a1982249d1dde67e483d Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:57:48 +0100 Subject: [PATCH 08/15] Use more bold language in the introduction and include additional sections. --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02b5d8b9..2c25382c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ • What is War3Net? • + Vision • + Built with War3Net • Packages • + Roadmap • Contributing • License @@ -24,7 +27,27 @@ ### What is War3Net? -War3Net is a collection of libraries for Warcraft III modding. +Your one-stop .NET toolkit for all things Warcraft III. From low-level file formats like MPQ and BLP to high-level map building in C# and working with JASS scripts—War3Net has you covered. + +Stop reinventing the wheel. Start building. + +### Vision & Principles + +War3Net aims to be the definitive .NET foundation for Warcraft III tooling—built on three core principles: + +- **Completeness** — Every file format. Every game version. Classic through Reforged. +- **Correctness** — Byte-for-byte accuracy with Blizzard's implementations. No guesswork. +- **Compatibility** — .NET 5+ for broad OS support (including Windows 7/8). All game versions from RoC to Reforged. + +### Built with War3Net + +> **Disclaimer:** Projects listed here are independent and not affiliated with, endorsed by, or maintained by the creator of War3Net. Use them at your own discretion. + +| Project | Description | +| ------- | ----------- | +| [Project name](https://github.com/Drake53/War3Net) | This is a placeholder, serving as an example of how to insert the name, url, and description of your project | + +*Using War3Net in your project? Open a PR to add it here!* ### Packages @@ -61,6 +84,18 @@ Some of the above packages are based on code from other repositories: - *[War3Net.Drawing.Blp]:* [SereniaBLPLib](https://github.com/WoW-Tools/SereniaBLPLib) - *[War3Net.IO.Compression] and [War3Net.IO.Mpq]:* [MpqTool](https://github.com/hazzik/MpqTool) +### Roadmap + +Two major initiatives are in progress: + +**JASS Language Suite** — Bringing modern IDE tooling to JASS. +- Fault-tolerant parsing, semantic analysis, and LSP support +- End goals: Intelligent script adaptation across game versions • VSCode extension + +**Warcraft III Runtime** — Run maps without the game. +- Native JASS VM, C# natives, headless rendering +- End goals: Automated C# map testing • Full game emulation + ### Contributing Please open an issue before creating a pull request. From 401934362630a9d1d586b4ee71e2ff6428079274 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:01:05 +0100 Subject: [PATCH 09/15] Update title and subtitle. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c25382c..2479cdd4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# War3Net -## A .NET implementation of Warcraft III related libraries +# War3Net Modding Library +## The complete .NET toolkit for Warcraft III modding [![GitHub stars](https://img.shields.io/github/stars/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/stargazers) [![GitHub forks](https://img.shields.io/github/forks/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/network/members) From a44e77a68d30f1d007b15110ff4cd69c73bd8a28 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:02:58 +0100 Subject: [PATCH 10/15] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2479cdd4..ace049c7 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ Avoid doing multiple things in a single pull request like fixing bugs, adding ne ### License -War3Net is licenced under the [MIT](LICENSE) license. +War3Net is licensed under the [MIT](LICENSE) license. Projects from NuGet packages and submodules may have a different license. From c29b6aaee41ada38269e81bdeb5a69bebae3211e Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:06:19 +0100 Subject: [PATCH 11/15] Remove redundancy in principles. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ace049c7..49b5d27c 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ Stop reinventing the wheel. Start building. War3Net aims to be the definitive .NET foundation for Warcraft III tooling—built on three core principles: -- **Completeness** — Every file format. Every game version. Classic through Reforged. +- **Completeness** — Every file format. Every game version. RoC through Reforged. - **Correctness** — Byte-for-byte accuracy with Blizzard's implementations. No guesswork. -- **Compatibility** — .NET 5+ for broad OS support (including Windows 7/8). All game versions from RoC to Reforged. +- **Compatibility** — .NET 5+ for broad OS support, including Windows 7/8. ### Built with War3Net From ab6cb664b434a473f12a9a7f74a43032476c8d68 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:06:48 +0100 Subject: [PATCH 12/15] Add downloads badge. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 49b5d27c..aeb140d9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![GitHub issues](https://img.shields.io/github/issues/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/pulls) [![GitHub license](https://img.shields.io/github/license/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/blob/master/LICENSE) +[![NuGet downloads](https://img.shields.io/nuget/dt/War3Net.Build.svg)](https://www.nuget.org/packages/War3Net.Build) --- From bc04b6ca9ac9b01b3f4a1752c76df7e1029074e6 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:12:53 +0100 Subject: [PATCH 13/15] Move downloads badge to main packages and turn it into a table. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aeb140d9..7de9809c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ [![GitHub issues](https://img.shields.io/github/issues/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/pulls) [![GitHub license](https://img.shields.io/github/license/Drake53/War3Net.svg)](https://github.com/Drake53/War3Net/blob/master/LICENSE) -[![NuGet downloads](https://img.shields.io/nuget/dt/War3Net.Build.svg)](https://www.nuget.org/packages/War3Net.Build) --- @@ -54,8 +53,10 @@ War3Net aims to be the definitive .NET foundation for Warcraft III tooling—bui Main packages: -- **[War3Net.Build]** — Build complete Warcraft III maps programmatically, including script generation and asset packaging -- **[War3Net.CodeAnalysis.Jass]** — Work with JASS code: parse existing scripts, transpile to C#/Lua, or generate new code +| Package | Description | Downloads | +| ------- | ----------- | --------- | +| **[War3Net.Build]** | Build complete Warcraft III maps programmatically, including script generation and asset packaging | [![War3Net.Build downloads](https://img.shields.io/nuget/dt/War3Net.Build.svg)](https://www.nuget.org/packages/War3Net.Build) | +| **[War3Net.CodeAnalysis.Jass]** | Work with JASS code: parse existing scripts, transpile to C#/Lua, or generate new code | [![War3Net.CodeAnalysis.Jass downloads](https://img.shields.io/nuget/dt/War3Net.CodeAnalysis.Jass.svg)](https://www.nuget.org/packages/War3Net.CodeAnalysis.Jass) | Full list of current and planned packages: From bc03fd9a030119fd08baac310b2e139924ef32a1 Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:13:33 +0100 Subject: [PATCH 14/15] Rewrite package summaries. --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7de9809c..d3c1ca6b 100644 --- a/README.md +++ b/README.md @@ -60,27 +60,27 @@ Main packages: Full list of current and planned packages: -| Package | Summary | NuGet | -| --------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [War3Net.Build] | Generate Warcraft III map script and MPQ archive, by reading from C#/vJass source code and war3map files. | [![VBuild]][PBuild] | -| [War3Net.Build.Core] | Parsers and serializers for war3map files. | [![VBuildCore]][PBuildCore] | -| [War3Net.CodeAnalysis] | Helper methods for Pidgin parsers. | [![VCode]][PCode] | -| [War3Net.CodeAnalysis.Decompilers]| Regenerate war3map files from a Warcraft III map script. | [![VCodeDecomp]][PCodeDecomp] | -| [War3Net.CodeAnalysis.Jass] | War3Net.CodeAnalysis.Jass is a library for parsing and rendering JASS source files. | [![VCodeJass]][PCodeJass] | -| [War3Net.CodeAnalysis.Transpilers]| Transpiles JASS source code to C# or lua. | [![VCodeTrans]][PCodeTrans] | -| [War3Net.Common] | Contains some methods used by several other War3Net packages. | [![VCommon]][PCommon] | -| [War3Net.Drawing.Blp] | War3Net.Drawing.Blp is a library for reading and writing files with the ".blp" extension. | [![VBlp]][PBlp] | -| [War3Net.IO.Casc] | Class library for opening CASC archives. | *Coming soon™* | -| [War3Net.IO.Compression] | Decompression and compression algorithms for compression methods commonly used in MPQ archives. | [![VCompress]][PCompress] | -| [War3Net.IO.Mpq] | Class library for opening and creating MPQ files. | [![VMpq]][PMpq] | -| [War3Net.IO.Slk] | Library for opening and creating files in SLK format. | [![VSlk]][PSlk] | -| [War3Net.Modeling] | Read and write .mdl and .mdx files. | *Coming soon™* | -| [War3Net.Rendering] | Renders Warcraft III models using [Veldrid]. | *Coming soon™* | -| [War3Net.Replay] | Parse replay (.w3g) files. | *Coming soon™* | -| [War3Net.Runtime] | Uses [NLua] to run JASS and lua map scripts. | *Coming soon™* | -| [War3Net.Runtime.Core] | C# implementation of Warcraft III's backend code. | *Coming soon™* | -| [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon™* | -| [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon™* | +| Package | Summary | NuGet | +| ---------------------------------- | ---------------------------------------------------------------- | ----------------------------- | +| [War3Net.Build] | Generate map scripts and MPQ archives from C#/vJass source code. | [![VBuild]][PBuild] | +| [War3Net.Build.Core] | Parsers and serializers for war3map files. | [![VBuildCore]][PBuildCore] | +| [War3Net.CodeAnalysis] | Helper methods for Pidgin parsers. | [![VCode]][PCode] | +| [War3Net.CodeAnalysis.Decompilers] | Regenerate war3map files from a Warcraft III map script. | [![VCodeDecomp]][PCodeDecomp] | +| [War3Net.CodeAnalysis.Jass] | Parse and render JASS source files. | [![VCodeJass]][PCodeJass] | +| [War3Net.CodeAnalysis.Transpilers] | Transpile JASS to C# or Lua. | [![VCodeTrans]][PCodeTrans] | +| [War3Net.Common] | Shared utilities for War3Net packages. | [![VCommon]][PCommon] | +| [War3Net.Drawing.Blp] | Read and write BLP texture files. | [![VBlp]][PBlp] | +| [War3Net.IO.Casc] | Read CASC archives. | *Coming soon™* | +| [War3Net.IO.Compression] | Compression algorithms for MPQ archives. | [![VCompress]][PCompress] | +| [War3Net.IO.Mpq] | Read and write MPQ archives. | [![VMpq]][PMpq] | +| [War3Net.IO.Slk] | Read and write SLK data files. | [![VSlk]][PSlk] | +| [War3Net.Modeling] | Read and write .mdl and .mdx files. | *Coming soon™* | +| [War3Net.Rendering] | Renders Warcraft III models using [Veldrid]. | *Coming soon™* | +| [War3Net.Replay] | Parse replay (.w3g) files. | *Coming soon™* | +| [War3Net.Runtime] | Execute JASS and Lua map scripts using [NLua]. | *Coming soon™* | +| [War3Net.Runtime.Core] | C# implementation of Warcraft III's backend code. | *Coming soon™* | +| [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon™* | +| [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon™* | Some of the above packages are based on code from other repositories: - *[War3Net.Drawing.Blp]:* [SereniaBLPLib](https://github.com/WoW-Tools/SereniaBLPLib) From 49e88db7013161e162b26a5b2f45d0e0fe25874f Mon Sep 17 00:00:00 2001 From: Drake53 <49623303+Drake53@users.noreply.github.com> Date: Fri, 30 Jan 2026 20:16:08 +0100 Subject: [PATCH 15/15] Final touches. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3c1ca6b..7a8633da 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,8 @@ Main packages: | Package | Description | Downloads | | ------- | ----------- | --------- | -| **[War3Net.Build]** | Build complete Warcraft III maps programmatically, including script generation and asset packaging | [![War3Net.Build downloads](https://img.shields.io/nuget/dt/War3Net.Build.svg)](https://www.nuget.org/packages/War3Net.Build) | -| **[War3Net.CodeAnalysis.Jass]** | Work with JASS code: parse existing scripts, transpile to C#/Lua, or generate new code | [![War3Net.CodeAnalysis.Jass downloads](https://img.shields.io/nuget/dt/War3Net.CodeAnalysis.Jass.svg)](https://www.nuget.org/packages/War3Net.CodeAnalysis.Jass) | +| **[War3Net.Build]** | Build complete Warcraft III maps programmatically, including script generation and asset packaging. | [![War3Net.Build downloads](https://img.shields.io/nuget/dt/War3Net.Build.svg)](https://www.nuget.org/packages/War3Net.Build) | +| **[War3Net.CodeAnalysis.Jass]** | Work with JASS code: parse existing scripts, transpile to C#/Lua, or generate new code. | [![War3Net.CodeAnalysis.Jass downloads](https://img.shields.io/nuget/dt/War3Net.CodeAnalysis.Jass.svg)](https://www.nuget.org/packages/War3Net.CodeAnalysis.Jass) | Full list of current and planned packages: @@ -75,11 +75,11 @@ Full list of current and planned packages: | [War3Net.IO.Mpq] | Read and write MPQ archives. | [![VMpq]][PMpq] | | [War3Net.IO.Slk] | Read and write SLK data files. | [![VSlk]][PSlk] | | [War3Net.Modeling] | Read and write .mdl and .mdx files. | *Coming soon™* | -| [War3Net.Rendering] | Renders Warcraft III models using [Veldrid]. | *Coming soon™* | +| [War3Net.Rendering] | Render Warcraft III models using [Veldrid]. | *Coming soon™* | | [War3Net.Replay] | Parse replay (.w3g) files. | *Coming soon™* | | [War3Net.Runtime] | Execute JASS and Lua map scripts using [NLua]. | *Coming soon™* | | [War3Net.Runtime.Core] | C# implementation of Warcraft III's backend code. | *Coming soon™* | -| [War3Net.Runtime.Api.Blizzard] | The Blizzard.j API implemented in C#. | *Coming soon™* | +| [War3Net.Runtime.Api.Blizzard] | Blizzard.j API implemented in C#. | *Coming soon™* | | [War3Net.Runtime.Api.Common] | API for [War3Net.Runtime.Core], similar to [War3Api.Common]. | *Coming soon™* | Some of the above packages are based on code from other repositories: