Create a Minecraft Spawn Plugin: Spigot Tutorial for Beginners

Creating custom plugins for Minecraft servers can significantly enhance the gameplay experience. This tutorial focuses on building a spawn plugin using Spigot, a popular Minecraft server API. This plugin will allow server administrators to set a specific spawn location that players can easily return to, improving server management and player navigation. Whether you're a beginner or have some experience with Java and Minecraft plugin development, this guide will walk you through the process step-by-step, ensuring you have a fully functional spawn plugin by the end.

Prerequisites

Before diving into the code, make sure you have the following prerequisites in place:

• Java Development Kit (JDK): Ensure you have a compatible version of the JDK installed (Java 8 or higher is recommended).
• Integrated Development Environment (IDE): Use an IDE like IntelliJ IDEA or Eclipse for writing and managing your code. IntelliJ IDEA is shown in this Tutorial .
• Spigot API: Download the Spigot API JAR file, which provides the necessary libraries for interacting with the Minecraft server.
• Maven or Gradle: A build automation tool like Maven or Gradle to manage dependencies and build your plugin.

Creating a New Spigot Plugin Project

To start, create a new project in your IDE. Using Maven is highly recommended as it simplifies dependency management. Here’s how you can set up a Maven project:

1. Create a Maven Project: In IntelliJ IDEA, go to File > New > Project. Select Maven from the options.

2. Configure Project Settings:

   • GroupId: me.yourname (e.g., me.kodysimpson)

     

   • ArtifactId: SpawnPlugin

   • Version: 1.0-SNAPSHOT

3. Add Spigot API Dependency: Add the Spigot API as a dependency in your pom.xml file. You’ll need to configure a system-scoped dependency since the Spigot API isn’t available in Maven’s central repository. Here’s the dependency block:

<dependency>
    <groupId>org.spigotmc</groupId>
    <artifactId>spigot-api</artifactId>
    <version>1.17.1-R0.1-SNAPSHOT</version>
    <scope>system</scope>
    <systemPath>${basedir}/lib/spigot-api-1.17.1-R0.1-SNAPSHOT.jar</systemPath>
</dependency>

Ensure you place the Spigot API JAR file in the lib directory within your project and adjust the systemPath accordingly.

4. Create Plugin Class: Create a new Java class that extends JavaPlugin. This class will serve as the main entry point for your plugin. The name of the Java class is SpawnPlugin .

Main Plugin Class: SpawnPlugin.java

This is where the plugin's core logic resides. The onEnable() method is called when the plugin is enabled, and the onDisable() method is called when the plugin is disabled. It's essential for setting up the plugin's components, like registering commands and listeners, and cleaning up resources when the server shuts down or the plugin is disabled.

package me.kodysimpson.spawnplugin;

import org.bukkit.plugin.java.JavaPlugin;

public final class SpawnPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        // Plugin startup logic
    }

    @Override
    public void onDisable() {
        // Plugin shutdown logic
    }
}

It's important to handle configuration files, listeners and commands in the main Plugin Class. The plugin manifest is also added here.

Creating the SetSpawn Command

To create the /setspawn command, you'll need to:

1. Create a Command Executor Class: Create a new class called SetSpawnCommand that implements CommandExecutor. This class will handle the logic for the /setspawn command.

package me.kodysimpson.spawnplugin.commands;

import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.Location;
import me.kodysimpson.spawnplugin.SpawnPlugin;

public class SetSpawnCommand implements CommandExecutor {

    private final SpawnPlugin plugin;

    public SetSpawnCommand(SpawnPlugin plugin) {
        this.plugin = plugin;
    }

    @Override
    public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
        if (sender instanceof Player) {
            Player player = (Player) sender;
            Location location = player.getLocation();

            // Set the spawn location in the config
            plugin.getConfig().set("spawn", location);
            plugin.saveConfig();

            player.sendMessage("Spawn location set!");
        } else {
            sender.sendMessage("You must be a player to use this command!");
        }
        return true;
    }
}

2. Register the Command: Register the SetSpawnCommand in your onEnable() method of the main plugin class (SpawnPlugin). The getCommand() method allows you to assign the logic you created to the proper command. This also allows you to specify the name of the command.

@Override
public void onEnable() {
    // Plugin startup logic
    getCommand("setspawn").setExecutor(new SetSpawnCommand(this));

    //config.yml
    getConfig().options().copyDefaults(true);
    saveDefaultConfig();
}

