1.1246.119 • Published 3 years ago

@wfcd/items v1.1246.119

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Warframe-items

Supported by Warframe Community Developers

npm warframe update build dependencies Discord

Fetches all items available on Warframe's mobile API endpoints while also adding images, drop rates, patch logs and related rivens.

The aim of this library is to create a complete collection of data for every item in Warframe based on the game's own data. This repo will be automatically updated on every new release, drop rate change or image change.

Why use this instead of any other scraper?

Because this gives you literally every item in Warframe, many of which can't even be found on the wikia. We also make sure to include every other data aspect that you could possibly need. To give you some idea:

  • Unique ingame name - (/Lotus/Weapons/Tenno/...) - Especially useful when working with worldState
  • Drop rates
  • Patchlogs for each item
  • Minified source images
  • Rivens
  • Whether items are tradable

And tons more item specific data. Check out /data/json to get an idea.

You can also rest assured that this repository will be maintained for as long as Warframe stays alive, as it is has been built to provide all item data for NexusHub.

Installation

npm install warframe-items

Usage

const Items = require('warframe-items')
const items = new Items(options, ...items)

In this example, items is an Array with all items. The ...items param allows you to add your own items before our gathered ones.

Options

OptionDefaultDescription
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.
CategoriesDescription
AllAll categories in one file
ArcanesOperator, Zaw, and some Warframe Arcanes
ArchwingArchwings.... nuff said
Arch-GunArchwing Guns
Arch-MeleeArchwing Melee weapons
EnemyNPCs
FishFish that you fish
GearThings you equip in your gear wheel
GlyphsGlyphs from partners, etc.
MeleeMelee weapons
MiscUncategorized items
ModsModifications for weapons, warframes, archwings, etc.
NodeMission nodes
PetsCompanions, just the beasts
PrimaryPrimary slot weapons
QuestsQuests that you adventure on
RelicsThings you get prime parts from
ResourcesFor building stuff
SecondarySecondary slot weapons
SentinelsMechanical companions
SigilsChest & back art
SkinsHenna for your frame
WarframesWarframes...

Pre-compiled data

You can find all automatically compiled data in /data/json. Images are stored in /data/img. You can find every item's image name stored in item.imageName.

Image links

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.

For Developers

We're always happy to see contributions to this project, so here's some basic setup information to get you started.

Dependencies

  • Node.js > 10
  • Lua > 5
  • Build Tools (build-essentials on linux should be enough, on windows run npm i -g windows-build-tools)
  • libpng-dev12 (linux only)

File structure

All relevant scripts are found in /build/ with

build.js The entrypoint for the build script. Here we also save JSON, image and cache data.

scraper.js Fetches all external data and returns it to the parser.

parser.js Parses the external data to match our schema and returns it to the build script.

Usage and Testing

You can run the build script with npm run build. Once built, you can verify the data with npm test.

License

MIT