Cleaned up README.md
Configuration section now links to config file from GH tree.
This commit is contained in:
parent
9b3872c8ac
commit
90b2a117b4
1 changed files with 10 additions and 17 deletions
27
README.md
27
README.md
|
|
@ -3,32 +3,25 @@
|
||||||
<img alt="image" align="center" src="https://github.com/user-attachments/assets/06b7c885-e11d-415c-b45c-bea51f7e2cb7" />
|
<img alt="image" align="center" src="https://github.com/user-attachments/assets/06b7c885-e11d-415c-b45c-bea51f7e2cb7" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
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.
|
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.
|
- **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.
|
- **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.
|
- **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.
|
- **Ender Chest support:** Items on Ender Chests are counted in the user balance.
|
||||||
- **Built-int optional balance and pay commands** with support for permissions.
|
- **Built-int optional balance and pay commands** with support for permissions.
|
||||||
|
- **Translation support** with per-user language and per-language currency name.
|
||||||
|
|
||||||
## Configuration Example:
|
## Configuration
|
||||||
```yaml
|
An updated example configuration file is available [here](https://github.com/adrianvic/ItemEconomy/blob/main/src/main/resources/config.yml).
|
||||||
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:
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
- Players can earn, trade, and store the configured item as physical currency.
|
- 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.
|
- Administrators can customize the item and formatting to match their server's theme.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue