The new version of the Hyrule Compendium API will serve data on more than just the compendium entries. It will contain the following categories of data:
The goal is to make this API more than just the compendium; it should be able to give data on all (or many) aspects of the game, not just the in-game items.
Recipes
Recipes will be divided based on their base ingredient (e.g seafood). Multi-dimensional arrays will be used to represent possible ingredients to tackle the problem of substitutable ingredients.
Possible example recipe response:
{
"name": "meat and rice bowl",
"image": "https://botw-compendium.herokuapp.com/api/v3/recipes/recipe/meat-and-rice-bowl",
"category": "meat",
"hearts_recovered": 4.0, // hearts recovered from consumption
"ingredients": [["raw meat", "raw bird drumstick"], ["rock salt"], ["hylian rice"]] // array of arrays, each inner array represents possible ingredients
"effect": "attack", // enhancing effect of dish (empty if none)
"duration": 60, // duration of effect in seconds (0 if no effect)
}
Map
Data on each region, including encompassed shrines and settlements, will be provided.
Compendium
{
// ...
"properties": {
"attack": 14,
"defense": 0
}
Code Changes
These changes will not affect the usage of the API. It will improve performance and clean up code.
Additional Tasks
Feel free to chime in on this thread.