Installation Guide

Follow these steps to install CryptocurrencyMC on your Minecraft server.

Prerequisites

Server Requirements

Requirement	Version/Details
Minecraft Server	Paper or Spigot 1.21+
Java	Java 21 or higher
Memory	At least 1GB RAM allocated
Internet Connection	Required for API access

Required Dependencies

⚠️ Important: CryptocurrencyMC requires Vault and an economy plugin to function. The plugin will not load without these dependencies.

1. Vault

Download Vault from SpigotMC:

Vault on SpigotMC
Place Vault.jar in your plugins/ folder

2. Economy Plugin

Choose one of these popular economy plugins:

EssentialsX: Download (Recommended)
CMI: Premium plugin with advanced features
GringottsEconomy: Alternative economy system

Optional Dependencies

PlaceholderAPI (Optional)

For placeholder support in other plugins:

PlaceholderAPI on SpigotMC
After installing, use /papi ecloud download Cryptocurrency to enable placeholders

Installation Steps

Step 1: Download the Plugin

Download the latest Cryptocurrency-1.0-SNAPSHOT.jar from the releases page
Or build from source using Maven: mvn clean package

Step 2: Install Dependencies

Download and install Vault
Download and install an economy plugin (e.g., EssentialsX)
(Optional) Download and install PlaceholderAPI

Step 3: Upload to Server

Stop your Minecraft server
Place all plugin JAR files in the plugins/ folder
Ensure your file structure looks like this:

server/
├── plugins/
│   ├── Vault.jar
│   ├── EssentialsX.jar
│   ├── PlaceholderAPI.jar (optional)
│   └── Cryptocurrency-1.0-SNAPSHOT.jar
├── world/
└── server.jar

Step 4: Start the Server

Start your Minecraft server
Watch the console for any errors during plugin loading
Look for the message: [Cryptocurrency] Plugin enabled successfully!

💡 First Run: On first startup, the plugin will create a default configuration file at plugins/Cryptocurrency/config.yml and a wallet storage file at plugins/Cryptocurrency/wallets.yml.

Step 5: Verify Installation

Join your server and run these commands to verify everything works:

/crypto price BTC
/crypto market
/crypto balance

✅ Success! If you can see cryptocurrency prices, the plugin is working correctly.

Building from Source

If you want to build the plugin from source code:

Prerequisites

Git installed on your system
Maven 3.6+ installed
Java Development Kit (JDK) 21+

Build Instructions

Clone the repository:

git clone https://github.com/MatisseAD/CryptocurrencyMC.git
cd CryptocurrencyMC

Build with Maven:

mvn clean package

Find the compiled JAR:

target/cryptocurrency-1.0-SNAPSHOT.jar

Copy the JAR to your server's plugins/ folder

Troubleshooting

Plugin Won't Load

Symptoms: Plugin appears red in /plugins or doesn't load at all.

Solutions:

Check console for error messages
Verify you have Vault and an economy plugin installed
Ensure you're running Java 21 or higher: java -version
Verify your server version is Paper/Spigot 1.21+

Price Fetching Fails

Symptoms: Commands show "Failed to fetch price" errors.

Solutions:

Check your server's internet connection
Verify CoinGecko API is accessible: try visiting https://api.coingecko.com/api/v3/ping
Check if your firewall is blocking outbound HTTPS requests
Wait a few minutes - the circuit breaker may have temporarily disabled API calls due to errors
Use /crypto api status to check API health

Vault Not Found

Symptoms: Error message about Vault not being found.

Solutions:

Install Vault plugin
Install an economy plugin (EssentialsX recommended)
Restart the server after installing both plugins
Verify Vault is loaded before Cryptocurrency (check plugin load order)

Wallets Not Persisting

Symptoms: Player balances reset after server restart.

Solutions:

Check that plugins/Cryptocurrency/wallets.yml exists and is writable
Verify the server has write permissions in the plugins/ directory
Look for errors in the console during server shutdown
Make sure the server is properly stopped (not killed forcefully)

Permission Errors

Symptoms: Players can't use commands despite having permission.

Solutions:

Check your permission plugin configuration
Verify permissions are granted: /lp user [player] permission check crypto.user.trade
See the Permissions page for a full list of permission nodes
Note that some commands default to op only (admin commands)

Updating the Plugin

Update Procedure

Backup Your Data: Copy plugins/Cryptocurrency/ to a safe location
Stop the Server: Gracefully shut down your server
Replace the JAR: Delete the old plugin JAR and add the new one
Start the Server: Start your server and check for any config changes
Check Config: Review config.yml for any new options
Reload: Use /crypto reload if needed

⚠️ Config Changes: New versions may add new configuration options. Always check the config file after updating to take advantage of new features.

Next Steps

Now that you have the plugin installed, here's what to do next:

📝 Configure the plugin to match your server's needs
🔑 Set up permissions for your players
📖 Learn the commands to manage the economy
❓ Check the FAQ for common questions