From 90b2a117b46a7b0cb27787e36eb77c6a9d6088fb Mon Sep 17 00:00:00 2001
From: Tenkuma <85490958+adrianvic@users.noreply.github.com>
Date: Sun, 4 Jan 2026 00:21:24 -0300
Subject: [PATCH 1/2] Cleaned up README.md
Configuration section now links to config file from GH tree.
---
README.md | 27 ++++++++++-----------------
1 file changed, 10 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 23e865b..1448468 100644
--- a/README.md
+++ b/README.md
@@ -3,32 +3,25 @@
-ItemEconomy II is a fork of [ItemEconomy](https://modrinth.com/plugin/itemeconomy), keeping it updated to later versions of Minecraft and adding new features.
+**ItemEconomy II** is a fork of [ItemEconomy](https://modrinth.com/plugin/itemeconomy), keeping it updated to later versions of Minecraft and adding new features.
This PaperMC plugin integrates with VaultUnlocked to provide a unique, item-based economy system for your Minecraft server. Instead of relying solely on virtual balances, players use in-game items as physical currency, adding a layer of immersion and realism to your economy.
-Features:
-- **Item-Based Currency:** Set any Minecraft item as your server's currency (default: diamonds).
+ItemEconomy is as powerful as you need and as simple as you want, with every feature being optional.
+
+## Features
+- **Item-Based Currency:** Set any Minecraft item as your server's currency (diamonds by default).
- **VaultUnlocked Integration:** Fully compatible with VaultUnlocked, enabling seamless interaction with other economy-based plugins.
- **Simple logic:** Just checks if the user has the item/how many when queried.
- **Customizable Formatting:** Define how your currency is displayed, including singular and plural forms.
- **Ender Chest support:** Items on Ender Chests are counted in the user balance.
- **Built-int optional balance and pay commands** with support for permissions.
+- **Translation support** with per-user language and per-language currency name.
-## Configuration Example:
-```yaml
-item: diamond # Define the item to be used as currency.
-singular: diamond # Singular form of the currency.
-plural: diamonds # Plural form of the currency.
-format: "{} $" # {} will be replaced with the amount and $ either with singular or plural
-ender_chest: balance # Either none or balance
-commands: true # Disabling this will disable /balance and /pay
-```
-
-This configuration will use diamonds as the currency, displayed as {amount} {name}, e.g., "5 diamonds" or "1 diamond".
-
-## Usage:
+## Configuration
+An updated example configuration file is available [here](https://github.com/adrianvic/ItemEconomy/blob/main/src/main/resources/config.yml).
+## Usage
- Players can earn, trade, and store the configured item as physical currency.
-- Integrates seamlessly with Vault-compatible plugins for shops, auctions, and more.
+- Once they spend the currency, that amount of the item will be subtracted from their inventory.
- Administrators can customize the item and formatting to match their server's theme.
From 7e3edff269ce3e256735bec907b09ebe390d1788 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=A4=A9=E3=82=AF=E3=83=9E?=
<85490958+adrianvic@users.noreply.github.com>
Date: Tue, 19 May 2026 19:26:12 -0300
Subject: [PATCH 2/2] Update README.md to include commands
Closes #1
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 1448468..0af72de 100644
--- a/README.md
+++ b/README.md
@@ -25,3 +25,13 @@ An updated example configuration file is available [here](https://github.com/adr
- Players can earn, trade, and store the configured item as physical currency.
- Once they spend the currency, that amount of the item will be subtracted from their inventory.
- Administrators can customize the item and formatting to match their server's theme.
+
+## Commands
+
+ - /balance
+ - Prints player balance, permission is `iteco.balance` but is allowed by default. Requires permission `iteco.balance.others` to specify other user.
+- /pay
+- Transfers money from your account to another player's, permission is `iteco.pay` but is allowed by default.
+- /itecoreload
+- Reloads the plugin configuration, requires permission `iteco.reload`.
+