Spawn | FancySetSpawn

!FancySpawn banner

A simple spawn plugin for Spigot and Paper.

FancySetSpawn lets players set a server spawn and teleport back to it with /spawn. It also supports customizable sounds, messages, and action bar notifications.

Works with Spigot and Paper 1.8.8+.

Features

!settings !setspawn !spawn

• Set spawn with /setspawn
• Teleport to spawn with /spawn
• Custom sounds for teleporting, setting the spawn, and joining
• Chat or action bar messages
• In-game configuration through /fancyspawn
• Configurable sounds, volume, pitch, and messages
• Reload configuration without restarting the server
• API for other plugins, available since version 1.2

Commands

Permissions

Installation

1. Download the latest FancySpawn .jar.
2. Put it into your server's plugins folder.
3. Start or restart the server.
4. Configure the plugin in plugins/FancySetSpawn/config.yml, or use /fancyspawn.

The spawn location is stored in:

plugins/FancySetSpawn/spawnconfig.yml

Configuration

FancySpawn supports both chat and action bar messages.

Set messageLocation to either chat or actionbar.

Sounds can be disabled by setting them to off or leaving them empty.

messages:
  messageLocation: actionbar
  spawnSet: "&aSpawn has been set to your current location!"
  teleportToSpawn: "&aYou have been teleported to spawn!"
  spawnNotSet: "&cSpawn position is not set."
  commandOnlyPlayer: "&cThis command can only be used by a player."
  reloaded: "&aConfiguration reloaded."
  reloadFailed: "&cCould not reload the configuration. Check the console."
  valueSet: "&a{key} set to &f{value}&a."
  soundDisabled: "&aSound &f{key} &ahas been disabled."
  saveFailed: "&cCould not save the configuration."

sounds:
  teleport: "minecraft:entity.experience_orb.pickup"
  setSpawn: "minecraft:entity.experience_orb.pickup"
  playerJoin: "minecraft:entity.player.levelup"

soundSettings:
  volume: 1.0
  pitch: 1.0

After changing the configuration manually, use:

/fancyspawn reload

API

FancySpawn provides an API for other plugins starting with version 1.2.

The API allows other plugins to access the saved spawn and teleport players to it.

Add FancySpawn as a dependency in your plugin.yml:

depend: [FancySetSpawn]

The plugin name is FancySetSpawn.

Available methods

import org.bukkit.entity.Player;
import org.patekcz.setSpawn.FancySpawnAPI;
import org.patekcz.setSpawn.SetSpawn;

public void teleportToSpawn(Player player) {
    SetSpawn plugin = (SetSpawn) getServer()
            .getPluginManager()
            .getPlugin("FancySetSpawn");

    if (plugin == null || !plugin.isEnabled()) {
        return;
    }

    FancySpawnAPI api = plugin.getAPI();
    api.teleportPlayerToSpawn(player);
}

☕ Support me on Ko-fi

Built with ❤️ by patek_cz