Metadata-Version: 2.1
Name: genshinrecipes
Version: 2.6.0
Summary: UNKNOWN
Home-page: https://github.com/tilda/genshin-recipe-data
Author: tilda
Author-email: tda@stairway.cf
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# `genshin-recipe-data` / `genshinrecipes`
A repository to keep a current copy of Genshin Impact's cooking recipe data. Updated on a best effort basis.

# Why?
I'm making tools for myself as someone trying to be a completionist in a gacha game, despite how stupid it sounds.

This was originally in [enkanomiya](https://github.com/tilda/enkanomiya) but since I am making another project using this data, it makes more sense to share a repository between the 2 projects.

For the record, all of this was typed out manually for the most part. There are future plans to make the data much better to contribute to, see [#2](https://github.com/tilda/genshin-recipe-data/issues/2).

# Using it in Python
Install `genshinrecipes` from PyPI to use it in your (Python) project. There are currently 2 functions available.

## `genshinrecipes.return_data()`
- Returns the full JSON object.

## `genshinrecipes.filter_by_rarity(rarity: int)`
- Returns all recipes that are of a certain rarity (1-5).

# Using it in not Python
Simply use the data in `genshinrecipes/recipes.json` (for example, you could use a git submodule). It's a big JSON object basically looking like this:
```js
{
    "food-name": {
        "name": "Food Name",
        "rarity": 1,
        "location": "Where you can find it"
    }
    // and it goes on... and on
}
```

# License
Unlicense, public domain, whatever you want to call it. You are free to use this data however you see fit, because I didn't make the game anyway.

