1+
12# node-diablo2-data
2- [ ![ NPM version] ( https://img.shields.io/npm/v/diablo2-data.svg )] ( http://npmjs.com/package/diablo2-data )
3- [ ![ Build Status] ( https://img.shields.io/circleci/project/MephisTools/node-diablo2-data/master.svg )] ( https://circleci.com/gh/MephisTools/node-diablo2-data )
43
5- expose diablo 2 data in NodeJS
4+ <!-- PROJECT SHIELDS -->
5+ [ ![ Contributors] [ contributors-shield ]] [ contributors-url ]
6+ [ ![ Forks] [ forks-shield ]] [ forks-url ]
7+ [ ![ Stargazers] [ stars-shield ]] [ stars-url ]
8+ [ ![ Issues] [ issues-shield ]] [ issues-url ]
9+ [ ![ MIT License] [ license-shield ]] [ license-url ]
10+ [ ![ NPM version] [ npm-shield ]] [ npm-url ]
11+ [ ![ Build Status] [ build-shield ]] [ build-url ]
12+ [ ![ Discord] [ discord-shield ]] [ discord-url ]
13+
14+ <!-- TABLE OF CONTENTS -->
15+ ## Table of Contents
16+
17+ * [ About the Project] ( #about-the-project )
18+ * [ Getting Started] ( #getting-started )
19+ * [ Prerequisites] ( #prerequisites )
20+ * [ Installation] ( #installation )
21+ * [ Usage] ( #usage )
22+ * [ Roadmap] ( #roadmap )
23+ * [ Contributing] ( #contributing )
24+ * [ License] ( #license )
25+ * [ Acknowledgements] ( #acknowledgements )
26+
27+ <!-- ABOUT THE PROJECT -->
28+ ## About The Project
29+
30+ The goal of this project is to provide an easy-to-use lib to get Diablo 2 related data
631
7- ## Features
32+ ## Getting Started
833
9- For example it's often useful to :
34+ This is an example of how you may give instructions on setting up your project locally.
35+ To get a local copy up and running follow these simple example steps.
1036
11- * find areas by id
12- * find items by name
13- * find monster by name
37+ ### Prerequisites
1438
15- ## Example
39+ * nodejs, npm
40+
41+ ### Installation
42+
43+ ``` bash
44+ npm i diablo2-data
45+ ```
46+
47+ <!-- USAGE EXAMPLES -->
48+ ## Usage
1649
1750``` js
1851const diabloData = require (' diablo2-data' )(' pod_1.13d' )
@@ -26,4 +59,54 @@ console.log(JSON.stringify(diabloData.itemPropertiesByName['Maximum Damage']))
2659console .log (JSON .stringify (diabloData .itemDataByName [' Ring Mail' ]))
2760console .log (JSON .stringify (diabloData .itemTypesByName [' Amulet' ]))
2861console .log (JSON .stringify (diabloData .uniqueItemsByName [' Shako' ]))
29- ```
62+ console .log (JSON .stringify (diabloData .responses [41 ]))
63+ ```
64+
65+ Or run the example
66+
67+ ``` bash
68+ sudo node examples/basic.js
69+ ```
70+
71+ ## Roadmap
72+
73+ See the [ open issues] ( https://github.com/Mephistools/node-diablo2-data/issues ) for a list of proposed features (and known issues).
74+
75+ ## Contributing
76+
77+ 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** .
78+
79+ 1 . Fork the Project
80+ 2 . Create your Feature Branch (` git checkout -b feature/AmazingFeature ` )
81+ 3 . Commit your Changes (` git commit -m 'Add some AmazingFeature' ` )
82+ 4 . Push to the Branch (` git push origin feature/AmazingFeature ` )
83+ 5 . Open a Pull Request
84+
85+ ## License
86+
87+ Distributed under the MIT License. See ` LICENSE ` for more information.
88+
89+ ## Acknowledgements
90+
91+ * [ Img Shields] ( https://shields.io )
92+ * [ Choose an Open Source License] ( https://choosealicense.com )
93+ * [ GitHub Pages] ( https://pages.github.com )
94+
95+ <!-- MARKDOWN LINKS & IMAGES -->
96+ <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
97+ [ contributors-shield ] : https://img.shields.io/github/contributors/Mephistools/node-diablo2-data.svg?style=flat-square
98+ [ contributors-url ] : https://github.com/Mephistools/node-diablo2-data/graphs/contributors
99+ [ forks-shield ] : https://img.shields.io/github/forks/Mephistools/node-diablo2-data.svg?style=flat-square
100+ [ forks-url ] : https://github.com/Mephistools/node-diablo2-data/network/members
101+ [ stars-shield ] : https://img.shields.io/github/stars/Mephistools/node-diablo2-data.svg?style=flat-square
102+ [ stars-url ] : https://github.com/Mephistools/node-diablo2-data/stargazers
103+ [ issues-shield ] : https://img.shields.io/github/issues/Mephistools/node-diablo2-data.svg?style=flat-square
104+ [ issues-url ] : https://github.com/Mephistools/node-diablo2-data/issues
105+ [ license-shield ] : https://img.shields.io/github/license/Mephistools/node-diablo2-data.svg?style=flat-square
106+ [ license-url ] : https://github.com/Mephistools/node-diablo2-data/blob/master/LICENSE.txt
107+ [ npm-shield ] : https://img.shields.io/npm/v/diablo2-data.svg
108+ [ npm-url ] : http://npmjs.com/package/diablo2-data
109+ [ build-shield ] : https://github.com/Mephistools/node-diablo2-data/workflows/CI/badge.svg
110+ [ build-url ] : https://github.com/Mephistools/node-diablo2-data/actions?query=workflow%3A%22CI%22
111+ [ discord-shield ] : https://img.shields.io/badge/chat-on%20discord-brightgreen.svg
112+ [ discord-url ] : https://discord.gg/9RqtApv
0 commit comments