homm3-parsers v0.8.11

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
  • Usage
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The project was born as I was working on online map viewer for Heroes of Might and Magic III. The main idea was to make it easy t parse different binary respources needed for that in node and browser.

Current focus is on h3m files, with rudimentary support for lod, def and pcx.

Built With

• BML

Getting Started

Installation

User npm

npm install --save homm3-parsers

or yarn

yarn add homm3-parsers

Usage

Parsing h3m files

const fs = require('fs');
const { parseH3MFile } = require('homm3-parsers')

async function parse(path) => {
  const file = await fs.promises.readFile(path)
  return = parseH3MFile(file)
}

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

License

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

Contact

Sergii Kostyrko - srg.kostyrko@gmail.com

Project Link: https://github.com/srg-kostyrko/homm3-parser

Acknowledgements

• homm3tools
• https://github.com/josch/lodextract