Recipe Book Access API: Unlock Crafting Potential

Recipe Book Access API

Minecraft's recipe book is a powerful tool, but it has always been limited to the player's own inventory. What if your crafting table could pull materials from nearby chests, or your modded machines could access storage networks? The Recipe Book Access API changes the game by providing a clean, developer-friendly way to extend this functionality. This isn't a standalone mod that changes your gameplay directly; instead, it is a foundational library that other mods can use to create incredible new crafting experiences.

What Does the Recipe Book Access API Do?

At its core, this API solves a fundamental problem: the vanilla recipe book only checks and fills from the player's inventory. The Recipe Book Access API redirects that logic to check and fill from a customizable list of inventories. This means a modded crafting table can use items from any source you define, from a simple adjacent chest to a complex logistics network. The original description highlights a perfect example: a modded crafting table using all inventories from nearby chests to auto-fill recipes.

For players, this translates to less tedious inventory management and more time building. For mod developers, it offers a simple interface to integrate this functionality into their own creations. If you are looking for a mod that implements this for the standard crafting table, you should check out the "Nearby Crafting" mod, which uses this API.

Key Features and Technical Overview

The API is designed for simplicity and efficiency. It provides a single, straightforward interface called RecipeBookInventoryProvider, located in com.jomlom.recipebookaccess.api. To use it, you only need to implement this interface on your screen handler class and override one method: getInventoriesForAutofill().

Here is a quick look at the core concept:

• Simple Interface: Implement RecipeBookInventoryProvider on your screen handler.
• One Method to Override: Return a list of inventories you want the recipe book to access.
• Server-Side Logic: The method is called on the server side, and the API handles client synchronization automatically.
• No Player Inventory by Default: The returned list does not include the player's inventory unless you add it yourself.

Code Example for Developers

Integrating the API is remarkably straightforward. Here is a basic example of how you would implement it in your own mod:

import com.jomlom.recipebookaccess.api.RecipeBookInventoryProvider

public class YourCraftingScreenHandler extends AbstractRecipeScreenHandler implements RecipeBookInventoryProvider {
    // your existing code...

    @Override
    public List<Inventory> getInventoriesForAutofill() {
        return yourInventoriesList;
    }
}

The API makes a few assumptions to work correctly. Your screen handler class must extend AbstractRecipeScreenHandler (or a subclass), and your corresponding screen should extend RecipeBookScreen to utilize the vanilla recipe book UI. These are standard practices for most crafting mods.

Supported Versions and Loaders

Currently, the Recipe Book Access API for Minecraft is built for the Fabric mod loader. The developer has stated plans to explore support for NeoForge in the future, so keep an eye on the project's repository for updates. The API is typically updated for recent stable Minecraft versions, so be sure to check the files page for the version that matches your modding environment. You can easily download Recipe Book Access API from its official Modrinth or GitHub pages, where you will find builds for the latest supported game versions. If you are using a launcher that supports direct mod downloads, the process is even smoother. For example, the foxygame.net launcher has a built-in add-on catalog that lets you search for and install the Recipe Book Access API directly, saving you from manual downloads and ensuring you get a version compatible with your game setup.

Frequently Asked Questions

The developer has provided answers to some common questions, which are helpful for both players and modders.

I Think I Found an Issue

Feel free to create an issue on the project's GitHub repository or reach out directly via email at contact@jontyali.com. The developer is responsive and open to feedback.

Will You Release Support for Other Loaders?

As mentioned, NeoForge support is planned. If you have requests for specific versions or other mod loaders, you are encouraged to reach out. The developer is open to exploring new platforms. If you are using the foxygame.net launcher, its auto-update feature will notify you when a new version of the Recipe Book Access API is available, so you never miss a compatibility patch.

Does My Implementation Need to Work from the Client?

No. The getInventoriesForAutofill() method is only used from the server-side screen handler. The API will automatically keep the client up to date on the results for you, which simplifies the development process and prevents synchronization issues.

How to Install the Recipe Book Access API

Installing this library is as simple as installing any other Fabric mod. Here is a quick guide on how to install it:

1. Ensure you have the Fabric Loader and Fabric API installed for your Minecraft version.
2. Download the Recipe Book Access API JAR file from its Modrinth or GitHub releases page.
3. Place the downloaded JAR file into your mods folder.
4. Launch the game. The API itself will not add any visible features, but it will be available for other mods to use.

If you are using a launcher like foxygame.net, you can skip the manual file management entirely. The launcher's one-click install feature handles the entire process for you, automatically placing the Recipe Book Access API in the correct directory and verifying version compatibility with your installed mods.

Conclusion

The Recipe Book Access API is a brilliant piece of foundational code that opens up new possibilities for crafting in Minecraft. By allowing external inventories to be used with the recipe book, it empowers mod developers to create more immersive and convenient gameplay mechanics. Whether you are a developer looking to enhance your mod or a player curious about the future of crafting, this API is a significant step forward. Its simple design, clear documentation, and active development make it a valuable addition to the Fabric ecosystem. Download it today and see what your crafting can become.