The plugin class is also passed to the SetSpawnCommand class to allow access to plugin resources.

Storing the Spawn Location in config.yml

To persist the spawn location, you'll store it in the config.yml file. This file allows you to save various plugin settings and retrieve them later.

1. Setting up config.yml: The first step is to set up the default setup by using the commands:
   • getConfig().options().copyDefaults(true);
   • saveDefaultConfig();
2. Setting the Coordinates: Use the getConfig().set() method to store the location. Make sure that the plugin knows what location you are wanting to pull from. This will be "spawn", which is passed into the location. Here's how:

// Set the spawn location in the config
plugin.getConfig().set("spawn", location);
plugin.saveConfig();

3. Saving the Config: After setting the location, save the configuration using saveConfig().

Implementing the Spawn Command

Now, let's implement the /spawn command. This command will teleport the player to the previously set spawn location.

1. Create a New Class: Create another class called SpawnCommand that implements CommandExecutor:

package me.kodysimpson.spawnplugin.commands;

import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.Location;
import me.kodysimpson.spawnplugin.SpawnPlugin;

public class SpawnCommand implements CommandExecutor {

    private final SpawnPlugin plugin;

    public SpawnCommand(SpawnPlugin plugin) {
        this.plugin = plugin;
    }

    @Override
    public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
        if (sender instanceof Player) {
            Player player = (Player) sender;

            // Get the spawn location from the config
            Location location = (Location) plugin.getConfig().get("spawn");

            if (location != null) {
                player.teleport(location);
                player.sendMessage("Teleported to spawn!");
            } else {
                player.sendMessage("Spawn location is not set!");
            }
        } else {
            sender.sendMessage("You must be a player to use this command!");
        }
        return true;
    }
}

2. Register the Command: Register the SpawnCommand in the onEnable() method of your main plugin class:

@Override
public void onEnable() {
    // Plugin startup logic
    getCommand("setspawn").setExecutor(new SetSpawnCommand(this));
    getCommand("spawn").setExecutor(new SpawnCommand(this));

    //config.yml
    getConfig().options().copyDefaults(true);
    saveDefaultConfig();
}

Teleporting Players on Respawn and First Join

To automatically teleport players to the spawn location when they respawn or join the server for the first time, you need to implement event listeners.

1. Create an Event Listener: Create a new class called SpawnListener that implements Listener:

package me.kodysimpson.spawnplugin.listeners;

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerRespawnEvent;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.Location;
import org.bukkit.entity.Player;
import me.kodysimpson.spawnplugin.SpawnPlugin;

public class SpawnListener implements Listener {

    private final SpawnPlugin plugin;

    public SpawnListener(SpawnPlugin plugin) {
        this.plugin = plugin;
    }

    @EventHandler
    public void onPlayerRespawn(PlayerRespawnEvent event) {
        Player player = event.getPlayer();
        Location location = (Location) plugin.getConfig().get("spawn");

        if (location != null) {
            player.teleport(location);
        }
    }

    @EventHandler
    public void onPlayerJoin(PlayerJoinEvent event){
        Player player = event.getPlayer();
        Location location = (Location) plugin.getConfig().get("spawn");

        if (location != null) {
            player.teleport(location);
        }
    }
}

2. Register the Listener: Register the SpawnListener in the onEnable() method of your main plugin class:

@Override
public void onEnable() {
    // Plugin startup logic
    getCommand("setspawn").setExecutor(new SetSpawnCommand(this));
    getCommand("spawn").setExecutor(new SpawnCommand(this));

    getServer().getPluginManager().registerEvents(new SpawnListener(this), this);

    //config.yml
    getConfig().options().copyDefaults(true);
    saveDefaultConfig();
}

This code registers two event handlers:

• onPlayerRespawn(): Teleports the player to the spawn location when they respawn.
• onPlayerJoin(): Teleports the player to the spawn location when they first join the server.

Setting the Spawn Point

To set the spawn point, use the command /setspawn while standing at the desired location. This command is restricted to players only, ensuring that the console cannot set the spawn point.

• /setspawn - Sets the spawn location to the player's current location.

Teleporting to the Spawn Point

To teleport to the set spawn point, use the command /spawn. This command is also restricted to players only.

• /spawn - Teleports the player to the set spawn location.