Skip to content

Commit

Permalink
docs: add icon and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SettingDust committed Nov 18, 2024
1 parent f7888ba commit db35d74
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 📦 Item Converter

This mod introduces powerful features to enhance inventory management and crafting efficiency.
It allows you to convert items in your inventory, perform ratio-based item conversions.

## 🔄 Data-Driven Item Conversion

- Press a key while selecting an item in your inventory to open a conversion GUI.
- The GUI shows item slots based on rules defined in data packs, allowing you to perform ratio-based item conversions.
- All conversion rules are fully data-driven and customizable, providing flexibility for pack developers and players alike.

## 🛠️ Auto Conversion with Middle-Click

- Target a block and middle-click to automatically search your inventory for the usable rules and convert the block directly.

## ⚙️ Data Pack Support

The mod relies on data packs for defining conversion rules, supporting two types of JSON files:

1. **`item_converter/rules`**: Defines the specific conversion rules, specifying input items, output items, and conversion ratios.
2. **`item_converter/rule_generator`**: Generates conversion rules based on existing recipes, simplifying the setup process.

### 📋 Command

Use the following command to auto-generate conversion rules from generator:
```
/item_converter generate [generator]
```
Binary file added icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added iconx64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit db35d74

Please sign in to comment.