> For the complete documentation index, see [llms.txt](https://sqdnoises.gitbook.io/infinite-craft/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sqdnoises.gitbook.io/infinite-craft/readme.md).

# Introduction

infinite-craft is an **API Wrapper** of [Neal's Infinite Craft game](https://neal.fun/infinite-craft) in **Python** for people to implement in their programs.

[**View `infinite-craft` on PyPI.**](https://pypi.org/project/infinite-craft/)

## Key Features

* Stores elements in a neatly indented JSON file
* Starts with the four main elements: Water, Fire, Wind, Earth
* Uses [`neal.fun`](https://neal.fun/)'s [Infinite Craft](https://neal.fun/infinite-craft/) API to pair elements together
* Built-in ratelimiting handler
* Custom API support
* Asynchronous library
* Conveniently access discovered elements

{% hint style="info" %}
Do you have any issues or problems? Join our [Discord server](https://discord.gg/sAecE3YVEe) to get help or [make a GitHub issue](https://github.com/sqdnoises/infinite-craft/issues/new).
{% endhint %}

## How does it work?

This library basically contacts the URL:\
<https://neal.fun/api/infinite-craft/pair?first=element+name&second=element+name>\
Tricks it with some headers, and handles everything accordingly.

Everything is handled in a user-friendly manner and asynchronously, so it should be really easy to use it in your programs.

{% hint style="info" %}
Want to contribute? Make a pull request at [infinite-craft's GitHub repository](https://github.com/sqdnoises/infinte-craft)!
{% endhint %}

## License

[![](https://img.shields.io/badge/LICENSE-MIT-red?style=for-the-badge\&labelColor=black)](https://github.com/sqdnoises/infinite-craft/blob/main/docs/LICENSE/README.md)\
*View the* [***MIT License***](https://github.com/sqdnoises/infinite-craft/blob/main/docs/LICENSE/README.md) *license that comes with this library.*

***

🌟 Please star the [GitHub repo](https://github.com/sqdnoises/infinite-craft/stargazers) and show some love 💖