Installation

This guide will walk you through installing and setting up the Custom Commands plugin on your Minecraft server.

Prerequisites

Before installing Custom Commands, ensure your server meets these requirements:

Server Requirements

Minecraft Version: 1.21 or higher
Server Software: Paper
Java Version: Java 17 or higher
Memory: At least 512MB RAM available for the plugin

Recommended Server Software

Paper (Recommended) - Best performance and compatibility
Spigot - Good performance with many plugins
Bukkit - Basic functionality, may have limited features

Download

Getting the Plugin

The Custom Commands plugin is available through our Discord server:

Join our Discord server
Navigate to the #downloads channel
Download the latest version of Custom Commands
Save the .jar file to your computer

File Information

File Name: CustomCommands-1.0.0.jar
File Size: ~50KB
Checksum: Available in Discord for verification

Installation Steps

Step 1: Stop Your Server

Before installing any plugin, always stop your server first:

# If using a control panel, use the stop button
# If using command line:
stop

Step 2: Upload the Plugin

Access your server files (via FTP, control panel, or direct access)
Navigate to the plugins folder
Upload the CustomCommands-1.0.0.jar file to this folder

Step 3: Start Your Server

Start your server and wait for it to fully load:

# If using a control panel, use the start button
# If using command line:
java -jar server.jar

Step 4: Verify Installation

Check the server console for these messages:

[CustomCommands] Plugin has been enabled successfully!
[CustomCommands] Custom command system initialized
[CustomCommands] Main commands registered: customcommands, cc

If you see these messages, the plugin has been installed successfully!

First-Time Setup

Automatic Configuration

On first startup, the plugin will automatically create:

plugins/CustomCommands/
├── config.yml          # Main configuration file
├── messages.yml         # Message configuration file
└── logs/               # Log directory
    └── latest.log      # Current log file

Initial Configuration

The plugin comes with example commands pre-configured:

/discord - Discord server information
/website - Website link
/rules - Server rules
/example - Example command with console execution

Test the Installation

Try these commands to verify everything works:

/customcommands help
/customcommands version
/discord
/website

Post-Installation

Reload Command

Use the reload command to apply configuration changes without restarting:

/customcommands reload

Check Logs

Monitor the logs for any issues:

plugins/CustomCommands/logs/latest.log

Configure Permissions

Set up permissions for your players:

# In your permissions plugin (LuckPerms, etc.)
customcommands.discord: true
customcommands.website: true
customcommands.rules: true

Troubleshooting

Common Issues

Plugin Won’t Load

Problem: Plugin doesn’t appear in /plugins list

Solutions:

Check server software compatibility (Paper/Spigot/Bukkit)
Verify Java version (Java 17+ required)
Check server console for error messages
Ensure the .jar file is in the correct plugins folder

Commands Not Working

Problem: Custom commands don’t respond

Solutions:

Check if the plugin is enabled: /plugins
Verify permissions are set correctly
Use /customcommands reload to reload configuration
Check console for error messages

Permission Errors

Problem: Players get “no permission” messages

Solutions:

Check permission nodes in your permissions plugin
Verify the permission format: customcommands.commandname
Ensure players have the correct permissions assigned

Getting Help

If you encounter issues not covered here:

Check the Logs - Look in plugins/CustomCommands/logs/latest.log
Join Discord - Get help from our community: Discord Server
Report Bugs - Use the bug report channel in Discord

Next Steps

Now that you have Custom Commands installed:

Read the Configuration Guide - Learn how to customize your commands
Check out Examples - See what’s possible with the plugin
Join our Discord - Get support and share your creations

title: Installation

Quick Reference

Essential Commands

/customcommands help     # Show help information
/customcommands reload   # Reload configuration
/customcommands version  # Show plugin version

File Locations

plugins/CustomCommands/config.yml    # Main configuration
plugins/CustomCommands/messages.yml  # Messages and prefix
plugins/CustomCommands/logs/         # Log files

Support

Discord: https://discord.gg/2qCMn6KHj4
Documentation: This documentation site

Need help? Join our Discord server for support and updates!