diablo2-data - npm Package Compare versions

Comparing version 1.5.0 to 1.6.0

docs/API.md

@@ -171,2 +171,4 @@ ## API
 
+### responses
 
+responses code from the server with their matching string (meaning)

docs/HISTORY.md

@@ -0,1 +1,4 @@
+## 1.6.0
+* Add server responses enums 
+
 ## 1.5.0
@@ -2,0 +5,0 @@ * Add stash bottom item enum container

index.js

@@ -23,2 +23,3 @@ const diabloDataToNode = require('./lib/loader')
   const itemEnums = require(`./data/${diabloVersion}/item`)
+  const responses = require(`./data/${diabloVersion}/responses`)
   const diabloData = {
@@ -30,2 +31,3 @@ npcs: loadCsv(`${__dirname}/data/${diabloVersion}/monster_names.txt`, '\t', ['name']),
     itemEnums: itemEnums,
+    responses: responses,
     itemProperties: loadCsv(`${__dirname}/data/${diabloVersion}/item_properties.txt`, '|', ['statName', 'saveBits', 'saveParamBits', 'saveAdd']),
@@ -32,0 +34,0 @@ itemData: loadCsv(`${__dirname}/data/${diabloVersion}/item_data.txt`, '|', ['name', 'code', 'classificationString', 'width', 'height', 'stackable', 'usable', 'throwable']),

lib/loader.js

@@ -63,4 +63,6 @@ module.exports = diabloDataToNode
     belts: diabloData.belts,
-    beltsByName: indexes.beltsByName
+    beltsByName: indexes.beltsByName,
+
+    responses: diabloData.responses
   }
 }

package.json

 {
   "name": "diablo2-data",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Expose Diablo 2 data in NodeJS",
@@ -16,3 +16,3 @@ "main": "index.js",
     "type": "git",
-    "url": "git+https://github.com/louis030195/node-diablo2-data.git"
+    "url": "git+https://github.com/MephisTools/node-diablo2-data.git"
   },
@@ -22,5 +22,5 @@ "author": "Louis Beaumont",
   "bugs": {
-    "url": "https://github.com/louis030195/node-diablo2-data/issues"
+    "url": "https://github.com/MephisTools/node-diablo2-data/issues"
   },
-  "homepage": "https://github.com/louis030195/node-diablo2-data#readme",
+  "homepage": "https://github.com/MephisTools/node-diablo2-data#readme",
   "devDependencies": {
@@ -27,0 +27,0 @@ "standard": "^12.0.1"

README.md

@@ -0,17 +1,50 @@
+
 # node-diablo2-data
-[![NPM version](https://img.shields.io/npm/v/diablo2-data.svg)](http://npmjs.com/package/diablo2-data)
-[![Build Status](https://img.shields.io/circleci/project/MephisTools/node-diablo2-data/master.svg)](https://circleci.com/gh/MephisTools/node-diablo2-data)
 
-expose diablo 2 data in NodeJS
+<!-- PROJECT SHIELDS -->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![NPM version][npm-shield]][npm-url]
+[![Build Status][build-shield]][build-url]
+[![Discord][discord-shield]][discord-url]
 
-## Features
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
 
-For example it's often useful to : 
+* [About the Project](#about-the-project)
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Acknowledgements](#acknowledgements)
 
-* find areas by id
-* find items by name
-* find monster by name
+<!-- ABOUT THE PROJECT -->
+## About The Project
 
-## Example
+The goal of this project is to provide an easy-to-use lib to get Diablo 2 related data
 
+## Getting Started
+
+This is an example of how you may give instructions on setting up your project locally.
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+* nodejs, npm
+
+### Installation
+
+```bash
+npm i diablo2-data
+```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
 ```js
@@ -29,2 +62,52 @@ const diabloData = require('diablo2-data')('pod_1.13d')
 console.log(JSON.stringify(diabloData.uniqueItemsByName['Shako']))
-```
+console.log(JSON.stringify(diabloData.responses[41]))
+```
+
+Or run the example
+
+```bash
+sudo node examples/basic.js
+```
+
+## Roadmap
+
+See the [open issues](https://github.com/Mephistools/node-diablo2-data/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
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Acknowledgements
+
+* [Img Shields](https://shields.io)
+* [Choose an Open Source License](https://choosealicense.com)
+* [GitHub Pages](https://pages.github.com)
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/Mephistools/node-diablo2-data.svg?style=flat-square
+[contributors-url]: https://github.com/Mephistools/node-diablo2-data/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/Mephistools/node-diablo2-data.svg?style=flat-square
+[forks-url]: https://github.com/Mephistools/node-diablo2-data/network/members
+[stars-shield]: https://img.shields.io/github/stars/Mephistools/node-diablo2-data.svg?style=flat-square
+[stars-url]: https://github.com/Mephistools/node-diablo2-data/stargazers
+[issues-shield]: https://img.shields.io/github/issues/Mephistools/node-diablo2-data.svg?style=flat-square
+[issues-url]: https://github.com/Mephistools/node-diablo2-data/issues
+[license-shield]: https://img.shields.io/github/license/Mephistools/node-diablo2-data.svg?style=flat-square
+[license-url]: https://github.com/Mephistools/node-diablo2-data/blob/master/LICENSE.txt
+[npm-shield]: https://img.shields.io/npm/v/diablo2-data.svg
+[npm-url]: http://npmjs.com/package/diablo2-data
+[build-shield]: https://github.com/Mephistools/node-diablo2-data/workflows/CI/badge.svg
+[build-url]: https://github.com/Mephistools/node-diablo2-data/actions?query=workflow%3A%22CI%22
+[discord-shield]: https://img.shields.io/badge/chat-on%20discord-brightgreen.svg
+[discord-url]: https://discord.gg/9RqtApv

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2911903

increased by0.2%

Number of package files

103

increased by1.98%

Lines of code

769

increased by5.05%

Number of lines in readme file

113

increased by289.66%

Worsened metrics

Number of low supply chain risk alerts

3

increased by50%

No dependency changes