Configuration
The configuration file for Nexal Withdraw. Located at plugins/Nexal Withdraw/config.yml.
# ══════════════════════════════════════════════════════════
# NEXAL WITHDRAW CONFIG
# ══════════════════════════════════════════════════════════
# Most of these settings can also be changed in-game with /withdraw admin.
# ──────────────────────────────────────────────────────────
# GENERAL SETTINGS
# ──────────────────────────────────────────────────────────
# Enable logging of withdrawals and consumptions to console
enable-logging: true
# How numbers are shown in notes, messages, the admin menu and the logs, as a Java
# DecimalFormat pattern: , groups thousands, .00 gives two decimals
number-format: "#,##0.00"
# Leave out the decimals of whole amounts: 1,000 rather than 1,000.00 (but 1,000.50)
hide-zero-decimals: true
# ───────────────────────────────────────────────── ─────────
# DATA STORAGE
# ──────────────────────────────────────────────────────────
# Storage type: "json" (flat file) or "sql" (MySQL/MariaDB)
storage:
type: json
# SQL settings (only used when type is "sql")
sql:
host: localhost
port: 3306
database: minecraft
username: root
password: ""
# ──────────────────────────────────────────────────────────
# MODULES
# ──────────────────────────────────────────────────────────
# One section per currency type. Currency types added by other plugins through the API use
# the same keys under their own ID; a key they leave out uses the type's default.
#
# enabled false stops withdrawals; existing notes are kept and redeem once re-enabled
# price-format how an amount reads: %amount% is the number, %currency% the currency name
# tax charged on top of the amount; the note keeps the amount asked for
# item the note: %price%, %amount% and %player% (who withdrew it) work in name and lore
modules:
# Experience withdrawal module
exp:
enabled: true
price-format: "%amount% exp"
tax:
enabled: false
percentage: 10
item:
type: EXPERIENCE_BOTTLE
name: "<gradient:#9B59B6:#A569BD><bold>Bottled Experience</bold></gradient> <dark_gray>»</dark_gray> <gradient:#B983CE:#C99DDA>%price%</gradient>"
lore:
- "<gray>Experience poured into a bottle,</gray>"
- "<gray>ready to drink back at any time.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#B983CE:#C99DDA>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Bottled by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
# Money withdrawal module (requires Vault)
money:
enabled: true
price-format: "$%amount%"
tax:
enabled: false
percentage: 10
item:
type: PAPER
name: "<gradient:#9B59B6:#A569BD><bold>Bank Check</bold></gradient> <dark_gray>»</dark_gray> <gradient:#FFC107:#FFCD38>%price%</gradient>"
lore:
- "<gray>A signed check, payable to</gray>"
- "<gray>whoever holds it.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#FFC107:#FFCD38>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Signed by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
# Token withdrawal module (requires TokenManager)
tokens:
enabled: true
price-format: "%amount% tokens"
tax:
enabled: false
percentage: 10
item:
type: SUNFLOWER
name: "<gradient:#9B59B6:#A569BD><bold>Token Voucher</bold></gradient> <dark_gray>»</dark_gray> <gradient:#FFC107:#FFCD38>%price%</gradient>"
lore:
- "<gray>A voucher for tokens, redeemable</gray>"
- "<gray>by whoever holds it.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#FFC107:#FFCD38>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Issued by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
# Points withdrawal module (requires PlayerPoints)
points:
enabled: true
price-format: "%amount% points"
tax:
enabled: false
percentage: 10
item:
type: EMERALD
name: "<gradient:#9B59B6:#A569BD><bold>Points Voucher</bold></gradient> <dark_gray>»</dark_gray> <gradient:#2ECC71:#52D68A>%price%</gradient>"
lore:
- "<gray>A voucher for points, redeemable</gray>"
- "<gray>by whoever holds it.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#2ECC71:#52D68A>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Issued by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
# Vote points withdrawal module (requires VotingPlugin)
votes:
enabled: true
price-format: "%amount% vote points"
tax:
enabled: false
percentage: 10
item:
type: NETHER_STAR
name: "<gradient:#9B59B6:#A569BD><bold>Vote Note</bold></gradient> <dark_gray>»</dark_gray> <gradient:#5DADE2:#73B9E8>%price%</gradient>"
lore:
- "<gray>Vote points kept safe on paper,</gray>"
- "<gray>redeemable by whoever holds it.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#5DADE2:#73B9E8>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Issued by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
# Coins withdrawal module (requires CoinsEngine)
coins:
enabled: true
# The currency ID from CoinsEngine to use
currency-id: "coins"
price-format: "%amount% %currency%"
tax:
enabled: false
percentage: 10
item:
type: GOLD_INGOT
name: "<gradient:#9B59B6:#A569BD><bold>Coin Note</bold></gradient> <dark_gray>»</dark_gray> <gradient:#FFC107:#FFCD38>%price%</gradient>"
lore:
- "<gray>A note for coins, redeemable</gray>"
- "<gray>by whoever holds it.</gray>"
- ""
- "<gradient:#AAAAAA:#BBBBBB>● Value »</gradient> <gradient:#FFC107:#FFCD38>%price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>● Issued by »</gradient> <white>%player%</white>"
- ""
- "<gradient:#2ECC71:#52D68A>▶ Right Click</gradient> <gray>to redeem</gray>"
Configuration Options
Below is a reference of the main configuration sections:
enable-logging
══════════════════════════════════════════════════════════ NEXAL WITHDRAW CONFIG ══════════════════════════════════════════════════════════ Most of these settings can also be changed in-game with /withdraw admin.
────────────────────────────────────────────────────────── GENERAL SETTINGS ──────────────────────────────────────────────────────────
Enable logging of withdrawals and consumptions to console
number-format
How numbers are shown in notes, messages, the admin menu and the logs, as a Java DecimalFormat pattern: , groups thousands, .00 gives two decimals
hide-zero-decimals
Leave out the decimals of whole amounts: 1,000 rather than 1,000.00 (but 1,000.50)
storage
────────────────────────────────────────────────────────── DATA STORAGE ──────────────────────────────────────────────────────────
Storage type: "json" (flat file) or "sql" (MySQL/MariaDB)
modules
────────────────────────────────────────────────────────── MODULES ────────────────────────────────────────────────────────── One section per currency type. Currency types added by other plugins through the API use the same keys under their own ID; a key they leave out uses the type's default.
enabled false stops withdrawals; existing notes are kept and redeem once re-enabled price-format how an amount reads: %amount% is the number, %currency% the currency name tax charged on top of the amount; the note keeps the amount asked for item the note: %price%, %amount% and %player% (who withdrew it) work in name and lore