# PhysicalMoney Installation Guide ## Requirements - Minecraft 1.21.11+ - Paper/Spigot/Purpur server - Java 17 or higher ## Plugin Installation 1. **Download the Plugin** - Build the plugin using Gradle: `./gradlew build` - Find the JAR file in `build/libs/` 2. **Install Plugin** - Copy `PhysicalMoney-1.0.0.jar` to your server's `plugins/` folder - Restart your server 3. **Configuration** - Edit `plugins/PhysicalMoney/config.yml` to customize settings - Edit `plugins/PhysicalMoney/messages.yml` to customize messages - Reload with `/reloadmoney` ## Resource Pack Installation ### Method 1: Server Resource Pack 1. **Prepare the Pack** - Create a ZIP file containing: - `pack.mcmeta` - `assets/minecraft/models/item/` folder with all money models - `assets/minecraft/textures/item/` folder with all money textures 2. **Host the Pack** - Upload to a file hosting service (Dropbox, Google Drive, etc.) - Get a direct download link 3. **Configure Server** - Edit `server.properties`: ```properties resource-pack= resource-pack-sha1= require-resource-pack=true ``` 4. **Restart Server** ### Method 2: Manual Installation (Client-Side) 1. **Create Resource Pack** - Copy all files from `src/main/resources/assets/` - Copy `pack.mcmeta` - Create a ZIP file 2. **Install on Client** - Open Minecraft - Go to Options > Resource Packs - Click "Open Pack Folder" - Copy the ZIP file there - Enable the pack in Minecraft ## CustomModelData Reference | Denomination | CustomModelData | Texture File | |-------------|-----------------|--------------| | $10 | 1000001 | money_10.png | | $50 | 1000002 | money_50.png | | $100 | 1000003 | money_100.png | | $500 | 1000004 | money_500.png | | $1000 | 1000005 | money_1000.png | | $5000 | 1000006 | money_5000.png | | $10000 | 1000007 | money_10000.png | ## Creating Custom Textures 1. **Texture Requirements** - Size: 16x16 or 32x32 pixels - Format: PNG with transparency - Style: Dollar bill design 2. **Texture Locations** - `assets/minecraft/textures/item/money_10.png` - `assets/minecraft/textures/item/money_50.png` - `assets/minecraft/textures/item/money_100.png` - `assets/minecraft/textures/item/money_500.png` - `assets/minecraft/textures/item/money_1000.png` - `assets/minecraft/textures/item/money_5000.png` - `assets/minecraft/textures/item/money_10000.png` 3. **Design Tips** - Use green tones for realism - Add denomination numbers clearly - Include "$" symbol - Add decorative borders - Use different colors for each denomination ## Commands Reference | Command | Permission | Description | |---------|-----------|-------------| | `/balance` | physicalmoney.balance | Check your balance | | `/withdraw ` | physicalmoney.withdraw | Withdraw money | | `/deposit` | physicalmoney.deposit | Deposit money | | `/pay ` | physicalmoney.pay | Pay another player | | `/bank` | physicalmoney.bank | Open bank GUI | | `/atm` | physicalmoney.atm | Open ATM GUI | | `/givemoney ` | physicalmoney.admin | Give money (admin) | | `/setmoney ` | physicalmoney.admin | Set balance (admin) | | `/removemoney ` | physicalmoney.admin | Remove money (admin) | | `/reloadmoney` | physicalmoney.admin | Reload config (admin) | ## Permissions ```yaml physicalmoney.admin # All admin commands physicalmoney.withdraw # Withdraw money physicalmoney.deposit # Deposit money physicalmoney.pay # Pay players physicalmoney.balance # Check balance physicalmoney.bank # Use bank physicalmoney.atm # Use ATM ``` ## Configuration Tips ### Adjust Denominations Edit `config.yml`: ```yaml currency: denominations: - 10 - 50 - 100 - 500 - 1000 - 5000 - 10000 ``` ### Enable/Disable Features ```yaml bank: enabled: true interest-rate: 5.0 interest-interval: 86400 death: drop-money: true drop-percent: 100.0 fees: transfer-fee-enabled: false withdraw-fee-enabled: false ``` ### Customize Limits ```yaml limits: wallet-max: 1000000 bank-max: 10000000 min-withdraw: 10 ``` ## Troubleshooting ### Money Items Not Showing Custom Textures - Verify resource pack is installed - Check CustomModelData values match - Ensure pack format is correct (34 for 1.21) ### Players Can't Withdraw - Check permissions - Verify balance is sufficient - Check minimum withdraw amount in config ### Interest Not Working - Ensure bank.enabled is true - Check interest-interval setting - Players must be online to receive interest ### Data Not Saving - Check file permissions on `data.yml` - Verify plugin has write access - Check server logs for errors ## Support For issues or questions: 1. Check configuration files 2. Review server logs 3. Verify permissions are set correctly 4. Ensure resource pack is properly installed