| 1 | ## Warframe-items
|
| 2 |
|
| 3 | [](https://github.com/WFCD "Supported by Warframe Community Developers")
|
| 4 |
|
| 5 | [](https://npmjs.org/warframe-items)
|
| 6 | [](https://forums.warframe.com/topic/1205630-the-steel-path-update-2810/)
|
| 7 | [](https://ci.nexus-stats.com/WFCD/warframe-items)
|
| 8 | [](https://david-dm.org/WFCD/warframe-items)
|
| 9 | [](https://discord.gg/jGZxH9f)
|
| 10 |
|
| 11 | <br>
|
| 12 |
|
| 13 | Fetches all items available on Warframe's mobile API endpoints while also
|
| 14 | adding images, drop rates, patch logs and related rivens.
|
| 15 |
|
| 16 | The aim of this library is to create a complete collection of data for every
|
| 17 | item in Warframe based on the game's own data. This repo will be automatically
|
| 18 | updated on every new release, drop rate change or image change.
|
| 19 |
|
| 20 | <br>
|
| 21 |
|
| 22 | ### Why use this instead of any other scraper?
|
| 23 | Because this gives you literally every item in Warframe, many of which can't even
|
| 24 | be found on the wikia. We also make sure to include every other data aspect
|
| 25 | that you could possibly need. To give you some idea:
|
| 26 |
|
| 27 | - Unique ingame name - (/Lotus/Weapons/Tenno/...) - Especially useful when working with worldState
|
| 28 | - Drop rates
|
| 29 | - Patchlogs for each item
|
| 30 | - Minified source images
|
| 31 | - Rivens
|
| 32 | - Whether items are tradable
|
| 33 |
|
| 34 | And tons more item specific data. Check out [/data/json](/data/json) to get an
|
| 35 | idea.
|
| 36 |
|
| 37 | You can also rest assured that this repository will be maintained for as long
|
| 38 | as Warframe stays alive, as it is has been built to provide all item data for [NexusHub](https://github.com/nexus-devs/NexusHub).
|
| 39 |
|
| 40 | <br>
|
| 41 |
|
| 42 | ### Installation
|
| 43 | ```
|
| 44 | npm install warframe-items
|
| 45 | ```
|
| 46 |
|
| 47 | <br>
|
| 48 |
|
| 49 | ### Usage
|
| 50 | ```js
|
| 51 | const Items = require('warframe-items')
|
| 52 | const items = new Items(options, ...items)
|
| 53 | ```
|
| 54 | In this example, `items` is an Array with all items. The `...items` param
|
| 55 | allows you to add your own items before our gathered ones.
|
| 56 |
|
| 57 | <br>
|
| 58 |
|
| 59 | ### Options
|
| 60 | | Option | Default | Description |
|
| 61 | |:------------- |:------------- |:------------- |
|
| 62 | | category | `['All']` | Array of item categories to retrieve. Parallel to file names in /data/json. Useful if you don't wanna load lots and lots of MB of data into memory.
|
| 63 |
|
| 64 | | Categories | Description|
|
| 65 | |:--- | :---- |
|
| 66 | | All | All categories in one file |
|
| 67 | | Arcanes | Operator, Zaw, and some Warframe Arcanes |
|
| 68 | | Archwing | Archwings.... nuff said |
|
| 69 | | Arch-Gun | Archwing Guns |
|
| 70 | | Arch-Melee | Archwing Melee weapons |
|
| 71 | | Enemy | NPCs |
|
| 72 | | Fish | Fish that you fish|
|
| 73 | | Gear | Things you equip in your gear wheel
|
| 74 | | Glyphs | Glyphs from partners, etc. |
|
| 75 | | Melee | Melee weapons |
|
| 76 | | Misc | Uncategorized items |
|
| 77 | | Mods | Modifications for weapons, warframes, archwings, etc. |
|
| 78 | | Node | Mission nodes |
|
| 79 | | Pets | Companions, just the beasts |
|
| 80 | | Primary | Primary slot weapons |
|
| 81 | | Quests | Quests that you adventure on |
|
| 82 | | Relics | Things you get prime parts from |
|
| 83 | | Resources | For building stuff |
|
| 84 | | Secondary | Secondary slot weapons |
|
| 85 | | Sentinels | Mechanical companions |
|
| 86 | | Sigils | Chest & back art |
|
| 87 | | Skins | Henna for your frame |
|
| 88 | | Warframes | Warframes...|
|
| 89 |
|
| 90 | <br>
|
| 91 |
|
| 92 | ### Pre-compiled data
|
| 93 | You can find all automatically compiled data in `/data/json`. Images are stored
|
| 94 | in `/data/img`. You can find every item's image name stored in `item.imageName`.
|
| 95 |
|
| 96 | <br>
|
| 97 |
|
| 98 | ### Image links
|
| 99 |
|
| 100 | Since there are so many images, and we can't publish them on npm due to the size, we've set up a CDN to get you images at `https://cdn.warframestat.us/img/${item.imageName}` that provides a linkable resource for you.
|
| 101 |
|
| 102 | <br>
|
| 103 | <br>
|
| 104 |
|
| 105 | ## For Developers
|
| 106 | We're always happy to see contributions to this project, so here's some basic setup information
|
| 107 | to get you started.
|
| 108 |
|
| 109 | <br>
|
| 110 |
|
| 111 | ### Dependencies
|
| 112 | - [Node.js > 10](https://nodejs.org/en/)
|
| 113 | - [Lua > 5](https://www.lua.org/download.html)
|
| 114 | - Build Tools (`build-essentials` on linux should be enough, on windows run `npm i -g windows-build-tools`)
|
| 115 | - libpng-dev12 (linux only)
|
| 116 |
|
| 117 | <br>
|
| 118 |
|
| 119 | ### File structure
|
| 120 | All relevant scripts are found in `/build/` with
|
| 121 |
|
| 122 | [build.js](/build/build.js)<br>
|
| 123 | The entrypoint for the build script. Here we also save JSON, image and cache data.
|
| 124 |
|
| 125 | [scraper.js](/build/scraper.js)<br>
|
| 126 | Fetches all external data and returns it to the parser.
|
| 127 |
|
| 128 | [parser.js](/build/parser.js)<br>
|
| 129 | Parses the external data to match our schema and returns it to the build script.
|
| 130 |
|
| 131 | <br>
|
| 132 |
|
| 133 | ### Usage and Testing
|
| 134 | You can run the build script with `npm run build`.
|
| 135 | Once built, you can verify the data with `npm test`.
|
| 136 |
|
| 137 | <br>
|
| 138 |
|
| 139 | ## License
|
| 140 | [MIT](/LICENSE)
|