Not finished yet, please wait until version >= 1.0.0.

Table of Contents

• Overview
• Support
  • Support Files
  • Object data files
  • Trigger files
  • Map files
  • Currently Not included
• Getting Started
  • Prerequisites
  • Import
  • Development
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Overview

War3map is a module to convert between a Object representation of WarCraft III (.w3x) data and war3map format files.

War3map is written in TypeScript, offering type safety and improved development experience.

Here's some places where you can use this library:

• You need to decompile a map of Warcraft 3.
• You want to write a map editor for Warcraft 3.
• You want to optimize or encrypt your Warcraft 3 map.

Support

Support Files

| Type | Object → War | War → Object | File | | --- | :-: | :-: | --- | | Environment | | | war3map.w3e | | Units | | | war3mapUnits.doo | | Doodads | | | war3map.doo | | Regions | | | war3map.w3r | | Cameras | | | war3map.w3c | | Sounds(definitions)| | | war3map.w3s|

Object data files

| Type | Object → War | War → Object | File | | --- | :-----------: | :-: | ---- | | Units - Objects | | | war3map.w3u | | Items - Objects | | | war3map.w3t | | Abilities - Objects | | | war3map.w3a | | Destructables - Objects | | | war3map.w3b | | Doodads - Objects | | | war3map.w3d | | Upgrades - Objects | | | war3map.w3q | | Buffs - Objects | | | war3map.w3h |

Trigger files

| Type | Object → War | War → Object | File | | --- | :-: | :-: | --- | | LUA | | | war3map.lua | | JASS | | | war3map.j | | Strings | | | war3map.wts |

Map files

| Type | Object → War | War → Object | File | | --- | :-: | :-: | --- | | Info File | | | war3map.w3i | | Imported Files | | | war3map.imp | | Pathing | | | war3map.wpm | | Shadow map | | | war3map.shd |

Currently Not included

Custom Text Trigger File (war3map.wct)
Trigger Names File (war3map.wtg)
Menu Minimap (war3map.mmp)
Minimap Image (war3mapMap.blp)
Minimap Image (war3mapMap.b00
Minimap Image (war3mapMap.tga)
Map Preview Image (war3mapPreview.tga)

Getting Started

Prerequisites

• NODEJS VERSION >= 10

Installation

The easiest and fastest way is to use it as a library. Just simply type the followings:

• npm

npm install war3map

Import

Create your .ts or .js file, and type as follows:

import * as war3map from "war3map";

To get more examples or usages for war3map, see Documentation.

Development

To get a local copy up and running follow these simple steps:

1. Clone the repo

git clone https://github.com/invokerrrr/war3map.git

2. Enter the correct directory

cd war3map

3. Install NPM packages

npm install

4. Run All Tests

npm test

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Your code should:

• Run correctly (Run npm test without errors.)
• Include tests (Write unit tests and run npm run test:coverage to cover most of your code.)
• Be linted (Run npm run lint and follow the project's coding standards.)
• Pass travis-ci (Pass in different environments.)

If your code is accepted into master, we will invite you to be a project member as soon.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Invoker Bot - [email protected]

Project Link: https://github.com/invokerrrr/war3map

Acknowledgements

• This project refers a lot from WC3MapTranslator written by ChiefOfGxBxL. Our goal is same but offers different API, and plan more features.

• We owe a lot of thanks to Chocobo on TheHelper for the detailed documentation of the files found in a .w3x archive. And another two tutorials are here (1) and here (2) and here (3).