Skip to main content

​
Plugin Setup & Configuration ⚙️

Instructions for setting up and configuring Z-Craft server plugins.

​
Plugin Management

​
Installation

Step 1: Download Plugin
  • Get plugin JAR file
  • Verify version compatibility
  • Check for dependencies
Step 2: Install
  1. Stop server: /stop
  2. Place JAR in /plugins directory
  3. Restart server
  4. Verify load in console
Step 3: Configure
  1. Navigate to /plugins/PluginName/
  2. Edit config.yml
  3. Reload: /plugin reload PluginName
  4. Test functionality

​
Plugin Locations

Server Root
├── plugins/           (Main plugins folder)
│   ├── plugin1.jar
│   ├── plugin2.jar
│   └── PluginName/    (Plugin config folder)
│       ├── config.yml
│       ├── data.yml
│       └── logs/

​
Core Plugins

​
Economy Plugin

File: plugins/Z-Economy-1.0.jar Config Location: plugins/Z-Economy/config.yml Key Settings: 
# Starting currency for new players
starting-balance: 1000

# Interest rate (daily)
bank-interest: 0.005

# Transaction logging
log-transactions: true

# Shop commission percentage
shop-commission: 0.02
Commands: 
/economy reload     - Reload config
/economy backup     - Manual backup
/economy check      - Data integrity

​
Land Claim Plugin

File: plugins/Z-Claims-1.0.jar Config Location: plugins/Z-Claims/config.yml Key Settings: 
# Default claim size
default-claim-size: 100

# Expansion cost per block
expansion-cost: 1

# Max claims per player
max-claims: 5

# Enable griefing protection
griefing-protection: true

# Mob spawning in claims
allow-mob-spawn: false
Commands: 
/claims reload      - Reload config
/claims reset       - Reset all claims
/claims backup      - Backup data

​
Job System Plugin

File: plugins/Z-Jobs-1.0.jar Config Location: plugins/Z-Jobs/config.yml Key Settings: 
# Job payment rates
jobs:
  miner:
    ore-reward: 50
    level-multiplier: 1.1
  
  fisher:
    catch-reward: 25
    level-multiplier: 1.1

# Max job level
max-job-level: 10

# Experience requirements
level-exp-curve: 1000

​
Shop Plugin

File: plugins/Z-Shops-1.0.jar Config Location: plugins/Z-Shops/config.yml Key Settings: 
# Shop setup
shop-creation:
  cost: 500
  item-limit: 64

# Pricing
default-markup: 1.2
default-markdown: 0.8

# Transactions
log-all: true

​
Configuration Best Practices

​
YAML Format

# Comments start with #
key: value

# Nested keys
parent:
  child: value
  child2: value

# Lists
items:
  - item1
  - item2
  - item3

# Numbers & booleans
number: 42
boolean: true
decimal: 3.14

​
Config Organization

✅ Do:
  • Group related settings
  • Add comments
  • Use consistent formatting
  • Back up before editing
  • Test changes
❌ Don’t:
  • Edit while server running
  • Use tabs (use spaces)
  • Leave old settings
  • Forget to reload
  • Skip testing

​
Troubleshooting

​
Plugin Won’t Load

Check Console: 
[SEVERE] Error loading plugin...
Solutions:
  1. Verify Java version compatible
  2. Check plugin JAR name
  3. Ensure dependencies installed
  4. Review error message
  5. Check file permissions

​
Configuration Won’t Apply

Steps:
  1. Verify syntax is valid YAML
  2. Use /plugin reload PluginName
  3. Check for typos
  4. Verify permission level
  5. Restart if reload fails

​
Commands Not Working

Debug: 
/plugin reload PluginName
Check if command registered
Test with different player
Review permissions

​
Data Corruption

Recovery:
  1. Stop server
  2. Restore from backup
  3. Check plugin logs
  4. Report to developers

​
Performance Optimization

​
Plugin Load Order

Priority (in order):
  1. Database plugins
  2. Core plugins
  3. Feature plugins
  4. Optional plugins

​
Memory Management

Monitor: 
/mem                - Check memory
/gc                 - Garbage collection
/entities           - Entity count
Optimize:
  • Remove unused plugins
  • Adjust cache sizes
  • Tune database connections
  • Monitor heap usage

​
Backup & Recovery

​
Backup Locations

backups/
├── economy/         (Economy data)
├── claims/          (Land claims)
├── jobs/            (Job data)
└── shops/           (Shop inventory)

​
Manual Backup

/economy backup
/claims backup
/shops backup
/jobs backup

​
Automated Backups

Schedule via cron or plugin: 
0 3 * * * /server/backup.sh

​
Plugin Updates

​
Update Process

  1. Backup current version 
    cp plugins/Plugin.jar plugins/Plugin.jar.bak
  2. Download new version
    • Verify compatibility
    • Check changelog
  3. Stop server 
    /stop
  4. Replace JAR 
    cp NewPlugin.jar plugins/Plugin.jar
  5. Start and test
    • Check console for errors
    • Verify features work
    • Monitor performance

​
Version Management

Keep backup of previous versions: 
plugins/
├── Plugin-1.0.jar
├── Plugin-1.1.jar  (current)
└── Plugin-1.1.jar.bak

​
Development Setup

​
Plugin Development

Requirements:
  • Java JDK 11+
  • Spigot/Paper API
  • IDE (IntelliJ IDEA)
  • Maven or Gradle
Basic Structure: 
MyPlugin/
├── src/
│   └── com/zcraft/myplugin/
│       ├── MyPlugin.java
│       ├── listeners/
│       └── commands/
├── resources/
│   └── plugin.yml
└── pom.xml

​
Testing

  1. Compile: 
    mvn clean package
  2. Deploy: 
    cp target/MyPlugin-1.0.jar server/plugins/
  3. Test:
    • Join test server
    • Verify functionality
    • Check logs
    • Monitor performance

​
Configuration Examples

​
Full Economy Config

# Z-Economy Configuration
economy:
  # Starting balance
  starting-balance: 1000
  
  # Max balance cap
  max-balance: 9999999
  
  # Bank system
  bank:
    enabled: true
    interest: 0.005
    compound: daily

# Log all transactions
logging:
  enabled: true
  file: logs/economy.log

​
Full Claims Config

# Z-Claims Configuration
claims:
  # Default claim size
  default-size: 100
  
  # Expansion
  expansion:
    enabled: true
    cost-per-block: 1
  
  # Limits per rank
  limits:
    member: 1
    veteran: 3
    elite: 5
    legend: 10

​
Support & Resources

Need Help?
Plugin issues? Contact tech support 🔧