wfm-items
wfm-items copied to clipboard
WFM Database: item files
README
-
README
- Directories
-
How to contribute
- Contribution Workflow
- Contributing an Icon
-
File structure
-
Common item fields
- Mod exclusive fields
- Weapons and parts fields
- Fish and relics
- Sculptures
-
Common item fields
- Riven items
- Riven attributes
- Lich weapons
- Lich quirks
- Lich ephemeras
- How to create Sets
- How to define Tags
:warning: Riven attributes, despite being in
tracked
folder should be translated manually, because their names isn't translated inside the DE api.
You can edit their "effect" names insidetracked
folder.
Directories
-
tracked
- All these items are managed automatically and should stay in sync with DE api. -
untracked
- These items require manual intervention to stay up to date -
missing
- If item is missing from WFM, you can add it here. -
icons
- If it is not possible to provide an icon by url, you can copy icon here, in binary format. (png
/jpg
)
Subdirectories:
-
items
- common items, mods, warframes, scenes, etc. -
rivens
- riven related entities. (used in auctions) -
liches
- lich related entities. (used in auctions)
How to contribute
By issuing Pull requests, "rebase" workflow.
Contribution Workflow
- If item is exist on the site find it inside
tracked
\untracked
folder. If item is missing from the site, create a new file insidemissing
folder (%item_name%.json
format). - Apply desired changes to the file(s).
- Commit with short description of your changes.
- Send a pull request.
- I'll review these changes and if everything is ok, i'll accept your pull request.
- All changes will be merged into WFM database in a few days.
Contributing an Icon
From a remote source:
"icon": "https://vignette.wikia.nocookie.net/warframe/images/6/6d/Hind.png"
From the icon folder:
"icon": "items/icons/<icon_file>"
File structure
Common item fields
-
_id
- id of an item, do not modify it, and do not create it (in case of adding a new item) -
tags
- not used right now in any way, but it still prefarable to add them. -
icon
- local or remore path to the icon, check This section -
thumb
- ~~autogenerated~~ -
icon_format
- ~~autogenerated~~ -
sub_icon
- sub icon of an item, represent part of the set, likehandle
/grip
/...
, could be path to local file or remote address. -
url_name
- Will be generated automatically. -
tradable
- This item is tradable. (true
/false
) -
game_ref.uniq_name
- reference to the game uniq name. -
part_of_set
- List of items in the set, url_name (["zakti_prime_blueprint","zakti_prime_barrel", ...]
) -
set_root
- This item is set itself, likeSome Prime Set
, it's parrent of other parts. -
quantity_for_set
- How many parts is in the set. -
en
\ru
\ko
\...
- lang specific subdocument.-
item_name
- Name of an item. -
description
- Item descriptrion. -
wiki_link
- Link to the wiki. -
icon
- lang specific icon. -
icon_format
- ~~autogenerated~~ -
thumb
- ~~autogenerated~~ -
drop
- Drop locations.-
name
- Name of the location. -
link
- link to the resource (wiki or wfm).
-
-
-
trading_tax
- Tax
Mod exclusive fields
-
rarity
- Mod rarity. -
max_rank
- Maximum possible Mod\Arcane rank.
Weapons and parts fields
-
mastery_level
- mastery requirenment. -
ducats
- Costs in ducats.
Fish and relics
-
subtypes
- fish or relic subtype, like["intact",exceptional","flawless","radiant"]
.
Sculptures
Not implemented yet, but planned for one of the next updates
-
amber_stars
- max amount of amber stars -
cyan_stars
- max amount of cyan stars
Riven items
...
Riven attributes
...
Lich weapons
...
Lich quirks
...
Lich ephemeras
...
How to create Sets
If you want to add a set, just create a set of files, and put a flag "set_root" : true
inside the set root file. (e.g. Some Prime Set.json
)
Then link every part with eachother by defining part_of_set
inside every file, in this way (Soma Prime as example):
"part_of_set": [
"soma_prime_set",
"soma_prime_barrel",
"soma_prime_blueprint",
"soma_prime_receiver",
"soma_prime_stock"
],
↑ array of url_name
For an example: check Soma Prime Set and its parts inside tracked/items/
folder
How to define Tags
For missing or untracked items only
There is no strict convention, but you can use this logic:
- Add item group, like
Blueprint
|Mod
. - Add item type, like
Rifle
|Warframe
. - Add additional definition, like
Prime
|Corrupted
|Huras
,Rare
, etc.
For example Rare Rifle Mod should have [Mod, Rifle, Rare]
tags.