Hello, i'm sorry to bother you but i was simply wondering if the golden variants of the enemies would show up here, i have been searching for them and i cannot find them, are they simply not in the compendium in the main game? my apologies if so

I was looking around the dataset and I noticed that there is a lot of "non-creature" content returned by the creatures endpoint. For instance, you get stuff like "golden claymore" with id 262 in the non-food sub-category. I'm a bit confused about what your concept of a "creature" is within the domain of this API.

It also doesn't match the data in the creatures json file which only have 83 entries. Is this a bug?

I know the images are in development so you may or may not be aware of these, but just wanted to point them out in case you weren't.

I came across 3 missing images: https://botw-compendium.herokuapp.com/api/v2/entry/golden_bow/image https://botw-compendium.herokuapp.com/api/v2/entry/golden_claymore/image https://botw-compendium.herokuapp.com/api/v2/entry/luminous_ore_deposit/image

I also came across 1 broken image. The image is actually there and works just fine but the url in the entry has a typo: https://botw-compendium.herokuapp.com/api/v2/entry/rare_or_deposit/image ('ore' is misspelled and is missing the 'e')

Hope to add images to the API very soon. The entry endpoint will have an additional key, image, that has a URL of the image (hosted on the same heroku server). That URL will be /entry/<entry>/image, which will serve the image in a png of jpeg format.

When I do a request, I can't retrieve the data of an entry who is in the category "non-food". The hyphen in the category create errors. I don't know how to fix it. I'm using JavaScript.

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:

• [x] in-game compendium (/compendium)
• [x] geographical regions (/regions) (https://github.com/gadhagod/Hyrule-Compendium-API/discussions/29)
• [ ] recipes (/recipes) (https://github.com/gadhagod/Hyrule-Compendium-API/issues/27)

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

• [x] The compendium entries will have a field dlc that specifies if it is a master-mode exclusive. The /master_mode endpoint will remain to avoid ID conflicts.
• [x] The food and non_food keys in the creatures category response will be removed. Each creature entry will have a boolean property edible instead.

Code Changes

These changes will not affect the user of the API. It will improve performance and clean up code.

• [x] Separate branches for API versions
• [x] Use Flask blueprints instead of Flask().add_url_rule
• [ ] Improve queries to reduce API latency
  • Instead of executing multiple queries, using UNION is a better solution
• [x] Create staging app to test changes

Client Libraries

• [ ] Update pyrule-compendium (@shaunikm)
• [ ] Update Hyrule-Compendium-node-client (@goombamaui)

Additional Tasks

• [ ] Documentation

Release

I hope to have all of these features in production by the end of 2022. I hope to get the bulk of it done by the end of this summer (August 2022).

Feel free to chime in on this thread.

Hi! Great work with this! I was wondering if you were planning on getting the images more standardized like the ones from https://zelda.fandom.com/wiki/Food#Breath_of_the_Wild. Also, do you have any plans for adding a recipe list?