Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sqdnoises/infinite-craft
An API Wrapper of Neal's Infinite Craft game in Python for people to implement in their programs.
https://github.com/sqdnoises/infinite-craft
automation cli game game-api infinite-craft infinite-craft-hack infinitecraft library neal-fun python python3 python3-library rest-api
Last synced: 8 days ago
JSON representation
An API Wrapper of Neal's Infinite Craft game in Python for people to implement in their programs.
- Host: GitHub
- URL: https://github.com/sqdnoises/infinite-craft
- Owner: sqdnoises
- License: mit
- Created: 2024-02-28T15:05:56.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T17:22:59.000Z (about 1 month ago)
- Last Synced: 2024-10-17T16:04:00.414Z (about 1 month ago)
- Topics: automation, cli, game, game-api, infinite-craft, infinite-craft-hack, infinitecraft, library, neal-fun, python, python3, python3-library, rest-api
- Language: Python
- Homepage: https://neal.fun/infinite-craft/
- Size: 567 KB
- Stars: 8
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/sqdnoises/infinite-craft)
# infinite-craft `1.1.4`
[](https://github.com/sqdnoises/infinite-craft)
[](https://pypi.org/project/infinite-craft/)
[](https://pypi.org/project/infinite-craft/)
[](LICENSE)
[](https://python.org)
\
An API Wrapper for Neal's Infinite Craft game in Python.
### `infinite-craft`'s GitHub Actions Status
[](https://github.com/sqdnoises/infinite-craft/actions/workflows/pytest.yml)
[](https://github.com/sqdnoises/infinite-craft/actions/workflows/publish-package-to-pypi.yml)
[](https://github.com/sqdnoises/infinite-craft/actions/workflows/create-github-release.yml)
> [!IMPORTANT]
> The library is currently broken. If you pair two elements you get a [`403 Forbidden` error](https://github.com/sqdnoises/infinite-craft/issues/2). A fix for this is currently being made.
# 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
# Discord Server
> [!TIP]
> Need help? Join our Discord community!\
» https://discord.gg/FF2fSN2sJd \
[](https://discord.gg/FF2fSN2sJd)
# Table of Contents:
- **[Key Features](#key-features)**
- **[Discord Server](#discord-server)**
- **[Installation](#installation)**
- **[Examples](#examples)**
- **[Documentation](#documentation-)**
- **[How does it work?](#how-does-it-work)**
- **[To-do](#to-do)**
- **[License](#license)**
# Installation
> [!IMPORTANT]
> **Python 3.10** or above is required. Any versions below will not work.
To install, run:
```
pip install infinite-craft
```
To update, run:
```
pip install -U infinite-craft
```
> [!NOTE]
> If `pip` is not on PATH, you can use:
> - `python3 -m pip` (for Linux/MacOS) or
> - `python -m pip` (for Windows) instead.
[**View `infinite-craft` on PyPI.**](https://pypi.org/project/infinite-craft/)
# Examples
### Using `async with`
```py
import asyncio
from infinitecraft import InfiniteCraft
async def main():
async with InfiniteCraft() as game: # automatically start session and end session on async with end
print(f"Pairing elements: {game.discoveries[0]} and {game.discoveries[1]}")
result = await game.pair(game.discoveries[0], game.discoveries[1]) # Pair Water and Fire
print(f"Result: {result}")
asyncio.run(main())
```
### Manually controlling
```py
import asyncio
from infinitecraft import InfiniteCraft
game = InfiniteCraft()
async def main():
await game.start() # Start InfiniteCraft Session
print(f"Pairing elements: {game.discoveries[0]} and {game.discoveries[1]}")
result = await game.pair(game.discoveries[0], game.discoveries[1]) # Pair Water and Fire
print(f"Result: {result}")
await game.close() # Close InfiniteCraft Session
asyncio.run(main())
```
You can find more examples in the **[documentation](#documentation-)**.
# Documentation 📚
Documentation is *coming soon*.
While the documentation is not ready, everything is documented well in the code with docstrings which you can see in an IDE like Visual Studio Code.
*You can also see the in-development documentation page [here](https://sqdnoises.gitbook.io/infinite-craft).*
# How does it work?
This library contacts the URL:
> https://neal.fun/api/infinite-craft/pair?first=element+name&second=element+name
where `element+name` in `first=` parameter is the first element you want to pair and the `element+name` in `second=` parameter is the second element.
Everything is handled in a user-friendly manner and asynchronously, so it should be really easy to use it in your programs.
# To-do
- [x] ~~Release version 1.0.0 on PyPI~~
- [x] ~~Make a discord server for support~~ Join our community! https://discord.gg/FF2fSN2sJd
- [x] ~~Add a runnable and configurable CLI mock API server~~
- [x] ~~Make a documentation page~~
- [ ] Fix [403 Forbidden Error](https://github.com/sqdnoises/infinite-craft/issues/2)
- [ ] Add a synchronous class
- [ ] Finish documentation page
- [ ] Make a playable & interactive Infinite Craft CLI game
# License
[](LICENSE)\
Click **[MIT License](LICENSE)** to view the license that comes with this library.
---
### 🌟 Please [star the repo](https://github.com/sqdnoises/infinite-craft/stargazers) and show some love 💖