Skip to content

finleyjoel1/HeadPlugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

💎 HeadPlugin

GitHub stars GitHub forks GitHub issues License Spigot API Version

A straightforward Minecraft plugin for managing and obtaining player heads, compatible with Minecraft 1.21.5+ servers.

📖 Overview

HeadPlugin is a lightweight server-side plugin designed for Minecraft servers running version 1.21.5 or newer. It provides simple yet effective functionality to allow players to acquire custom player heads within the game. Whether for decorative purposes, in-game currency, or unique server mechanics, this plugin empowers server administrators and players with easy access to player heads.

✨ Features

  • Player Head Spawning: Easily generate the head of any specified player.
  • Command-Based Interaction: Utilize simple in-game commands for quick head retrieval.
  • Server Compatibility: Built against Spigot API 1.21.1-SNAPSHOT, ensuring broad compatibility with 1.21.5+ servers.
  • Lightweight: Designed to be efficient and have minimal impact on server performance.

🛠️ Tech Stack

Core Technologies:

  • Runtime: Java 17
  • Build Tool: Maven
  • Minecraft API: Spigot API (1.21.1-SNAPSHOT)

Java Maven Spigot API

🚀 Quick Start

This guide will walk you through setting up and running HeadPlugin on your Minecraft server.

Prerequisites

To compile and run this plugin, you need:

  • Java Development Kit (JDK): Version 17 or higher.
  • Apache Maven: For building the project.
  • A Running Minecraft Server: Compatible with Spigot/Paper 1.21.5+ (e.g., PaperMC, Purpur, Spigot).

Installation

  1. Clone the repository

    git clone https://github.com/finleyjoel1/HeadPlugin.git
    cd HeadPlugin
  2. Build the plugin Use Maven to compile the project and package it into a .jar file.

    mvn clean install

    This command will create a HeadPlugin-1.0.0.jar (or similar, depending on the version specified in pom.xml) in the target/ directory.

  3. Deploy to your Minecraft server

    • Copy the generated HeadPlugin-1.0.0.jar from the target/ folder into your Minecraft server's plugins/ directory.
    • Restart your Minecraft server.

Usage

After installing and restarting your server, the plugin will be active.

In-game Commands

Currently, the exact commands are not documented in the provided data. However, based on the plugin's purpose, it's highly probable it features a command like the following:

  • /<command>: A command to interact with the plugin, likely allowing players or administrators to obtain the head of a specified player.
    • Example (Inferred): /head <player_name>
      • Description: Gives you the head of <player_name>.
      • Permissions (Inferred): headplugin.head or headplugin.admin

Permissions

Permissions for controlling access to plugin commands would typically be handled through a permissions plugin (e.g., LuckPerms, PermissionsEx). The permission nodes are inferred.

  • headplugin.head: Allows a player to use the primary command to get heads.
  • headplugin.admin: Grants full administrative access to all plugin features (if any advanced features exist).

📁 Project Structure

HeadPlugin/
├── src/
│   ├── main/
│   │   ├── java/            # Main Java source files
│   │   │   └── com/
│   │   │       └── finleyjoel1/
│   │   │           └── HeadPlugin/ # Plugin's main package
│   │   │               └── HeadPlugin.java # Main plugin class (inferred)
│   │   └── resources/       # Plugin configuration files (plugin.yml, config.yml)
│   ├── test/                # Test source files (if any)
├── .gitignore               # Specifies intentionally untracked files to ignore
├── pom.xml                  # Maven Project Object Model configuration
└── README.md                # This README file

🔧 Development

Available Scripts

The primary script for development and building is handled by Maven:

Command Description
mvn clean install Cleans the project, compiles, and packages the plugin into a .jar file in the target/ directory.

Development Workflow

  1. Clone the repository.
  2. Import the Maven project into your IDE (e.g., IntelliJ IDEA, Eclipse).
  3. Make your desired code changes in src/main/java/.
  4. If adding commands or events, remember to update src/main/resources/plugin.yml accordingly.
  5. Run mvn clean install to build your updated .jar.
  6. Test the .jar on a local Minecraft server.

🤝 Contributing

We welcome contributions to HeadPlugin! If you have suggestions, bug reports, or want to contribute code, please feel free to:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Submit a pull request with a clear description of your changes.

🙏 Acknowledgments

  • SpigotMC Community: For providing the robust API that makes plugins like this possible.
  • Apache Maven: For a reliable build automation tool.

📞 Support & Contact


⭐ Star this repo if you find it helpful!

Made with ❤️ by finleyjoel1

About

a head plugin for 1.21.5+

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages